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

[FIX] contributing: fix admonition padding

Browse Source 
The padding was not correctly set because the admonition was included
in an <ul> element which was itself inside another <ul> element.
The table below the admonition is also moved outside of the <ul>
because it is semantically incorrect.
This commit is contained in:
Antoine Vandevenne (anv) 2021-06-04 15:47:44 +02:00 committed by Antoine Vandevenne (anv)
parent ddb5523d03
commit fffaca7384
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
content/contributing/documentation/content_guidelines.rst
View File

@ -81,33 +81,33 @@ To write good titles and headings:
- proper nouns (brands, product and service names, etc.) - proper nouns (brands, product and service names, etc.)
- app features, as written in the apps - app features, as written in the apps
.. important:: .. important::
Do not capitalize common nouns when they are not referred to as features. This is more likely Do not capitalize common nouns when they are not referred to as features. This is more likely
to happen in headings rather than in titles. to happen in headings rather than in titles.
+------------------+-----------------------------------+--------------------------------------------------------+ +------------------+-----------------------------------+--------------------------------------------------------+
| | Examples | Explanations | | | Examples | Explanations |
+==================+===================================+========================================================+ +==================+===================================+========================================================+
| | **Titles** | *Quotation Templates* | "Quotation Templates" is a feature in Odoo. | | | **Titles** | *Quotation Templates* | "Quotation Templates" is a feature in Odoo. |
| | (h1) +-----------------------------------+--------------------------------------------------------+ | | (h1) +-----------------------------------+--------------------------------------------------------+
| | *Lead Mining* | "Lead Mining" is a feature in Odoo. | | | *Lead Mining* | "Lead Mining" is a feature in Odoo. |
| +-----------------------------------+--------------------------------------------------------+ | +-----------------------------------+--------------------------------------------------------+
| | *Resupply from another Warehouse* | "Warehouse" is capitalized as we refer to the feature | | | *Resupply from another Warehouse* | "Warehouse" is capitalized as we refer to the feature |
| | | in the app rather than to a real warehouse. | | | | in the app rather than to a real warehouse. |
| +-----------------------------------+--------------------------------------------------------+ | +-----------------------------------+--------------------------------------------------------+
| | *Synchronize Google Calendar | "Google Calendar" is a product and "Odoo" is a brand. | | | *Synchronize Google Calendar | "Google Calendar" is a product and "Odoo" is a brand. |
| | with Odoo* | | | | with Odoo* | |
+------------------+-----------------------------------+--------------------------------------------------------+ +------------------+-----------------------------------+--------------------------------------------------------+
| | **Headings** | *Confirm the quotation* | "The quotation" is a common noun not referring to a | | | **Headings** | *Confirm the quotation* | "The quotation" is a common noun not referring to a |
| | (h2, h3, etc.) | | feature in Odoo. | | | (h2, h3, etc.) | | feature in Odoo. |
| +-----------------------------------+--------------------------------------------------------+ | +-----------------------------------+--------------------------------------------------------+
| | *Test environment* | "Environment" is a common noun. | | | *Test environment* | "Environment" is a common noun. |
| +-----------------------------------+--------------------------------------------------------+ | +-----------------------------------+--------------------------------------------------------+
| | *Add a new Payment Acquirer* | "Payment Acquirers" is a feature in Odoo. | | | *Add a new Payment Acquirer* | "Payment Acquirers" is a feature in Odoo. |
| +-----------------------------------+--------------------------------------------------------+ | +-----------------------------------+--------------------------------------------------------+
| | *Generate SEPA Direct Debit XML | "SEPA Direct Debit" and "XML" are considered as proper | | | *Generate SEPA Direct Debit XML | "SEPA Direct Debit" and "XML" are considered as proper |
| | files to submit payments* | nouns. | | | files to submit payments* | nouns. |
+------------------+-----------------------------------+--------------------------------------------------------+ +------------------+-----------------------------------+--------------------------------------------------------+
.. _contributing/document-structure: .. _contributing/document-structure: