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-0068 docs: how-to cleaning by edunext #18 #767

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

Conversation

BryanttV
Copy link
Contributor

@BryanttV BryanttV commented Jan 13, 2025

This PR modifies a series of how-to documents migrated from the legacy repositories to the educators' documentation.

The updated files were:

  • create_problem_in_latex.rst
  • create_problem_with_hint.rst
  • create_protein_builder.rst
  • allow_opt_out_proctored_exam.rst
  • create_proctored_exam_pt.rst
  • create_proctored_exam_rpnow.rst
  • enable_proctored_exams.rst
  • manage_proctored_exams.rst
  • review_pt_results.rst
  • review_rpnow_results.rst

@openedx-webhooks
Copy link

openedx-webhooks commented Jan 13, 2025

Thanks for the pull request, @BryanttV!

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 13, 2025
@BryanttV BryanttV force-pushed the bav/educators_documentation_review_edunext_20 branch from f72eb60 to 629b7d7 Compare January 13, 2025 16:59
@BryanttV BryanttV marked this pull request as ready for review January 13, 2025 17:02
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jan 13, 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.

Looks good to me. One correction, plus there are conflicts in this PR to resolve.

Could you please file a Docs ticket to review all the Proctoring docs? I'm not sure they work for Open edX.

* Nudge learners who have not yet completed Onboarding a week before the first proctored exam.
* Add in-course messaging that completing Onboarding early is important, and
that access to Onboarding requires to be in a paid track (e.g. Verified or
Master's).
Copy link
Contributor

Choose a reason for hiding this comment

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

I would remove the part of the sentence after "and" (the paid track part refers to an edx.org-specific thing)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done: 2b4c1be

@BryanttV BryanttV force-pushed the bav/educators_documentation_review_edunext_20 branch from 629b7d7 to 2b4c1be Compare January 14, 2025 15:29
@BryanttV
Copy link
Contributor Author

Thanks, @sarina. I resolved the conflicts. The PR is ready to merge.
I created a new issue for the proctored exams: #774

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