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: [FC-0074] add new hooks docs in concepts section #35733

Closed
wants to merge 6 commits into from

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Oct 28, 2024

Description

This PR moves the old hooks guide into its own concepts subsection. It also solves the duplication of documents in openedx-events and filters when referencing shared concepts like the overall hooks framework and comparison between the two to reduce maintenance efforts.

Supporting information

See openedx/openedx-events#406 and openedx/openedx-filters#222 where I started the conversation of moving these documents here.

@openedx-webhooks
Copy link

Thanks for the pull request, @mariajgrimaldi!

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. 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 Oct 28, 2024
@mariajgrimaldi mariajgrimaldi changed the title docs: add new hooks docs in concepts section docs: [FC-0074] add new hooks docs in concepts section Oct 28, 2024
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Oct 28, 2024
docs/concepts/hooks/index.rst Outdated Show resolved Hide resolved
docs/concepts/hooks/index.rst Outdated Show resolved Hide resolved
docs/concepts/hooks/index.rst Outdated Show resolved Hide resolved
docs/concepts/hooks/index.rst Outdated Show resolved Hide resolved
docs/concepts/hooks/index.rst Show resolved Hide resolved
docs/concepts/hooks/index.rst Outdated Show resolved Hide resolved
docs/concepts/hooks/index.rst Show resolved Hide resolved
docs/concepts/hooks/index.rst Outdated Show resolved Hide resolved
@mariajgrimaldi
Copy link
Member Author

Closed in favor of openedx/docs.openedx.org#599

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.

3 participants