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

docs: adjusting for cleanup reference docs #625

Merged
merged 9 commits into from
Dec 5, 2024

Conversation

jesgreco
Copy link
Contributor

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

Thanks for the pull request, @jesgreco!

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 @openedx/docs-openedx-org-maintainers. 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.

Copy link
Contributor

@jswope00 jswope00 left a comment

Choose a reason for hiding this comment

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

Let me know what the two empty tables are for.

@jswope00
Copy link
Contributor

@jesgreco This is happening because when you change a reference to an external link, you've got to update the corresponding links.txt (or links.rst, I forget if it could be both) or else you will get build errors.

And it isn't as simple as just changing something like partners.edx.org to partners.openedx.org. In almost all cases, Open edX won't have corresponding links for things that exist on edx.org.

So you've got to make a determination if we can replace the link with something that has similar purpose for Open edX. If not, then you've got to decide how you can remove the reference.

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.

This PR contains changes from #615. Pull requests should only contain one set of changes. I will review this when this doesn't contain the style guide.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 2, 2024
@angonz angonz force-pushed the jesgreco/cleanup_references branch 6 times, most recently from 3599068 to 7745559 Compare December 3, 2024 14:22
fixing cleanup ref for resources_for_course_teams
fixing external links
cleaning up for enrollment_requirements.rst and message_text.rst
cleaning up for scheduling_course.rst
cleaning up for resources_for_open_edx.rst
docs: cleanup for course_pacing.rst
docs: adjusting error tables
docs: cleanup for resources_for_course_teams
docs: cleanup for roles_for_viewing.rst
docs: cleanup for gradebook_assignment_types.rst
docs: adjusting reference docs
learner_view_of_grades doc being cleaned up.
@angonz angonz force-pushed the jesgreco/cleanup_references branch from 7745559 to 27a0761 Compare December 3, 2024 14:31
@jesgreco
Copy link
Contributor Author

jesgreco commented Dec 4, 2024

I've just reviewed this PR and it ok to be merged. @sarina let me know if you are ok :)

Copy link
Contributor Author

@jesgreco jesgreco left a comment

Choose a reason for hiding this comment

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

@sarina I've just finished with all your comments!

source/educators/references/resources_for_open_edx.rst Outdated Show resolved Hide resolved
@jesgreco
Copy link
Contributor Author

jesgreco commented Dec 5, 2024

@sarina all changes are done!

@sarina sarina merged commit 8a803d2 into openedx:main Dec 5, 2024
2 checks passed
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
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants