Remove obsolete rstbash and '.. path'

The rst2bash tool used the ".. path" syntax to update files. Since we're
not using rst2bash anymore, remove all of this.

Remove also the rst2bash documentation.

Change-Id: I7195cd3b566e9bac67452ec5174687e734fb53bc
This commit is contained in:
Andreas Jaeger 2018-10-16 21:20:04 +02:00
parent 0349383d3d
commit f80792b1ce
9 changed files with 1 additions and 81 deletions

View File

@ -37,7 +37,6 @@ use simpler formatting.
rst-conv/tables.rst
rst-conv/figures.rst
rst-conv/profiling.rst
rst-conv/rst2bash.rst
rst-conv/comment.rst
rst-conv/decorations.rst

View File

@ -1,55 +0,0 @@
=============
Parser syntax
=============
Installation guide is parsed directly into Bash code which will be using
training labs to deploy OpenStack cluster. This should allow us to have
higher agility for developing installation guides and to automatically
test changes to the guides.
There are many factors that could lead to execution errors on the install
guides, but one of the main potential sources of errors relies on the
limitations of the human eye. The problem becomes specially important
with the addition of project-specific installation guides.
Additionally, the parser is also enabled with linting capabilities which
should provide some sort of syntax niceness and validate if the document
is having the correct syntax for the scope of the parser to successfully
parse RST to Bash.
To help the parser to validate the document, consider the following
syntax format.
* The ``code-block`` tags should be closed with ``end``.
.. code-block:: rst
.. code-block:: console
$ echo "Hello, World!"
* The ``code-block`` tags which rely on path should have ``path``
tag one line above without a line break as shown below. May it
be some code which has to be run from a specific folder or a
configuration file, the parser should know about the path.
* Example 1: Run a specific command from a given folder.
.. code-block:: rst
.. path /usr/local/
.. code-block:: console
$ echo "Run a command from a specific folder"
$ chmod -R +rx bin
* Example 2: Configure a configuration file.
.. code-block:: rst
.. path /etc/keystone/keystone.conf
.. code-block:: ini
[DEFAULT]
...
debug = True

View File

@ -28,17 +28,7 @@ in one programming language within one file. By default, the code-block
formatted this way is shown in a Python highlighting mode.
To define another highlighting language, use the ``code-block`` directive
as described in the :ref:`non-standard-block` section. Make sure to close these
tags with ``end``. Additionally, add the ``path`` tag to provide the parser
with the path of the configuration files. This should allow the parser to parse
the markup syntax to Bash.
.. note::
The ``end`` tag allows the parser to identify the scope of code blocks.
The ``path`` tag allows the parser to identify the path of the config
file. For more information, refer to the :doc:`rst2bash` section.
These changes are mandatory only for the installation guides.
as described in the :ref:`non-standard-block` section.
**Input**
@ -81,7 +71,6 @@ files, ``console`` for console inputs and outputs, and so on.
.. code-block:: rst
.. path /path/to/config/file
.. code-block:: ini
# Configuration for nova-rootwrap
@ -167,7 +156,6 @@ content from a remote URL (``http`` or ``https``).
.. code-block:: rst
.. path /path/to/config/file
.. remote-code-block:: ini
https://git.openstack.org/cgit/openstack/nova/tree/etc/nova/api-paste.ini?h=stable/ocata

View File

@ -27,7 +27,6 @@ Configure network interfaces
* Edit the ``/etc/network/interfaces`` file to contain the following:
.. path /etc/network/interfaces
.. code-block:: bash
# The provider network interface
@ -43,7 +42,6 @@ Configure network interfaces
Do not change the ``HWADDR`` and ``UUID`` keys.
.. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME
.. code-block:: bash
DEVICE=INTERFACE_NAME
@ -56,7 +54,6 @@ Configure network interfaces
* Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following:
.. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME
.. code-block:: bash
STARTMODE='auto'

View File

@ -23,7 +23,6 @@ Configure network interfaces
* Edit the ``/etc/network/interfaces`` file to contain the following:
.. path /etc/network/interfaces
.. code-block:: bash
# The provider network interface
@ -39,7 +38,6 @@ Configure network interfaces
Do not change the ``HWADDR`` and ``UUID`` keys.
.. path /etc/sysconfig/network-scripts/ifcfg-INTERFACE_NAME
.. code-block:: ini
DEVICE=INTERFACE_NAME
@ -52,7 +50,6 @@ Configure network interfaces
* Edit the ``/etc/sysconfig/network/ifcfg-INTERFACE_NAME`` file to
contain the following:
.. path /etc/sysconfig/network/ifcfg-INTERFACE_NAME
.. code-block:: ini
STARTMODE='auto'

View File

@ -34,14 +34,12 @@ Install and configure components
For RHEL, CentOS, or SUSE, edit the ``/etc/chrony.conf`` file:
.. path /etc/chrony.conf
.. code-block:: ini
server NTP_SERVER iburst
For Ubuntu, edit the ``/etc/chrony/chrony.conf`` file:
.. path /etc/chrony/chrony.conf
.. code-block:: ini
server NTP_SERVER iburst

View File

@ -35,14 +35,12 @@ Install and configure components
For RHEL, CentOS, or SUSE, edit the ``/etc/chrony.conf`` file:
.. path /etc/chrony.conf
.. code-block:: ini
server controller iburst
For Ubuntu, edit the ``/etc/chrony/chrony.conf`` file:
.. path /etc/chrony/chrony.conf
.. code-block:: ini
server controller iburst

View File

@ -25,7 +25,6 @@ Install and configure components
additional keys to enable useful options and the UTF-8
character set:
.. path /etc/my.cnf.d/openstack.cnf
.. code-block:: ini
[mysqld]

View File

@ -1,6 +1,5 @@
Edit the ``/etc/hosts`` file to contain the following:
.. path /etc/hosts
.. code-block:: none
# controller