Fix typos

This patch set fixes a handful of typographical errors in the documents.

Change-Id: Ie499519fbbcfdb080877ac434ccce8fc38141854
This commit is contained in:
Tin Lam 2018-01-20 02:32:54 -06:00
parent cacc84a1b0
commit a7607d46ac
9 changed files with 21 additions and 21 deletions

View File

@ -12,8 +12,8 @@ Commands
This command install and updates charts defined in armada manifest
The apply argument must be relative path to Armada Manifest. Executing
apply commnad once will install all charts defined in manifest. Re-
executing apply commnad will execute upgrade.
apply command once will install all charts defined in manifest. Re-
executing apply command will execute upgrade.
To see how to create an Armada manifest:
http://armada-helm.readthedocs.io/en/latest/operations/
@ -48,13 +48,13 @@ Synopsis
--------
The apply command will consume an armada manifest which contains group of charts
that it will deploy into the tiller service in your kubernetes cluster.
Executing the ``armada apply`` again on existing armada deployement will start
that it will deploy into the tiller service in your Kubernetes cluster.
Executing the ``armada apply`` again on existing armada deployment will start
an update of the armada deployed charts.
``amada apply armada-manifest.yaml [--debug-logging]``
``armada apply armada-manifest.yaml [--debug-logging]``
If you remove ``armada/Charts/v1`` from the ``armada/ChartGroups/v1`` in the armada
manifest and exectute an ``armada apply`` with the ``--enable-chart-cleanup`` flag.
manifest and execute an ``armada apply`` with the ``--enable-chart-cleanup`` flag.
Armada will remove undefined releases with the armada manifest's
``release_prefix`` keyword.

View File

@ -13,7 +13,7 @@ Commands
The tiller command uses flags to obtain information from tiller services.
The test command will run the release chart tests either via a
manifest or by targeting a relase.
manifest or by targeting a release.
To obtain armada deployed releases:

View File

@ -21,5 +21,5 @@ Commands
Synopsis
--------
The validate commad will take in a armada manifest and will validate if its
correctly defined and comsumable.
The validate command will take in an Armada manifest and will validate if it is
correctly defined and consumable.

View File

@ -5,7 +5,7 @@ Development
Docker
######
To use the docker containter to develop:
To use the docker container to develop:
1. Fork the `Repository <http://github.com/att-comdev/armada>`_
2. Clone the forked repo

View File

@ -201,7 +201,7 @@ Responses
**200**
^^^^^^^
Succesfull installation/update of manifest
Successful installation/update of manifest
**Example:**
@ -326,7 +326,7 @@ Responses
**200**
^^^^^^^
Succesfully Test of manifest
Successful Test of manifest
**Example:**

View File

@ -107,7 +107,7 @@ Chart
+-----------------+----------+---------------------------------------------------------------------------------------+
| dependencies | object | reference any chart dependencies before install |
+-----------------+----------+---------------------------------------------------------------------------------------+
| timeout | int | time (in seconds) allotted for chart to deploy when 'wait' flag is set (DEPRICATED) |
| timeout | int | time (in seconds) allotted for chart to deploy when 'wait' flag is set (DEPRECATED) |
+-----------------+----------+---------------------------------------------------------------------------------------+
Update - Pre or Post
@ -147,7 +147,7 @@ Update - Actions - Update/Delete
+=============+==========+===============================================================+
| name | string | name of action |
+-------------+----------+---------------------------------------------------------------+
| type | string | type of kubernetes workload to execute in scope for action |
| type | string | type of Kubernetes workload to execute in scope for action |
+-------------+----------+---------------------------------------------------------------+
| labels | object | k:v mapping of labels to select Kubernetes resources |
+-------------+----------+---------------------------------------------------------------+
@ -283,14 +283,14 @@ Example
labels:
foo: bar
component: bar
rak1: enababled
rak1: enabled
delete:
- name: test-job
type: job
labels:
foo: bar
component: bar
rak1: enababled
rak1: enabled
values: {}
source:
type: git

View File

@ -69,7 +69,7 @@ Source Exceptions
+--------------------------+---------------------------------------------------------------------+
| TarballExtractException | Occurs when extracting a tarball fails. |
+--------------------------+---------------------------------------------------------------------+
| InvalidPathException | Occurs when a nonexistant path is accessed. |
| InvalidPathException | Occurs when a non-existent path is accessed. |
+--------------------------+---------------------------------------------------------------------+
| ChartSourceException | Occurs when an unknown chart source type is encountered. |
+--------------------------+---------------------------------------------------------------------+

View File

@ -40,8 +40,8 @@ Debugging Checklist:
1. python -c "import ssl; print ssl.OPENSSL_VERSION"
If the version that appers is less than 1.0 then problems will occur, please
update to current or use our docker container solve this issue
If the version that appears is less than 1.0, then problems will occur.
Please update to current or use our docker container solve this issue
2. check your urllib3 version, you could run into urllib3 issues. older versions
of this lib can cause SSL errors run ``pip install --upgrade urllib3`` and it
@ -52,6 +52,6 @@ Debugging Checklist:
Issue
-----
If the issue that you are having does not appear here please check the aramda
If the issue that you are having does not appear here please check the Armada
issues `section <https://github.com/att-comdev/armada/issues>`_. If the issue does
not exist, please create an issue.

View File

@ -62,7 +62,7 @@ b. Helm Install
.. note::
To install Armada via the Helm chart please make sure to provide an Keysonte
To install Armada via the Helm chart please make sure to provide a Keystone
endpoint
.. code:: bash