From e366e5be0386c942c7f3561f45f8847f0a700064 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 3 Jul 2024 19:23:34 +0300 Subject: [PATCH 1/6] fix plugin.spec --- docs/examples/plugin.spec | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/examples/plugin.spec b/docs/examples/plugin.spec index fbf187c6a0..89ead677ee 100644 --- a/docs/examples/plugin.spec +++ b/docs/examples/plugin.spec @@ -78,7 +78,7 @@ subparsers: tasks: type: ListOfFileNames help: | - This is example for option which is with type "ListOfFileNames" and has + This is an example for option which is with type "ListOfFileNames" and has auto propagation of "Allowed Values" in help. When we ask for --help it will look in plugin folder for directory name as 'lookup_dir' value, and will add all file names to "Allowed Values" From beaa30ac91470952541fb7e26cb5ae75ac50be29 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 3 Jul 2024 19:24:15 +0300 Subject: [PATCH 2/6] fix advance_features.rst --- docs/source/advance_features.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/advance_features.rst b/docs/source/advance_features.rst index a63b2b357e..ed7fa01d01 100644 --- a/docs/source/advance_features.rst +++ b/docs/source/advance_features.rst @@ -22,7 +22,7 @@ Override playbooks ------------------ In this example we'll use a custom playbook to override our cleanup play and replace it with the process described above. -First, lets create an empty playbook called: ``noop.yml``:: +First, let's create an empty playbook called: ``noop.yml``:: --- - name: Just another empty play From a7837ef4ba9b28608a2c58a3e1fa4e263189b7ba Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 3 Jul 2024 19:38:13 +0300 Subject: [PATCH 3/6] fix baremetal.rst --- docs/source/baremetal.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/baremetal.rst b/docs/source/baremetal.rst index cfba76c1af..df8d545ae7 100644 --- a/docs/source/baremetal.rst +++ b/docs/source/baremetal.rst @@ -33,7 +33,7 @@ Infrared allows to perform baremetal deployments. For baremetal deployments, in order to reflect the real networking, templates should be prepared by the user before the deployment, including ``instackenv.json`` file. - All addition parameters like storage (``ceph`` or ``swift``) disks or any other parameters should be added to the templates as well. + All additional parameters like storage (``ceph`` or ``swift``) disks or any other parameters should be added to the templates as well. .. code:: shell From 398f24a78e4301b14b9ca2188be4be6ad42b8108 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 3 Jul 2024 19:39:54 +0300 Subject: [PATCH 4/6] fix cloud-config.rst --- docs/source/cloud-config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/cloud-config.rst b/docs/source/cloud-config.rst index 4a94eb3640..7101c13403 100644 --- a/docs/source/cloud-config.rst +++ b/docs/source/cloud-config.rst @@ -23,7 +23,7 @@ External Network To create external network we need to specify in ``--tasks`` the task ``create_external_network`` and then use the flags above: * ``--deployment-files``: - Name of folder in cloud's user on undercloud, which containing the templates of the overcloud deployment. + Name of folder in cloud's user on undercloud, which contains the templates of the overcloud deployment. * ``--network-protocol``: The overcloud network backend. * ``--public-net-name``: From 7a9435dcdc07a9412ff58c78a1d42ebcc3a0d5f0 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 3 Jul 2024 19:41:16 +0300 Subject: [PATCH 5/6] fix conf.py --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 6037ee172d..9121c94fce 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -67,7 +67,7 @@ # The full version, including alpha/beta/rc tags. release = __version__ -# The language for content autogenerated by Sphinx. Refer to documentation +# The language for content is autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. From 4d2f27cbe55c0deec4946b72bd8e8f74a3441aa8 Mon Sep 17 00:00:00 2001 From: Elias Rad <146735585+nnsW3@users.noreply.github.com> Date: Wed, 3 Jul 2024 19:41:56 +0300 Subject: [PATCH 6/6] fix contribute.rst --- docs/source/contribute.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst index 2081b97e44..82691b999a 100644 --- a/docs/source/contribute.rst +++ b/docs/source/contribute.rst @@ -29,7 +29,7 @@ Non-RedHat Employees should file pull requests to the `InfraRed project`_ on Git Release Notes ------------- Infrared uses `reno`_ tool for providing release notes. -That means that a patch can include a reno file (release notes) containing detailed description what the impact is. +That means that a patch can include a reno file (release notes) containing detailed description of what the impact is. A reno file is a YAML file written in the releasenotes/notes directory which is generated using the reno tool this way: