Fix doc style issues and fix some typos
Removes yaml as a type of the code-block as the rendered text was hardly readable. Removes shell-session type of the code-block in case of showing cat output - the output wasn't rendered at all. Removes emphasize-lines as the emphasized lines were too bright and therefore not readable - I found there are issues with openstackdocstheme and Sphinx 3 [1] and I didn't find any simple solutions - fixing just a few highlighted lines is not worth it. A few typos were fixed as well. [1] https://bugs.launchpad.net/openstack-doc-tools/+bug/1876343 Trying if rebuilding the doc solves the rendering issue: https://docs.openstack.org/python-tempestconf/latest/user/usage.html Change-Id: I83ebfdeb949bd0a6cfa99889cb9fbb56d8bcb218
This commit is contained in:
parent
0cd2cec87a
commit
444e826923
@ -71,7 +71,7 @@ used, `see here`_. The generated accounts file will look similarly to this one:
|
|||||||
|
|
||||||
.. _see here: ../user/usage.html#usage-with-tempest-accounts-file
|
.. _see here: ../user/usage.html#usage-with-tempest-accounts-file
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block::
|
||||||
|
|
||||||
$ cat ~/accounts.yaml
|
$ cat ~/accounts.yaml
|
||||||
# A minimal accounts.yaml file
|
# A minimal accounts.yaml file
|
||||||
|
@ -43,8 +43,8 @@ Fixing bugs
|
|||||||
|
|
||||||
1. If you have found a bug and you know how to fix it, please, check our
|
1. If you have found a bug and you know how to fix it, please, check our
|
||||||
`storyboard project <https://storyboard.openstack.org/#!/project/912>`_ for
|
`storyboard project <https://storyboard.openstack.org/#!/project/912>`_ for
|
||||||
any stories which may relate to the issue. If you haven't find any related
|
any stories which may relate to the issue. If you haven't found any related
|
||||||
story, please, create one. Check `Reporting Bugs`_.
|
stories, please, create one. Check `Reporting Bugs`_.
|
||||||
|
|
||||||
2. Follow `Contributing Code`_ and submit a code review in
|
2. Follow `Contributing Code`_ and submit a code review in
|
||||||
https://review.opendev.org/.
|
https://review.opendev.org/.
|
||||||
|
@ -29,7 +29,7 @@ Generating a sample profile.yaml file
|
|||||||
|
|
||||||
$ discover-tempest-config --generate-profile ./etc/profile.yaml
|
$ discover-tempest-config --generate-profile ./etc/profile.yaml
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block::
|
||||||
|
|
||||||
$ cat ./etc/profile.yaml
|
$ cat ./etc/profile.yaml
|
||||||
collect_timing: false
|
collect_timing: false
|
||||||
@ -107,7 +107,7 @@ Generating a sample profile.yaml file
|
|||||||
``python-tempestconf`` accepts both of the following inputs, so you can use
|
``python-tempestconf`` accepts both of the following inputs, so you can use
|
||||||
what suits you better, either strings or lists:
|
what suits you better, either strings or lists:
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block::
|
||||||
|
|
||||||
create: True
|
create: True
|
||||||
out: ./etc/tempest.conf
|
out: ./etc/tempest.conf
|
||||||
@ -124,7 +124,7 @@ what suits you better, either strings or lists:
|
|||||||
volume-feature-enabled.api_extensions: dvr,mine
|
volume-feature-enabled.api_extensions: dvr,mine
|
||||||
|
|
||||||
|
|
||||||
.. code-block:: yaml
|
.. code-block::
|
||||||
|
|
||||||
create: True
|
create: True
|
||||||
out: ./etc/tempest.conf
|
out: ./etc/tempest.conf
|
||||||
|
@ -27,7 +27,7 @@ step **as a prerequisite**:
|
|||||||
* Source your OpenStack RC file containing the cloud credentials. Let's say
|
* Source your OpenStack RC file containing the cloud credentials. Let's say
|
||||||
you have an overcloud_rc file with the following content:
|
you have an overcloud_rc file with the following content:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block::
|
||||||
|
|
||||||
$ cat overcloud_rc
|
$ cat overcloud_rc
|
||||||
unset OS_SERVICE_TOKEN
|
unset OS_SERVICE_TOKEN
|
||||||
@ -61,8 +61,7 @@ Override values can be useful when a user wants to set a key-value pair in
|
|||||||
generated ``tempest.conf`` from one of the two following reasons:
|
generated ``tempest.conf`` from one of the two following reasons:
|
||||||
|
|
||||||
* ``python-tempestconf`` is **not** able to discover it and therefore set the
|
* ``python-tempestconf`` is **not** able to discover it and therefore set the
|
||||||
desired
|
desired key-value pair in ``tempest.conf`` by itself
|
||||||
key-value pair in ``tempest.conf`` by itself
|
|
||||||
* ``python-tempestconf`` is able to discover it, but a user wants to set it
|
* ``python-tempestconf`` is able to discover it, but a user wants to set it
|
||||||
differently
|
differently
|
||||||
|
|
||||||
@ -75,7 +74,6 @@ set that ``tempest.conf`` will be written to ``etc/`` directory and we pass
|
|||||||
some override values.
|
some override values.
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block:: shell-session
|
||||||
:emphasize-lines: 4-6
|
|
||||||
|
|
||||||
$ discover-tempest-config \
|
$ discover-tempest-config \
|
||||||
--debug \
|
--debug \
|
||||||
@ -92,7 +90,7 @@ some override values.
|
|||||||
|
|
||||||
The generated ``tempest.conf`` will look like:
|
The generated ``tempest.conf`` will look like:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block::
|
||||||
|
|
||||||
$ cat etc/tempest.conf
|
$ cat etc/tempest.conf
|
||||||
<omitted some content>
|
<omitted some content>
|
||||||
@ -210,7 +208,6 @@ If you already have the file created, you can run
|
|||||||
:command:`discover-tempest-config` command with ``--test-accounts`` argument:
|
:command:`discover-tempest-config` command with ``--test-accounts`` argument:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block:: shell-session
|
||||||
:emphasize-lines: 3
|
|
||||||
|
|
||||||
$ discover-tempest-config \
|
$ discover-tempest-config \
|
||||||
--out etc/tempest.conf \
|
--out etc/tempest.conf \
|
||||||
@ -218,7 +215,7 @@ If you already have the file created, you can run
|
|||||||
|
|
||||||
The generated ``tempest.conf`` will look like:
|
The generated ``tempest.conf`` will look like:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block::
|
||||||
|
|
||||||
$ cat etc/tempest.conf
|
$ cat etc/tempest.conf
|
||||||
<omitted some content>
|
<omitted some content>
|
||||||
@ -237,7 +234,6 @@ If your credentials are **non-admin ones**, which means that you are
|
|||||||
will **not create** any resources.
|
will **not create** any resources.
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block:: shell-session
|
||||||
:emphasize-lines: 4
|
|
||||||
|
|
||||||
$ discover-tempest-config \
|
$ discover-tempest-config \
|
||||||
-v \
|
-v \
|
||||||
@ -258,7 +254,7 @@ it can be found
|
|||||||
Let's say there is a ``clouds.yaml`` file located in ``/etc/openstack/`` with
|
Let's say there is a ``clouds.yaml`` file located in ``/etc/openstack/`` with
|
||||||
the following content:
|
the following content:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block::
|
||||||
|
|
||||||
$ cat /etc/openstack/clouds.yaml
|
$ cat /etc/openstack/clouds.yaml
|
||||||
clouds:
|
clouds:
|
||||||
@ -282,7 +278,6 @@ variable (for example by sourcing any OpenStack RC file).
|
|||||||
file.
|
file.
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block:: shell-session
|
||||||
:emphasize-lines: 3
|
|
||||||
|
|
||||||
$ discover-tempest-config \
|
$ discover-tempest-config \
|
||||||
--debug \
|
--debug \
|
||||||
@ -291,7 +286,6 @@ file.
|
|||||||
So the call from `non-admin argument`_ section would for example look like:
|
So the call from `non-admin argument`_ section would for example look like:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block:: shell-session
|
||||||
:emphasize-lines: 5
|
|
||||||
|
|
||||||
$ discover-tempest-config \
|
$ discover-tempest-config \
|
||||||
-v \
|
-v \
|
||||||
@ -303,7 +297,6 @@ The call from `Usage with tempest accounts file`_ section would for example
|
|||||||
look like:
|
look like:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block:: shell-session
|
||||||
:emphasize-lines: 2
|
|
||||||
|
|
||||||
$ discover-tempest-config \
|
$ discover-tempest-config \
|
||||||
--os-cloud devstack \
|
--os-cloud devstack \
|
||||||
@ -330,7 +323,7 @@ Users
|
|||||||
+++++
|
+++++
|
||||||
|
|
||||||
For a successful execution of Tempest at least two users need to be created
|
For a successful execution of Tempest at least two users need to be created
|
||||||
(the default concurrency is 2). Therefor ``python-tempestconf`` looks for
|
(the default concurrency is 2). Therefore ``python-tempestconf`` looks for
|
||||||
the following two users:
|
the following two users:
|
||||||
|
|
||||||
* the user who started ``python-tempestconf``
|
* the user who started ``python-tempestconf``
|
||||||
@ -370,8 +363,8 @@ to glance and used later by tempest tests for booting VMs.
|
|||||||
|
|
||||||
The following example will upload ``/my/path/to/myImage.img`` image to glance
|
The following example will upload ``/my/path/to/myImage.img`` image to glance
|
||||||
twice. First **compute.image_ref** will be equal to the ID of the uploaded
|
twice. First **compute.image_ref** will be equal to the ID of the uploaded
|
||||||
image. Then the image is uploaded to glance again and but
|
image. Then the image is uploaded to glance again but
|
||||||
**compute.image_alt_ref** is set to that corresponding ID:
|
**compute.image_alt_ref** is set to the new corresponding ID:
|
||||||
|
|
||||||
.. code-block:: shell-session
|
.. code-block:: shell-session
|
||||||
|
|
||||||
@ -463,7 +456,7 @@ following example:
|
|||||||
|
|
||||||
The generated tempest.conf will look like:
|
The generated tempest.conf will look like:
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block::
|
||||||
|
|
||||||
$ cat etc/tempest.conf
|
$ cat etc/tempest.conf
|
||||||
<omitted some content>
|
<omitted some content>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user