openstack/openstack-manuals
Code Issues Proposed changes

[contrib] Do not depend on non-free external style guides

Browse Source 
The IBM Style Guide free version doesn't appear to be available,
so do not depend on any external non-open-source style guides,
per the broader community feedback from:

http://lists.openstack.org/pipermail/openstack-dev/2018-May/130562.html

As for spelling references, refer to Merriam-Webster & IBM
developerWorks (which is based on the formerly used IBM guide).

Change-Id: I722959870277d50020e6bac540522abf302ad23b
Closes-Bug: #1764851
This commit is contained in:
Petr Kovar 2018-04-18 17:06:48 +02:00
parent 534dce1da0
commit b4e38a2f3a
1 changed files with 4 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/doc-contrib-guide/source/writing-style/general-writing-guidelines.rst
View File

@ -5,19 +5,15 @@ General writing guidelines
~~~~~~~~~~~~~~~~~~~~~~~~~~
Follow these guidelines to ensure readability and consistency of the
OpenStack documentation. In addition to these guidelines, the
`IBM Style Guide <http://www.redbooks.ibm.com/Redbooks.nsf/ibmpressisbn/9780132101301?Open>`_
is used. In case of conflicts between the IBM style guide and these
guidelines, these pages take precedence.
OpenStack documentation.
Use standard English
--------------------
Use standard United States (U.S.) English throughout all technical
publications.
When in doubt about the spelling of a word, consult the
`Merriam-Webster's Collegiate Dictionary` and the `IBM Style Guide
<http://www.redbooks.ibm.com/Redbooks.nsf/ibmpressisbn/9780132101301?Open>`_.
publications. When in doubt about the spelling of a word, consult the
`Merriam-Webster's Collegiate Dictionary` and the
`IBM developerWorks editorial style guide <https://www.ibm.com/developerworks/library/styleguidelines/>`_.
.. _write_in_active_voice: