![Pranav Salunke](/assets/img/avatar_default.png)
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
1.3 KiB
1.3 KiB
Conventions
The OpenStack documentation uses several typesetting conventions.
Notices
Notices take these forms:
Note
A comment with additional information that explains a part of the text.
Important
Something you must be aware of before proceeding.
Tip
An extra but helpful piece of practical advice.
Caution
Helpful information that prevents the user from making mistakes.
Warning
Critical information about the risk of data loss or security issues.
Command prompts
$ command
Any user, including the root
user, can run commands that
are prefixed with the $
prompt.
# command
The root
user must run commands that are prefixed with
the #
prompt. You can also prefix these commands with the
sudo
command, if
available, to run them.