32 Commits

Author SHA1 Message Date
Doug Hellmann
1fd07e6e31 Remove the user-guide
The useful content in the user guide is all being moved to
project-specific docsets. We can remove the guide here, and replace it
with a /user/ landing page that provides links to all of the known user
guides for services and clients.

Change-Id: I7005b4288b94e755f406fd6a8e3273265b643042
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-14 17:05:46 +02:00
Andreas Jaeger
765f9cc24e Update code samples to ocata
Update code samples to use stable/ocata version instead of
stable/newton.

Change-Id: I2cc3df29ab42e6900af5cd0a0327d985cd66dd5d
backport: ocata
2017-04-06 20:39:53 +02:00
KATO Tomoyuki
2c8fa4120f [contributor] add more details about RST reference
Change-Id: I4c968cc476b87d38a97bf57a2686d0cb88f7473e
Closes-Bug: #1671068
2017-03-11 07:48:06 +00: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
Jenkins
11f711ce0f Merge "Prepare for Sphinx 1.5" 2017-01-13 11:43:34 +00:00
Andreas Jaeger
2d44b2b36d Prepare for Sphinx 1.5
The new sphinx version introduces some changes that break build:

* Warns if code cannot be parsed for highlighting. Fix the code so
  that it can be parsed, this includes uncommenting "..." lines.
  Note that not every config file is an ini-file.
  Also, the parser seems to have bugs and cannot parse all files.
  Fix mysql ini file and enable the parameter, see
http://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_file_per_table
* :option: works only with declared options, replace useage with
  simple ``.

This change only handles a few files, more to come later.

Change-Id: I7c7335e514581622dd562ee355f62d6ae1beaa18
2017-01-11 20:37:55 +01:00
Andreas Jaeger
05e9247c2f [Contributor] Remove :option:
Sphinx 1.5 warns about :option: usage without .. option:: description.
Since we do not use .. option:: to describe parameter, remove :option:
from the guide.

Note that sphinx did not parse ````--parameter````, I had to add an
extra space.

Change-Id: Ie1dc2261ff7187570d15711e7b5734a6b15b0e2d
2017-01-11 17:40:50 +01:00
Pranav Salunke
31416cf33e Document new rst syntax for parser.
Updates rst syntax changes for the installation guides in specific but
could potentially also be followed by other guides providing BASH like
code.

- Documents parser related syntax changes.
- Updates current documentation for profiling (only blocks) and source
  code (code-blocks).

Change-Id: I831b79f01ea9b5c8fe9f7861887d2c14a9e213bc
2016-10-29 22:44:16 +02:00
qiaomin
92f9d8a656 [contributor-guide] Use newton title for install guide to replace mitaka
Since newton rename the Installation Guide to Installation Tutorials
and Guides, so this patch use the new name in contributor guide
for cleanup.

Change-Id: I77553a5337a72ff5d12df565859c19bf9b9b93e0
2016-10-10 00:51:12 +00:00
qiaomin
2dae2010d7 Modify the 'api-paste.ini' file to 'stable/newton'
Change-Id: Ib8f94cfdcf1851978268704cebcf9433c56012a5
2016-09-27 22:18:03 +00:00
Emma Foley
3f2ea6e9d6 [glossary] Remove acronyms [E-I]
- Remove acronym-only entries starting with [E-I].
- Consolodate duplicate entries.
- Resolve glossary references

Implements: blueprint improve-glossary-usage
Change-Id: I0112705305aba0c22346d9dd3386a308c93f6003
2016-08-30 09:46:54 +00:00
Emma Foley
7630ff334b Replace term: complemental -> complementary
The term complemental is used in the install guide.
This is ranked as a difficult term[1].

- Replace with complementary, which is a better-known term

[1] http://www.dictionary.com/browse/complemental
Closes-Bug #1613348

Change-Id: Ib695a880ed78162dee668d438e89a17e3190922f
2016-08-15 17:48:50 +01:00
Anne Gentle
4427156ad5 Points to reason for why hyphens are the convention for RST file names
Change-Id: I2d77fee955679e68a8ce7631d77e03281a2b00c0
2016-07-19 08:58:35 -05:00
KATO Tomoyuki
18d4e76ef5 [contributor] move fille naming into RST conventions
Change-Id: I5fdce23831c0018b2cdeccf58b1d141603fa5b33
Implements: blueprint contributor-guide-reorg
2016-07-17 23:29:17 +09:00
KATO Tomoyuki
f06e866917 [contributor] reorganize RST/JSON conventions
Change-Id: Idac1e6c049438819d5c363b694102c22d67fa19b
Implements: blueprint contributor-guide-reorg
2016-07-12 14:42:50 +00:00
Maria Zlatkova
e7dc20bbf7 [contributor] Minor edits
Only editorial changes to the Contributor Guide.

