Commit Graph

9 Commits

Author SHA1 Message Date
Jenkins
61671ce046 Merge "[install-guide] Minor edits to the env chap of the ubuntu guide" 2017-01-30 04:30:54 +00:00
KATO Tomoyuki
7a3e88d964 [install] use https instead of http for docs.o.o
Change-Id: Id1890a5b17ab31ea898677264de44e37a4da6a2f
backport: newton
2017-01-27 23:19:07 +09:00
Alexandra Settle
9707681803 [install-guide] Minor edits to the env chap of the ubuntu guide
Change-Id: I48c738e7b5f4b2ce3a9d441e65617e1afd9a8892
2017-01-27 09:57:21 +00:00
Pranav Salunke
de38f2767f install: Updates syntax for training labs parser.
Training labs parser will allow us to automatically parse RST code
to BASH. This BASH code in turn will be invoked by install-guides for
validating the install guides. To provide the correct information to the
parser for generating BASH code, there are a few changes required to the
RST syntax.

Introduces the following changes to RST syntax:

  - `.. end`

    This tag provides information for the parser to stop extracting the
    given block which could be code, file injection or configuration
    file edit.

  - `.. endonly`

    This tag provides information for the parser with the correct
    distro-switch logic for identifying distro-specific code.

    For .. only:: tags, it is better to avoid nesting. If nesting
    is not avoidable then it is preferable to add the .. endonly
    tag to close the outer block immediately.

  - Extra new lines in code-blocks

    Some commands in the code-blocks provides the expected output of the
    given command. This is not a BASH command which we want to run but
    rather some visual niceness for the users. These new lines provides
    the parser information to identify the end of the command. This
    basic logic would be something similar to find '\r\n' which at least
    for python means new empty line.

  - `mysql>`

    Introducing this operator for mysql commands. This could potentially
    be changed to `pgsql>` or similar for other SQL type databases.
    This allows the parser to identify mysql commands and then run
    them in mysql instead of in 'sh' or 'bash'.

  - `.. path`

    Introducing this tag to provide the parser with the information with
    the path of the configuration file. Using the description text for
    the same is not reliable since the description text may not be
    consistent.

This commit should ideally introduce all the syntax changes required for
the parser to convert the code-blocks in here to BASH code. These
changes should have no impact on the HTML output of the RST code.

Change-Id: I47830b1bc61c8b1a0f3350932d15aa3ce88fa672
2016-09-28 10:58:06 +02:00
KATO Tomoyuki
a05c379f4c [install] remove unused environment variables
Change-Id: I852a74b5278e6fb7c3c2f5257043dc944a7c0fa7
Implements: blueprint installguidenewton
2016-09-27 13:46:04 +09:00
KATO Tomoyuki
55d677c626 [install] remove object storage chapter
For Newton, Object Storage Install Guide lives in openstack/swift repo.

Change-Id: I81069f94f8648dcf2a6f5934416cf5fc4d7a734b
Implements: blueprint projectspecificinstallguides
2016-07-16 19:11:32 +09:00
chenqiaomin
507c190c97 [Admin-guide]Correct the wrong title for cleanup
There should be 'OpenStack Administrator Guide' for the title,
not 'Administrator Guide'.

Change-Id: Ia53fe2c159ea697abd50169966cd7a68f4c18f8d
Closes-Bug: #1584810
2016-05-23 23:46:51 +00:00
venkatamahesh
481637c674 Update the administrator guide links in all guides
Change-Id: Iadb25ffd562a7fa50c0e409b362808a9a4a578c9
2016-04-06 09:11:30 +00:00
Matthew Kassawara
677d910899 [install] Fix environment structure
Address various structure and consistency issues with
environment content.

This patch only addresses the critical structure and
consistency problems that impact usability. A future
patch should address the larger, but less obvious problems
that mostly appeared during the RST conversion.

Change-Id: Iae586b4cc8943abedca3c09820d0fb5370b5a858
Implements: blueprint installguide-liberty
2015-10-05 14:10:11 -05:00