NextERP/documentation
5
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[IMP] *: harmonize formatting

Browse Source 
- Removed the numbering from headings because it was either inconsistent, breaking the implicit hyperlink target or useless.
- Fixed incorrect heading formattings.
- Replaced hand-written flows by the :menuselection: directive
This commit is contained in:
Antoine Vandevenne (anv)
2020-01-08 11:05:57 +01:00
committed by Antoine Vandevenne (anv)
parent 73fff57983
commit 4bb2eeda11
78 changed files with 810 additions and 621 deletions
Download Patch File Download Diff File Expand all files Collapse all files
support/user_doc.rst
+21 -13
View File
@@ -14,36 +14,43 @@ First of all...
Edit an existing page
=====================
0. As our documentation is maintained on GitHub, you'll need a free `GitHub account <https://help.github.com/en/articles/signing-up-for-a-new-github-account>`_.
1. Pick a page in our `user documentation <https://www.odoo.com/documentation/user>`_. **Please take care of choosing the right version of Odoo.**
2. Click on **Edit on Github** in the left menu.
#. As our documentation is maintained on GitHub, you'll need a free `GitHub account
<https://help.github.com/en/articles/signing-up-for-a-new-github-account>`_.
#. Pick a page in our `user documentation <https://www.odoo.com/documentation/user>`_.
**Please take care of selecting the right version of Odoo.**
#. Click on **Edit on Github** in the left menu.
.. image:: ./media/edit_on_github.png
:align: center
:alt: Click on "Edit on Github".
3. If this is the first time you edit our documentation, click on **Fork repository**, else you won't see this step.
4. Use Github's editor to add your text. Text is tagged with a simple syntax called `RST <http://docutils.sourceforge.net/rst.html>`_. Don't worry, it's not so hard to learn 🤓... See the following section of this document for a quick overview of RST commands.
#. If this is the first time you edit our documentation, click on **Fork repository**, otherwise
you won't see this step.
#. Use Github's editor to add your text. Text is tagged with a simple syntax called `RST
<http://docutils.sourceforge.net/rst.html>`_. Don't worry, it's not so hard to learn 🤓...
See the following section of this document for a quick overview of RST commands.
.. image:: ./media/add_text.png
:align: center
:alt: Use Github's editor to add your text.
5. Click on **Preview changes** to review your contribution in a human-readable format.
#. Click on **Preview changes** to review your contribution in a human-readable format.
.. image:: ./media/preview_changes.png
:align: center
:alt: Click on "Preview changes" to review your contribution.
6. In the **Propose file change** section, add a short title to your contribution. The title should summarize your changes. You may use the second box to add an extended description if your contribution requires a longer explanation.
#. In the **Propose file change** section, add a short title to your contribution.
The title should summarize your changes. You may use the second box to add an extended
description if your contribution requires a longer explanation.
.. image:: ./media/propose_changes.png
:align: center
:alt: Add a title and submit your contribution.
7. Submit your contribution by clicking on **Propose file change**.
8. Click on **Create pull request**.
9. Wait for an Odoo maintainer to add your contribution. Thank you for your help!
#. Submit your contribution by clicking on **Propose file change**.
#. Click on **Create pull request**.
#. Wait for an Odoo maintainer to add your contribution. Thank you for your help!
.. warning::
There is no automatic port of your edit to another version of the documentation.
@@ -69,13 +76,13 @@ Here is a summary of the markup elements you may use while editing our documenta
| | | |
| Text in **bold** letters | | |
+------------------------------+--------------------------+---------------------------------------+
| .. code-block:: rst | 1. Numbered | Must be surrounded by white lines. |
| .. code-block:: rst | 1. Numbered | - Must be surrounded by white lines. |
| | 2. Bullet | |
| 1. Numbered | 3. List | |
| 2. Bullet | | |
| 3. List | | |
+------------------------------+--------------------------+---------------------------------------+
| .. code-block:: rst | - Numbered | Must be surrounded by white lines. |
| .. code-block:: rst | - Numbered | - Must be surrounded by white lines. |
| | - Bullet | |
| - Bullet | - List | |
| - Point | | |
@@ -89,7 +96,8 @@ Here is a summary of the markup elements you may use while editing our documenta
.. note::
There are many more commands available, see `comprehensive documentation <http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html>`_ of RST.
There are many more commands available, see `comprehensive documentation
<http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html>`_ of RST.
Add images to your documents
support/where_can_i_get_support.rst
+3 -1
View File
@@ -9,7 +9,9 @@ Where to find help?
Odoo Enterprise
===============
Users who have a valid Odoo Enterprise subscription may always contact our support teams through our `support form <https://www.odoo.com/help>`_, no matter the hosting type you chose (Odoo Online, Odoo.sh or on your own server).
Users who have a valid Odoo Enterprise subscription may always contact our support teams through our
`support form <https://www.odoo.com/help>`_, no matter the hosting type you chose (Odoo Online,
Odoo.sh or on your own server).
Please include in your request: