Skip to content

Conversation

@jacobo-dominguez-wgu
Copy link
Contributor

@jacobo-dominguez-wgu jacobo-dominguez-wgu commented Jul 28, 2025

Description

Adding descriptions for the pending plugin slots from authoring and learning mfe's.
Since we already created some docs for some plugins slots on their own repos, this should be reflected on the global docs for openEdx.

Dependencies

@openedx-webhooks
Copy link

Thanks for the pull request, @jacobo-dominguez-wgu!

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.

Details
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 Jul 28, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jul 28, 2025
@sarina
Copy link
Contributor

sarina commented Jul 28, 2025

Wow thanks so much for this @jacobo-dominguez-wgu !!!!

@brian-smith-tcril do you mind giving this a once-over before I merge it?

@jacobo-dominguez-wgu jacobo-dominguez-wgu moved this from Needs Triage to Ready for Review in Contributions Jul 28, 2025
@jacobo-dominguez-wgu jacobo-dominguez-wgu added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Jul 28, 2025
@brian-smith-tcril
Copy link
Contributor

These look good! I do have a couple questions about how we want to handle these links:

  • I know for the teak docs we'll want to link to the teak branches of the repos. It seems all these links on main are also linking to the teak branches, do we want to keep linking to teak from main or should we link to main/master from main?
  • The dependency PRs landed on master, should we backport those to teak? (I'd think yes since they are just documentation)
  • If we want these links to still point to the teak branches, then should this PR depend on those being backported to teak? (I'd think no as the links are still valid, the docs just won't be fleshed out until the backports land)

@sarina
Copy link
Contributor

sarina commented Jul 28, 2025

I know for the teak docs we'll want to link to the teak branches of the repos. It seems all these links on main are also linking to the teak branches, do we want to keep linking to teak from main or should we link to main/master from main?

These are the Teak release notes (point-in-time documentation) so we should link to Teak branch.

The dependency PRs landed on master, should we backport those to teak? (I'd think yes since they are just documentation)

Yes

If we want these links to still point to the teak branches, then should this PR depend on those being backported to teak?

Might as well so we can remember to verify that the docs render with clickable links.

@brian-smith-tcril
Copy link
Contributor

These are the Teak release notes (point-in-time documentation) so we should link to Teak branch.

Perfect. I just wanted to confirm since the PRs updating the docs on the repos are going to master branches.

The dependency PRs landed on master, should we backport those to teak? (I'd think yes since they are just documentation)

Yes

Sounds great! @jacobo-dominguez-wgu would you be able to make some backport PRs to get the documentation that's landed into the teak branches?

Might as well so we can remember to verify that the docs render with clickable links.

The PRs to the repos aren't changing the URLs at all, just adding documentation to the barebones READMEs that already exist.

@sarina
Copy link
Contributor

sarina commented Jul 28, 2025

🤦🏻‍♀️ yes duh, okay then this PR is not blocked on the backport. If the descriptions look good to you go ahead and merge!

@jacobo-dominguez-wgu
Copy link
Contributor Author

jacobo-dominguez-wgu commented Jul 28, 2025

Sounds great! @jacobo-dominguez-wgu would you be able to make some backport PRs to get the documentation that's landed into the teak branches?

Sure, I will create those backports, thanks!

Copy link
Contributor

@brian-smith-tcril brian-smith-tcril left a comment

Choose a reason for hiding this comment

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

:shipit:

@brian-smith-tcril brian-smith-tcril merged commit 4678022 into openedx:main Jul 28, 2025
2 checks passed
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Jul 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). 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.

4 participants