Skip to content

Jswope00/educator hanbook reorg - #1262

Merged
sarina merged 6 commits into
openedx:mainfrom
jswope00:jswope00/educator_hanbook_reorg
Sep 11, 2025
Merged

sarina merged 6 commits into
openedx:mainfrom
jswope00:jswope00/educator_hanbook_reorg

Conversation

@jswope00

Copy link
Copy Markdown
Contributor

Two commits here:

Rework the home page
One reworks the home page. Added Core Contributor Handbook. Eliminated several redundancies with roles. Most concepts, how-to's etc were showing up twice via the User Role dropdown and as their own TOC entry:
image

image

In the case of translators, had to move concepts and how-tos index pages to the appropriate Translators home page, since those were only on the main home page. They belong on Translators home page.

Merge redundant Getting Help Pages
We had two getting help pages. One was older and had some dead links and outdated information. Merged into one page and made sure internal docs point to that page.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Aug 14, 2025
@openedx-webhooks

Copy link
Copy Markdown

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.

Details
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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Aug 14, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Aug 14, 2025
@sarina

sarina commented Aug 15, 2025

Copy link
Copy Markdown
Contributor

Acknowledging review request, I have some PTO next week but I'll get to this the week after next.

@cassiezamparini

Copy link
Copy Markdown
Contributor

@jswope00 Awesome! Thank you! Reviewed and approved on my end.

cc. @mphilbrick211

@mphilbrick211

Copy link
Copy Markdown

all set!

@jswope00

Copy link
Copy Markdown
Contributor Author

This is a screenshot of the main changes to the homepage where Handbook and Release guides are now added below the existing Role guides. And the left sidebar mimics the structure of the homepage:

image

@cassiezamparini

cassiezamparini commented Aug 26, 2025 •

Copy link
Copy Markdown
Contributor

Thanks @jswope00. Exciting! I appreciate the screenshot. We'll just wait on Sarina's review.

Looking forward to populating the content!

@cassiezamparini

Copy link
Copy Markdown
Contributor

@sarina Any way you could possibly review this this week or next? 😄

@sarina sarina left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can we get in the habit of setting up redirects when we delete a file? source/site_ops/install_configure_run_guide/front_matter/getting_help.rst was deleted.

@sarina sarina moved this from Ready for Review to Waiting on Author in Contributions Sep 10, 2025
@sarina

sarina commented Sep 10, 2025

Copy link
Copy Markdown
Contributor

@jswope00
jswope00 requested a review from sarina September 11, 2025 01:45
@sarina
sarina merged commit 097d6a8 into openedx:main Sep 11, 2025
2 checks passed
@github-project-automation github-project-automation Bot moved this from Waiting on Author to Done in Contributions Sep 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants