.. _Documentor Guidelines:

Documentor Guidelines
######################

.. tags:: documentor, reference

If you have developed a new feature, created an XBlock, or otherwise see that a topic is missing in this documentation, you can create one or more new pages in this document and submit a pull request to have the content added.  Follow the guidelines below.

When you are ready to update documentation, see :ref:`Add New Documentation Through GitHub`.

GitHub
******

Open edX documentation, along with source code, is managed in GitHub, in the `Open edX Documentation GitHub repository`_.

Anyone can propose updates to the documentation, following a process known as the `GitHub Flow`_.

The Open edX team will review the proposed changes, collaborate with the author, and merge the documentation when it is ready. You will then see it on the `Open edX Documentation`_ site.

.. note:: Create a GitHub Account


    .. include:: ../how-tos/reusable_content/create_github_account.txt

RST
***

Open edX documentation is written in RST. If you are not familiar with RST, we recommend going through :ref:`Documentation Syntax Reference`.

We also provide :ref:`Documentation Templates` you can copy from as you create a new documentation.

We also recommend reviewing the `RST Primer`_ if you have questions.

Get Started
***********

When you have identified the audience(s) and content type(s) you need to address, we recommend that you follow the steps in :ref:`Add New Documentation Through GitHub`.

If you have questions as you go, we recommend asking the Open edX Documentation Slack channel.

.. seealso::

   :ref:`About Open edX Documentation Standards` (concept)

   :ref:`Documentation Maintenance Process` (reference)

   :ref:`Guidelines for Writing Global English` (reference)

   :ref:`Open edX Documentation Writing Style Guide` (reference)

   :ref:`Documentation Templates` (reference)

   :ref:`Documentation Syntax Reference` (reference)

   :ref:`Documentation Audiences` (concept)

   :ref:`Update An Existing Doc via GitHub` (how-to)

   :ref:`Add New Documentation via GitHub` (how-to)

   :ref:`Report a problem with the docs` (how-to)


**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date  | Working Group Reviewer        |   Release      |Test situation                  |
+--------------+-------------------------------+----------------+--------------------------------+
|              |                               |                |                                |
+--------------+-------------------------------+----------------+--------------------------------+