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

DRAFT: docs: Initial Migration Attempt from Legacy OLX docs. Still Erroring #552

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

Conversation

jswope00
Copy link
Contributor

A draft pull request to determine what errors are thrown in the build process on Github. It is not ready for a merge yet.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 21, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @jswope00!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @feanil. Tag them in a comment and let them know that your changes are ready for review.

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.

@sarina
Copy link
Contributor

sarina commented Sep 5, 2024

ha, I spent too long not looking at this and now the build is passed... ?!?!? .... do you want a review?

@jswope00
Copy link
Contributor Author

jswope00 commented Sep 5, 2024

@sarina Yes, I've been able to fix all the build errors. Just a general check of whether this migration of OLX from legacy to the new Open edX docs and placed in the sidebar works for you.
And if so, do you prefer to merge, or should I merge my own passing PRs?

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 assume this is just a direct port, but one could imagine doing a find/replace "edX" -> "Open edX".

There might be a way of injecting a mini banner atop each of these pages with some warning like, "the contennt of these pages may be out of date" and even a request for help. Food for thought. Happy to play around with it once this is merged.

@@ -185,3 +185,4 @@ Open edX Documentation
other/feedback
other/getting_help
Documentation Decisions <documentors/decisions/index>
olx/index
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm fine with this placement, but I think another place more discoverable to educators would be Educators > References

@sarina
Copy link
Contributor

sarina commented Sep 5, 2024

Merge when you're satisfied with your work & have addressed the conflict

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants