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>
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
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
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
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
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
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
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 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>
* 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
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