clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-08-26 10:28:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

- Remove GitHub repo link from toctree

Browse Source 
- Reword description for use of :abbr:
- Simplify reference to mailing list

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale
2019-01-16 16:57:24 -08:00
parent b6db090cee
commit 7d70b47969
2 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/clear-linux/reference/collaboration/collaboration.rst
+3 -5
View File
@@ -8,8 +8,7 @@ be improved? Help us out by contributing! If you haven't contributed before,
take a moment to review our `Contribution guidelines`_.
Do you have questions about the documentation that were not answered by these
guidelines? Send your question to the `mailing list`_ at:
dev@lists.clearlinux.org.
guidelines? Send your question to the `mailing list`_.
Contribution guidelines
***********************
@@ -21,9 +20,8 @@ readable documentation.
.. toctree::
:maxdepth: 1
Writing guide describes the style we use to keep our documents clear and concise. <writing-guide>
Structure and formatting guide explains how we use reStructuredText and Sphinx. <structure-formatting>
GitHub documentation repository shows our document organization. <https://github.com/clearlinux/clear-linux-documentation>
Writing guide: Describes the style we use to keep our documents clear and concise. <writing-guide>
Structure and formatting guide: Explains how we organize and format content, using reStructuredText and Sphinx. <structure-formatting>
How to contribute
*****************
source/clear-linux/reference/collaboration/structure-formatting.rst
+4 -4
View File
@@ -158,10 +158,10 @@ Use our quick reference for the most commonly used inline text elements:
+--------------------------------+---------------------------------------+-----------------------------+
| **Element** | **Convention** | **reST/Sphinx** |
+--------------------------------+---------------------------------------+-----------------------------+
| Acronyms | First instance, display definition as | Use the ``:abbr:`` role. |
| | flyover text in this format: | |
| | ``:abbr:`Acronym (Definition)``` | |
| | For subsequent uses, use the acronym. | |
| Acronyms | Define acronym when first used. After | Use the ``:abbr:`` role, in |
| | first use and definition, use the | the following format: |
| | acronym only. | |
| | | ``:abbr:`Acronym (Def)``` |
+--------------------------------+---------------------------------------+-----------------------------+
| Bundle names | Bold | Use the ``:command:`` role. |
+--------------------------------+---------------------------------------+-----------------------------+