Change-Id: Ia6517068664e21c71c62525f8761b3a3c7b96760
2016-07-07 12:04:34 +03:00
Akihiro Motoki
9151d75cc4 [contributor] Update guideline of RST reference
Sphinx allows separate reference definition, but it is not translator
friendly because translators cannot control links (for example,
they may want to use links to translated documents), so we recommend
not to use separate reference definitions.

This convention is already applied in reviews but not documented so far.

References:
ML discussion: http://lists.openstack.org/pipermail/openstack-docs/2015-November/007955.html
Networking guide changes: https://review.openstack.org/#/c/301265/

Change-Id: I0ed77e57f3442d962deed3fca01e7a4a7c11ab04
2016-06-22 15:26:06 +09:00
Christian Berendt
1886fd6f4f [contributor] add a note about the preferred image format
Change-Id: I127e1cb31f7258be5a3fac21ed61631665cf7f50
2016-04-12 06:56:57 +02: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
Nguyen Tuong Thanh
9656daf06a Update 'code-block' rst syntax in Inline elements guide.
This patch marks the explicit as ini for 'code-block' syntax in
Inline elements guide.

Change-Id: I8f177df7eeba103474e93f8e43621638353d30f5
2016-03-15 10:22:06 +07:00
KATO Tomoyuki
5772d6c50f [contributor] Add note about command example
To reduce a scatter, standardize the command example notation.
Also, the standard simplifies description.

Related discussion at mailing list:
http://lists.openstack.org/pipermail/openstack-docs/2015-December/008124.html

Change-Id: I5968564539f2345c523b629d3b970f3c12b8718b
2016-01-01 10:58:08 +09:00
venkatamahesh
cbc640f208 Fix spelling of "rows"
Change-Id: I1a74243b8865c1aa2b6a1e1d2982c565756483b9
2015-12-21 09:27:09 +05:30
Gauvain Pocentek
1dff24428b Document the custom remote-code-block directive
Change-Id: I8fdea3aa262e2b1e86849ba61195af6babefe2bf
2015-12-03 21:04:45 +01:00
KATO Tomoyuki
ce81edc685 [contributor] Change RST inline markup conventions
:program:` ` markup is not widely used at our docs.
This convention become an inconsistency.
Also, this markup doesn't help translators.

Some discussion on docs mailing list:
http://lists.openstack.org/pipermail/openstack-docs/2015-November/007892.html

Change-Id: I7efd24efc626ebfc5d73a2f23a1ee5e7ddfc00a4
2015-11-22 09:44:46 +00: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
KATO Tomoyuki
047b00f2dc [contributor] Change RST term markup example
To show a variety of markup examples, update the example.

Change-Id: Ib1027b2004bc937b6c636b449258f01f76f575b6
2015-11-05 12:58:55 +09:00
Jenkins
675941efe7 Merge "[contributor] Fix guilabel markup example" 2015-11-02 13:47:13 +00:00
KATO Tomoyuki
555641b681 [contributor] Remove Fedora from install guides
Change-Id: I55159f422e85347ca0927d295946ea51a09e37fe
2015-11-01 23:51:31 +09:00
KATO Tomoyuki
c78e22861b [contributor] Fix guilabel markup example
The guilabel markup should contain the strings only
that are shown in the GUI element.

Change-Id: Idc62e2975f4a124b1966dc298481500ec3dd7f3e
2015-11-01 07:54:19 +09:00
KATO Tomoyuki
cf757faa04 [Contributor Guide] Add glossary
* add output example of glossary term directive
* add common directory for glossary
* configure exclude_patterns for the unnecessary files

Change-Id: I8c6057246ed03110e30b0693af8cdecb2c66d589
Depends-On: I08568fb37755109552edf9692b8f259660550a69
Implements: blueprint docs-contributor-guide
2015-10-22 20:57:27 +09:00
OlgaGusarenko
c10da1ec38 [Contributor Guide] RST section finished
1. Adds the following subsections:
   * Introduction to RST
   * Tables
   * Images
   * Profiling
   * Lists
   * Inline markups
   * Decorations
   * Commenting
2. Restructures the toc
3. Creates separate files for each subsection included in the
RST-related folder for simpler maintenance.

Change-Id: I08568fb37755109552edf9692b8f259660550a69
2015-10-20 11:14:32 +03:00