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

adding see also tables #709

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

Conversation

jesgreco
Copy link
Contributor

adding see also table for roles_for_viewing.rst

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 23, 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.

@jswope00
Copy link
Contributor

@jesgreco can you also add /references/testing_course_content.rst to the See Also section?

The rule of thumb is that see also sections should at least include any of the docs that are in the same navigation section as the doc that is being read. In this case, navigation to roles_for_viewing.rst lives in educators/navigation/content_creation_management.rst
image

@jswope00
Copy link
Contributor

@jesgreco This PR has a conflict with the main branch. Looks to me like the conflict is in the resources_for_course_teams.rst file. In the main branch, that file has a full set of "seealso" links. In your PR, there is only one or two.

So, you'll need to merge the remote main branch into your working branch, and fix the conflict by using the main's version of resources_for_course_teams.rst, and then try your PR again.

Alernatively, I think you could just undo all your changes in resources_for_course_teams.rst and then the PR will pass with no conflicts.

@jswope00 jswope00 assigned jswope00 and unassigned jswope00 Dec 26, 2024
@jswope00 jswope00 self-requested a review December 26, 2024 23:14
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.

Fix the conflict (see my comment in the thread) and then re-request a PR

@jesgreco
Copy link
Contributor Author

@jswope00 conflicts were solved and also changes requested were made.

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: In Eng Review
Development

Successfully merging this pull request may close these issues.

4 participants