-
Notifications
You must be signed in to change notification settings - Fork 23
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] style corrections for references and concepts #454
base: main
Are you sure you want to change the base?
docs: [FC-0074] style corrections for references and concepts #454
Conversation
Thanks for the pull request, @Apgomeznext! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
202bcdc
to
328945f
Compare
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
328945f
to
ed623b6
Compare
7a31294
to
0f0faee
Compare
Co-Authored-By: Sarina Canelake <[email protected]>
Co-Authored-By: Sarina Canelake <[email protected]>
Co-Authored-By: Sarina Canelake <[email protected]>
0f0faee
to
b3b5139
Compare
…vents_style_correction
@mariajgrimaldi @sarina, the requested modifications have been applied. Please let me know if you find anything else or if this PR is ready to be merged. |
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:
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:
Post Merge: