43 Commits

Author SHA1 Message Date
Farhan Kalsekar
b95490036b [Contributor Guide] Fix typo
Closes-Bug: #1683773

Change-Id: I1fab01eb7f19259d82e7cb025b17c6707051a56c
2017-04-18 14:07:00 +00:00
qiaomin
0745264074 Add the missing markup for the link title
Change-Id: Ieea9e6a8757e2b185133be58393b4ca1302f45f6
2017-02-25 16:48:32 +08:00
KATO Tomoyuki
380069d9da Use https instead of http for git.openstack.org
Change-Id: I0b76dd67854bd354435a56294c67667eeee1bebd
2017-01-31 13:40:14 +09:00
KATO Tomoyuki
41476b346a [contributor] use https instead of http for docs.o.o
Change-Id: Ife7a36926facd08ffda77810d83083b5f19f4783
2017-01-27 19:08:11 +09:00
Alexandra Settle
57da5de0ab Add guidelines on the use of example URLs
Change-Id: If83e0225e540dd1b6c88134737b50213485dd720
Partial-bug: 1611176
2017-01-19 15:14:59 +00:00
KATO Tomoyuki
1678b30a67 [contributor] adjust table format to edit easily
Change-Id: Iad25b1204343fb3b49df44e0851cabade6dc3208
2017-01-10 13:00:08 +09:00
KATO Tomoyuki
a10e9ab10e [contirbutor] add word choice for compute node
Change-Id: Id1b65e440e3b8da15e3013602ada999df47872e3
2017-01-10 12:59:27 +09:00
Thierry Carrez
be46f86c18 Update link for TC documentation
Technical Committee governance docs have moved to a subdirectory
of governance.o.o, so update the links pointing to it.

Change-Id: If597d85b3315a3b345ad4d00b27568dbd527ea19
2017-01-04 15:29:42 +01:00
KATO Tomoyuki
deafb8590f [contributor] add link to TC service and project naming
To clarify the official service and project naming conventions.

Also, fix the official name source.

Change-Id: I1887b4421453ebeed82f90bcfe92c9712b91b5df
2016-07-26 22:39:56 +00:00
daz
2c7e1eb1be [contrib-guide] Remove O'Reilly guidelines
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
2016-07-12 17:42:21 +10:00
KATO Tomoyuki
5fed922adc [contributor] Add convention for parameters
Currently, we have various notations for parameters.

Change-Id: I15f89e6059bcaa92e47cb599df35b6c0a4d77630
2016-05-10 14:20:37 +00:00
Christian Berendt
cc0226576b [contributor] use . to source script files
Change-Id: Ia781eb491554d786e38ab1f78b5de20bf0b9fab7
2016-04-12 16:56:17 +00:00
Olena Logvinova
6b3a2c2684 [Contributor Guide] Figure and table titles amendments
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
2016-04-08 14:45:03 +03:00
Maria Zlatkova
0fca096dfb [Contributor Guide] Headings
Adds the Headings section to the Writing style subsection
of the Contributor Guide.

Change-Id: Ia42605bf003ca7d71a484b044434a1b476de6aca
Closes-Bug: #1524337
2016-04-05 12:19:44 +03:00
Jacek Tomasiak
b4cf1ab162 Fix table under "Recasting the sentence in active voice (...)"
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
2016-02-11 22:35:08 +01:00
Jenkins
33bd7f86b7 Merge "[ui-content-guidelines] Text guidelines for the UI" 2016-01-29 01:51:48 +00:00
Linette
3f4a614602 [ui-content-guidelines] Text guidelines for the UI
Adding structure and content for UI content
guidelines within the Documentation
Contributor Guide

Co-Authored-By: Gudrun Wolfgram <gmolson@us.ibm.com>
Change-Id: Ib315913a3149cc997be4e4f09fa67df626c07562
Implements: blueprint ui-content-guidelines
2016-01-28 08:13:28 -06:00
venkatamahesh
ac6bb74a8f [contributor-guide] Update the content of the guide
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
2016-01-25 08:00:25 +00:00
KATO Tomoyuki
e0acee6238 [contributor] Emphasize Preferred word choices
To improve the readability.

Change-Id: Iaa5420a4fad9c48aa2af8046d80f3c6d8ab4e99e
2016-01-22 07:22:08 +09:00
Jenkins
42aebd9fb7 Merge "made word change to punctuation file" 2016-01-20 22:57:47 +00:00
Jenkins
3a16373aa1 Merge "small change to release-names file" 2016-01-20 22:51:24 +00:00
Shilla Saebi
628849923d corrected typo in ui-terminology file
changed elipses to ellipses

Change-Id: I91f973ba3ad388740cfbaaf281d6b2785ebefcd6
2016-01-20 15:37:51 -05:00
Shilla Saebi
8ce6be049d small change to release-names file
reworded the example for clarity

Change-Id: I419700a7217f529343704eba55703fbf9083d7d7
2016-01-20 15:35:07 -05:00
Shilla Saebi
8b1dd1c0cd made word change to punctuation file
changed These applies to This applies

Change-Id: Id49185bf202b96885353b7a1003d2122072e056a
2016-01-20 15:34:28 -05:00
Maria Zlatkova
3fac01cd15 [Contributor Guide] Minor edits
Only minor edits: mostly missing articles and commas.

Change-Id: I87cd2faed19e1cf305894ae05e0f2247894eb466
2016-01-15 14:30:37 +02:00
Olena Logvinova
6969ca5b24 [contributor guide] Add lifecycle to Word choice section
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
2016-01-14 14:01:44 +02:00
Andreas Jaeger
124a4fd7d4 Mention plug-in spelling
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
2016-01-05 19:07:55 +01:00
OlgaGusarenko
3465140906 [Contributor Guide] Writing style, new sections added
Adds:
- Lists
- Numbers and units of measure
- Punctuation

Change-Id: Ib713e1e411427e9e5d11040b7756d007c8ad9ac6
Closes-Bug: #1513846
2015-12-15 13:07:37 +02:00
Jenkins
51061975a3 Merge "[Contributor Guide] Enhance writing style section" 2015-11-18 04:31:55 +00:00
Linette
414dd6ccd5 [Contributor Guide] Enhance writing style section
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
2015-11-17 11:10:57 -06:00
OlgaGusarenko
ae928216f9 [Contributor Guide] Standard UI terminology
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>
2015-11-16 14:29:17 +02:00
Olena Logvinova
eb44278f97 [contirbutor guide] Amend "word choice" table
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
2015-11-05 16:19:19 +02:00
Olena Logvinova
f67716f751 [contributor] Fix the "data store" typo
This patch corrects spelling of the word "data store"
according to the IBM terminology (datastore -> data store).

Change-Id: I31c03d749db8ad1f7f4966077a5bc75d080fa04b
2015-11-05 13:58:58 +02:00
David Mahler
3c5fe2a6bc Minor gramatical update
Change-Id: I1d9afa2b7a1ce7562537414066a3e230c166395f
2015-10-30 18:46:58 +00:00
Andreas Jaeger
bed29b76b3 Contributor Guide: Fix markup
`x` is not rendered special in any way and thus not visible. Just use
"x" instead to mark the words.

Change-Id: I51331fd2aa1ed58c55903cd0cd549b62949785c1
2015-10-29 08:10:00 +01:00
Andreas Jaeger
0eeb083894 [contributor guide] Nit: Add empty line
Add empty line around example for better formatting.

Change-Id: I0c5e6a4b4c17b3736be2ee0786449fae7273d7a8
2015-10-27 14:20:00 +01:00
Jenkins
46ea95e72e Merge "[Contributor Guide] Update Code convention markup" 2015-10-27 00:30:05 +00:00
Jenkins
4db8dd2a4c Merge "Update releases link" 2015-10-27 00:29:56 +00:00
Andreas Jaeger
697a1dc553 [Contributor Guide] Update Code convention markup
Indent the items so that this formats properly.
Also, ``markup`` inside of **markup** does not work, use single
quotation marks instead.

Change-Id: Iec2776929f14f114d7ae0132f5367347abc4d984
2015-10-26 22:25:28 +01:00
Andreas Jaeger
32ac624c24 Update releases link
https://wiki.openstack.org/wiki/Releases points now to
http://docs.openstack.org/releases/, so use the new URL.

Change-Id: I129910f0d17237a26466f1bd5f56df1d1d666d17
2015-10-26 22:20:54 +01:00
Andreas Jaeger
2a27962f65 Add general reference for IBM Style Guide
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
2015-10-26 21:07:40 +01:00
KATO Tomoyuki
0fa616aeaf Remove unnecessary indent to avoid blockquote
Change-Id: I62b6619d75117dfe995e1684ba157d28ec43b275
2015-10-09 10:51:32 +09:00
Svetlana Karslioglu
866af89727 Added a section about the writing style
Converted to the .rst format, modified, and extended this section:
https://wiki.openstack.org/wiki/Documentation/Conventions

Change-Id: I836ebed9c08bdd22395d9ff436e480f025f3d268
Implements: blueprint docs-contributor-guide
2015-09-24 14:09:23 -07:00