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

fc-0068 docs: documentation style guide #615

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

Conversation

jesgreco
Copy link
Contributor

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

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 20, 2024
@openedx-webhooks
Copy link

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 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.

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

Who will review my changes?

This repository is currently maintained by @openedx/docs-openedx-org-maintainers. 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.

@jesgreco jesgreco self-assigned this Nov 20, 2024
.. image:: ../assets/example_title.jpg
:width: 500px
:align: center
:alt: This should describe the image for SEO and accessibility reasons.
Copy link
Contributor

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

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Nov 21, 2024
source/documentors/references/doc_style_guide.rst Outdated Show resolved Hide resolved
source/documentors/references/doc_style_guide.rst Outdated Show resolved Hide resolved
source/documentors/references/doc_style_guide.rst Outdated Show resolved Hide resolved
source/documentors/references/doc_style_guide.rst Outdated Show resolved Hide resolved
source/documentors/references/doc_style_guide.rst Outdated Show resolved Hide resolved
source/documentors/references/doc_style_guide.rst Outdated Show resolved Hide resolved
source/documentors/references/doc_style_guide.rst Outdated Show resolved Hide resolved
source/documentors/references/doc_style_guide.rst Outdated Show resolved Hide resolved
jesgreco and others added 16 commits November 26, 2024 13:11
@jesgreco
Copy link
Contributor Author

I've made all the fixes requested by @sarina
Let me know if there is anything else to be fixed.

Copy link
Contributor Author

@jesgreco jesgreco left a 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!

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
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

6 participants