clearlinux/clear-linux-documentation
2
0
Fork 0
mirror of https://github.com/clearlinux/clear-linux-documentation.git synced 2026-06-29 17:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor revisions to structure-formatting and writing-guide (based on feedback)

Browse Source 
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale
2019-01-23 13:18:15 -08:00
parent 7f7841d40a
commit 1aa805dddc
2 changed files with 7 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/clear-linux/reference/collaboration/structure-formatting.rst
+4 -5
View File
@@ -25,8 +25,8 @@ websites:
* `Sphinx documentation`_
* `reStructuredText Primer`_
You can view the content directly in the .rst markup files, or you can generate
the HTML content by installing and running the documentation locally. To run the
You can view the content directly in the .rst markup files, or generate the HTML
content by installing and building the documentation locally. To run the
documentation locally, follow the instructions found in the
`documentation repository`_ README.
@@ -241,9 +241,8 @@ Remove trailing whitespace from your documents.
Code blocks and examples
************************
When providing example code or commands that are less than 10 lines, use the
`Sphinx code-block directive`_. Use the appropriate syntax highlighting for the
example command or code.
When providing example code or commands use the `Sphinx code-block directive`_.
Select the appropriate syntax highlighting for the example command or code.
For example, if showing console output, use console highlighting:
source/clear-linux/reference/collaboration/writing-guide.rst
+3 -12
View File
@@ -32,8 +32,9 @@ Introduction, body, and conclusion.
Be friendly
===========
We write for our peers and want to be familiar. Use the second person, you or
we. Be professional, respectful, and cooperative.
We write for our peers and want to be familiar. Take a personal tone as if you
were speaking directly to the reader. Use "you" to address the reader and "we"
to refer to our view. Be professional, respectful, and cooperative.
Assume your audience has the same level of technical understanding and expertise
as you did when you first started collaborating. Do not talk down to our
@@ -289,16 +290,6 @@ to two. For example:
Power management mechanism integration policies.
Or:
**Use this:** ::
Requirements for test desks that measure signal integrity.
**Not this:** ::
Signal integrity test deck requirements.
.. _parallelism:
Parallelism