Rename docs to doc to align with OpenStack standard

This patchset updates docs to doc to align with OpenStack
standard. Follow-up patchset will be needed to publish
documentation to OpenStack [0].

[0] https://docs.openstack.org/doc-contrib-guide/project-guides.html

Change-Id: Ia191ac1cc4536af1232aedd4bb491f3829651730

.gitignore

@@ -67,8 +67,8 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
-docs/source/_static/
+doc/_build/
+doc/source/_static/
 
 # PyBuilder
 target/

doc/source/api_client.rst

@@ -55,7 +55,7 @@ plugins:
     auth = v3.Token(**keystone_auth)
     deckhandclient = client.Client(auth=auth)
 
-Which will allow you to authenticate using a pre-exsting, project-scoped
+Which will allow you to authenticate using a pre-existing, project-scoped
 token.
 
 Alternatively, you can use non-session authentication to instantiate the

doc/source/replacement.rst

@@ -77,7 +77,7 @@ The following result in validation errors:
 * A document with ``replacement: true`` doesn't have a parent.
 * A document with ``replacement: true`` doesn't have the same
   ``metadata.name`` and ``schema`` as its parent.
-* A replacement document cannot iself be replaced. That is, only one level
+* A replacement document cannot itself be replaced. That is, only one level
   of replacement is allowed.
 
 Note that each key in the examples below is *mandatory* and that the
@@ -91,7 +91,7 @@ Document **replacer** (child):
   # Note that the schema and metadata.name keys are the same as below.
   schema: armada/Chart/v1
   metadata:
-    name: ucp-deckhand
+    name: airship-deckhand
     # The replacement: true key is mandatory.
     replacement: true
     layeringDefinition:
@@ -114,7 +114,7 @@ Which replaces the document **replacee** (parent):
   # Note that the schema and metadata.name keys are the same as above.
   schema: armada/Chart/v1
   metadata:
-    name: ucp-deckhand
+    name: airship-deckhand
     labels:
       selector: foo
     layeringDefinition:
@@ -140,7 +140,7 @@ To achieve this, two top-layer documents can be created:
   ---
   schema: armada/Chart/v1
   metadata:
-    name: ucp-deckhand-1
+    name: airship-deckhand-1
     layeringDefinition:
       layer: global
       ...
@@ -156,7 +156,7 @@ And:
   ---
   schema: armada/Chart/v1
   metadata:
-    name: ucp-deckhand-2
+    name: airship-deckhand-2
     layeringDefinition:
       layer: global
       ...
@@ -183,7 +183,7 @@ For example:
   ---
   schema: armada/Chart/v1
   metadata:
-    name: ucp-deckhand
+    name: airship-deckhand
     replacement: true
     layeringDefinition:
       layer: site
@@ -206,7 +206,7 @@ And:
   ---
   schema: armada/Chart/v1
   metadata:
-    name: ucp-deckhand
+    name: airship-deckhand
     labels:
       selector: foo
     layeringDefinition:

doc/source/validation.rst

@@ -171,7 +171,7 @@ Carried out during document ingestion.
 
 For pre-rendering validation 3 types of behavior are possible:
 
-#. Successfully validated docuemnts are stored in Deckhand's database.
+#. Successfully validated documents are stored in Deckhand's database.
 #. Failure to validate a document's basic properties will result in a 400
    Bad Request error getting raised.
 #. Failure to validate a document's schema-specific properties will result
@@ -185,7 +185,7 @@ Carried out after rendering all documents.
 
 For post-rendering validation, 2 types of behavior are possible:
 
-#. Successfully valdiated post-rendered documents are returned to the user.
+#. Successfully validated post-rendered documents are returned to the user.
 #. Failure to validate post-rendered documents results in a 500 Internal Server
    Error getting raised.
 

tox.ini

@@ -94,7 +94,6 @@ commands =
   # Run security linter as part of the pep8 gate instead of using separate job.
   bandit -r deckhand -x deckhand/tests -n 5
 
-
 [flake8]
 # [H106] Don’t put vim configuration in source files.
 # [H203] Use assertIs(Not)None to check for None.
@@ -104,23 +103,23 @@ commands =
 # [H904] Delay string interpolations at logging calls.
 enable-extensions = H106,H203,H204,H205,H210,H904
 ignore = H405
-exclude =  .venv,.git,.tox,dist,*lib/python*,*egg,build,releasenotes,docs,alembic/versions
+exclude =  .venv,.git,.tox,dist,*lib/python*,*egg,build,releasenotes,doc,alembic/versions
 
 [testenv:docs]
 deps =
   -r{toxinidir}/requirements.txt
-  -r{toxinidir}/docs/requirements.txt
+  -r{toxinidir}/doc/requirements.txt
 commands =
-  rm -rf docs/build
+  rm -rf doc/build
   rm -rf releasenotes/build
-  sphinx-build -W -b html docs/source docs/build/html
+  sphinx-build -W -b html doc/source doc/build/html
 whitelist_externals =
   rm
 
 [testenv:releasenotes]
 deps =
   -r{toxinidir}/requirements.txt
-  -r{toxinidir}/docs/requirements.txt
+  -r{toxinidir}/doc/requirements.txt
 commands =
   rm -rf releasenotes/build
   sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html