Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs improvements #426

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/examples/plugin.spec
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/source/advance_features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/baremetal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cloud-config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contribute.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down