Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(FC-68) Jswope00/reorg educator other #839

Open
wants to merge 84 commits into
base: main
Choose a base branch
from

Conversation

jswope00
Copy link
Contributor

FC-0068: Reorganize Other docs after migration

Was able to move "Other" items into more appropriate sections like the Learner persona and eliminate the Other category

@jswope00 jswope00 requested a review from sarina February 19, 2025 20:41
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 19, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 19, 2025

Thanks for the pull request, @jswope00!

This repository is currently maintained by @openedx/docs-openedx-org-maintainers.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@jswope00 jswope00 marked this pull request as ready for review February 19, 2025 20:41
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 19, 2025
Copy link
Contributor

@sarina sarina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did some spot checking - clicked through all the changed navigation page and into various pages. Only found a few things to comment on!

For information about best practices for moderating discussions, see
:ref:`Guidance for Discussion Moderators`. If you are using `divided discussions <https://docs.openedx.org/en/latest/educators/concepts/communication/about_divided_discussions.html#about-divided-discussions>`_, see :ref:`Managing Divided Discussion
Topics`.
If you are using `divided discussions <https://docs.openedx.org/en/latest/educators/concepts/communication/about_divided_discussions.html#about-divided-discussions>`_, see :ref:`Guide to Managing Divided Discussions`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the docs.openedx.org link should be a ref


What is the Course Dashboard?
About the Course Dashboard?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
About the Course Dashboard?
About the Course Dashboard

@@ -28,7 +27,7 @@ these options for getting an answer.
general information about how the course works and what you can expect, and
also what they expect from you, in the first section in the course.

* Participate in the :ref:`course discussions <Discussions>`. Other learners
* Participate in the :ref:`course discussions <About Course Discussions>`. Other learners
might be able to answer your question, or might have the same question
themselves. If you encounter an unfamiliar word, phrase, or abbreviation,
such as "finger exercise" or "board work", search for it on the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at L37 in this file I'd change the ref because it looks like this:

image

@@ -152,18 +152,18 @@ This section describes the various exercises, tools, and problem types that you
/educators/references/course_development/exercise_tools/ORA_Staff_Grading.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the beginning of the file I'd change "This guide is intended for those interested in using OLX (open learning XML) to develop edX courses. Readers of this guide should be familiar with XML." to "develop Open edX courses"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

4 participants