Technical Committee governance docs have moved to a subdirectory
of governance.o.o, so update the links pointing to it.
Change-Id: If597d85b3315a3b345ad4d00b27568dbd527ea19
To clarify the official service and project naming conventions.
Also, fix the official name source.
Change-Id: I1887b4421453ebeed82f90bcfe92c9712b91b5df
Remove heading guidelines for the Operations Guide,
since we decided at the Austin Design Summit to no
longer publish with O'Reilly.
Change-Id: Ic341951974fbf8df495c5d5b061f6b090ed2a618
Implements: blueprint contributor-guide-reorg
This patch:
- adds a few tips to the figures and tables titles section
- combines the Table titles and Figure titles subsection
bc they have the same guidelines
- adds cross-references to the figures and tables titles
description in the RST and Writing style sections
Change-Id: Iafe17cd793d4266c473850489348c183be0fec00
Closes-Bug: #1567258
Adds the Headings section to the Writing style subsection
of the Contributor Guide.
Change-Id: Ia42605bf003ca7d71a484b044434a1b476de6aca
Closes-Bug: #1524337
Fixed one misplaced space in source of table "Recasting the sentence
in active voice is wordy or awkward." in "Writing style" section of
"Contributor guide" which caused the output table to be completely
unreadable.
Change-Id: I6be172e10454a86e8ac86460208e2bdb5c9bcd32
Closes-Bug: #1544735
In this patch,
1.) Added networking-guide to the list of guides for those backport is
to be used in the commit messages
Change-Id: Ic2b8690b33d3cea6dcd59a21792435fe6be8919f
This patch:
- adds a word 'lifecycle' to the Word choice section as it has
different spelling in Merriam Webster and IBM Terminology dics.
- corrects a grammar mistake (continously -> continuously).
Change-Id: If3e77afdf72be31395b4e5c7d7e0bdbebbf4f4c3
Add plug-in to word-choice, this was in the wiki but lost during the
conversation, add it back so that we can easily reference it.
Change-Id: Ie89d535c8821bfd907a6ab869ee6d44e79edac46
Added 3 new sections to writing style section -
avoid ambiguous titles, use consistent terms,
use spelling tools when available. These sections
can help improve SEO results for content.
Change-Id: I0c83efc00529135028e2c560fbd7c19df9453787
Closes-Bug: #1513270
Adds the following subsections to Writing style:
1. Command-line interface guidelines.
2. Graphical and web user interface guidelines.
Adds some ref labels to the sections that are referred from Standard UI
terminology.
Change-Id: I064d4819b79ec3ec334020df734569ebc066985a
Closes-Bug: #1513823
Co-Authored-By: Svetlana Karslioglu <skarslioglu@mirantis.com>
This patch:
1. Corrects a typo in the word "host name" (according to IBM
Terminology).
2. Removes "open-launch" example, as both words can be used
depending on context.
3. Changes the synonyms for the word "execute" and adds a
small explanation for its usage.
4. Adds the word "setup" as a noun for consistency with other
verb-noun pairs.
Change-Id: Ie167015f7f1800edda21cde082d2c30f15253ceb
This patch corrects spelling of the word "data store"
according to the IBM terminology (datastore -> data store).
Change-Id: I31c03d749db8ad1f7f4966077a5bc75d080fa04b
`x` is not rendered special in any way and thus not visible. Just use
"x" instead to mark the words.
Change-Id: I51331fd2aa1ed58c55903cd0cd549b62949785c1
Indent the items so that this formats properly.
Also, ``markup`` inside of **markup** does not work, use single
quotation marks instead.
Change-Id: Iec2776929f14f114d7ae0132f5367347abc4d984
The IBM Style Guide is used not only for spelling but in general, add it
as general guideline.
Original wiki content was "This page lists conventions that the Docs
team follows for writing documentation. Additionally, the IBM Style
Guide is used as reference. In case of conflicts between these two, the
wiki convention pages takes precedence."
Change-Id: Ic308841a3ddb9551c2b80ea237ec587165d3c59d