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

Jswope00/migrate olx docs #819

Merged
merged 11 commits into from
Feb 13, 2025
Merged

Conversation

jswope00
Copy link
Contributor

@jswope00 jswope00 commented Feb 7, 2025

Migrate the OLX docs from ReadtheDocs into docs.openedx.org.

This pull will consist of several commits for the different stages of migration

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 7, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 7, 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 requested a review from sarina February 7, 2025 00:41
@sarina
Copy link
Contributor

sarina commented Feb 10, 2025

@jswope00 - is there a corresponding PR to remove redirect the docs from the old site?

@sarina sarina marked this pull request as ready for review February 10, 2025 17:14
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 added corrections to the README since that's not under the "Migrate me" section. Looks good to go for a first migration pass.

https://github.com/openedx/edx-documentation/tree/master/en_us/olx/source

The edX documentation team welcomes contributions from Open edX community
members. You can find guidelines for how to `contribute to edX Documentation`_
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we make this a reference to https://github.com/openedx/docs.openedx.org/edit/main/source/documentors/references/doc_guidelines.rst ? (It doesn't have a ref tag on it currently)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, added a ref tag and pointed to that ref tag in this commit: jswope00@15ae716

@@ -49,7 +49,7 @@ also enables Google Drive files.
...
</course>

For more information, see `OLX Course Building Blocks`_ in the
For more information, see :ref:`OLX Course Building Blocks` in the
*EdX Open Learning XML Guide*.
Copy link
Contributor

Choose a reason for hiding this comment

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

Could probably do a find-replace for this to "Open edX Open Learning"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@sarina yes, done now in this commit: a6d1905

@sarina
Copy link
Contributor

sarina commented Feb 12, 2025

@jswope00 if you can address my comments and merge this, I'll update the old docs site to point at the new location ✅

@jswope00
Copy link
Contributor Author

@sarina This is now ready for final review and merge when approved. Two outstanding improvements are tracked with issues:
#825
#826

@sarina sarina enabled auto-merge (rebase) February 13, 2025 15:35
auto-merge was automatically disabled February 13, 2025 15:39

Rebase failed

@sarina sarina merged commit 5e546e4 into openedx:main Feb 13, 2025
2 checks passed
@jswope00 jswope00 linked an issue Mar 1, 2025 that may be closed by this pull request
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: Done
Development

Successfully merging this pull request may close these issues.

Migrate OLx Documentation to docs.openedx.org
3 participants