-
Notifications
You must be signed in to change notification settings - Fork 57
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
fc-0068 docs: documentation style guide #615
base: main
Are you sure you want to change the base?
fc-0068 docs: documentation style guide #615
Conversation
Adding the new Open edX Documentation Writing Style Guide Google Drive Doc: https://docs.google.com/document/d/13QbAoT1N4rac41r90YJImPzMTuY4rpqH5EnyPO8sw4w/edit?tab=t.0#heading=h.qm0lcv76r67g
Thanks for the pull request, @jesgreco! What's next?Please work through the following steps to get your changes 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. 🔘 Let us know that your PR is ready for review:Who will review my changes?This repository is currently maintained by 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. |
.. image:: ../assets/example_title.jpg | ||
:width: 500px | ||
:align: center | ||
:alt: This should describe the image for SEO and accessibility reasons. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
.. code-block::
.. image:: _assets/example_image_2.png
:width: 500px
:align: center
:alt: Alternative text. this is important for accessibility
Co-authored-by: Sarina Canelake <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
Co-authored-by: Sarina Canelake <[email protected]>
…om/aulasneo/docs.openedx.org into jesgreco/style_guide_documentation
Co-authored-by: Sarina Canelake <[email protected]>
…om/aulasneo/docs.openedx.org into jesgreco/style_guide_documentation
Co-authored-by: Sarina Canelake <[email protected]>
I've made all the fixes requested by @sarina |
Co-authored-by: Sarina Canelake <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sarina @Apgomeznext @jswope00 Can you please help me with the error? I've just edited the doc and still the error is there. Thanks!
Adding the new Open edX Documentation Writing Style Guide
Google Drive Doc: https://docs.google.com/document/d/13QbAoT1N4rac41r90YJImPzMTuY4rpqH5EnyPO8sw4w/edit?tab=t.0#heading=h.qm0lcv76r67g