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

fix: erase edx reference in the glossary #603

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Apgomeznext
Copy link
Contributor

This PR erase the edX reference in the glossary that belong to the developers section.

This PR erase the edX reference in the glossary that belong to the developers section.
@openedx-webhooks
Copy link

openedx-webhooks commented Nov 8, 2024

Thanks for the pull request, @Apgomeznext!

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 8, 2024
@Apgomeznext Apgomeznext marked this pull request as ready for review November 8, 2024 22:38
@Apgomeznext Apgomeznext marked this pull request as draft November 8, 2024 22:38
@Apgomeznext Apgomeznext marked this pull request as ready for review November 8, 2024 22:38
@Apgomeznext Apgomeznext self-assigned this Nov 8, 2024
@Apgomeznext
Copy link
Contributor Author

I recently found a similar glossary in the educator's section from the documents John migrated. It is here: https://docs.openedx.org/en/latest/educators/references/glossary.html.
We should only keep one of them so as not to duplicate the content.

@sarina
Copy link
Contributor

sarina commented Nov 12, 2024

@Apgomeznext which are you proposing to keep?

@sarina
Copy link
Contributor

sarina commented Nov 12, 2024

@jswope00 - in this PR, references to partnercoursestaff docs have simply been removed. Do you think that's the right thing to do?

@Apgomeznext
Copy link
Contributor Author

@Apgomeznext which are you proposing to keep?

I suggest keeping the glossary in the educators' section because it has a better UX design. In that case, we will need to erase this entrance.

@sarina
Copy link
Contributor

sarina commented Nov 13, 2024

Sounds good to me

@Apgomeznext
Copy link
Contributor Author

Sounds good to me

So, I will close this PR. Should we erase this page now or wait to review the educators' glossary to create the redirection links?

@sarina
Copy link
Contributor

sarina commented Nov 13, 2024

I think it's probably best to merge this, and put combining the glossaries into one as a separate task as it may be a big amount of work, especially if other dev docs reference this glossary. This looks good to me, but I would like John to take a look at my comment before merging.

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Nov 21, 2024
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
Status: In Eng Review
Development

Successfully merging this pull request may close these issues.

4 participants