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: style corrections for references and concepts #454

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

Conversation

Apgomeznext
Copy link

@Apgomeznext Apgomeznext commented Feb 3, 2025

Description

docs: This PR modifies some elements of the references and concepts documents for the events repository, such as the titles' RST codes and minor grammar corrections:

  • docs/concepts/event-bus.rst
  • docs/concepts/openedx-events.rst
  • docs/reference/event-bus-configurations.rst
  • docs/reference/events-data.rst
  • docs/reference/events-tooling.rst
  • docs/reference/events.rst
  • docs/reference/in-line-code-annotations-for-an-event.rst
  • docs/reference/oeps.rst

Also, with this Pr, I added a slight modification in the general index order of the repository to improve the user experience in the documentation order: docs/index.rst

Useful information to include:

Motivation and context of the implementation
What's the intended use of this change?
Use cases and usage examples available

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions. Also, link to any relevant documentation useful for reviewers.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Please provide detailed step-by-step instructions for testing this change, including any necessary setup, e.g., additional requirements, plugins, configuration variables, etc, and environment details to ensure the reviewer can test the change.

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

Include anything else that will help reviewers and consumers understand the change.

Any other PRs or issues that should be linked here? Any related PRs?
Any special concerns or limitations? For example: deprecations, security, or anything you think should be noted.
Checklists
Check off if complete or not applicable:

Merge Checklist:

  • All reviewers approved
  • Reviewer tested the code following the testing instructions
  • CI build is green
  • Version bumped
  • Changelog record added with short description of the change and current date
  • Documentation updated (not only docstrings)
  • Code dependencies reviewed
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Post Merge:

  • Create a tag
  • Create a release on GitHub
  • Check new version is pushed to PyPI after tag-triggered build is
  • finished.
  • Delete working branch (if not needed anymore)
  • Upgrade the package in the Open edX platform requirements (if applicable)

@Apgomeznext Apgomeznext requested a review from a team as a code owner February 3, 2025 21:35
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 3, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 3, 2025

Thanks for the pull request, @Apgomeznext!

This repository is currently maintained by @openedx/hooks-extension-framework.

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.


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.

@Apgomeznext Apgomeznext marked this pull request as draft February 3, 2025 21:35
@Apgomeznext Apgomeznext changed the title [FC-0074] - Style corrections for references and concepts [FC-0074] docs: Style corrections for references and concepts Feb 3, 2025
@Apgomeznext Apgomeznext changed the title [FC-0074] docs: Style corrections for references and concepts docs: Style corrections for references and concepts [FC-0074] Feb 3, 2025
@Apgomeznext Apgomeznext changed the title docs: Style corrections for references and concepts [FC-0074] docs: style corrections for references and concepts Feb 3, 2025
@Apgomeznext Apgomeznext force-pushed the Apgomeznext/hooks_events_style_correction branch 4 times, most recently from 202bcdc to 328945f Compare February 4, 2025 20:21
This PR modifies some elements of the references and concepts' documents for the events repository, like the titles' RST codes and minor grammar corrections.
This PR update event-bus.rst
This PR update index.rst
PR to Update openedx-events.rst and fix an error
@Apgomeznext Apgomeznext force-pushed the Apgomeznext/hooks_events_style_correction branch from 328945f to ed623b6 Compare February 4, 2025 20:31
@Apgomeznext Apgomeznext marked this pull request as ready for review February 4, 2025 20:33
@Apgomeznext Apgomeznext self-assigned this Feb 4, 2025
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: Needs Triage
Development

Successfully merging this pull request may close these issues.

2 participants