From cda4f9e43129d14e99433198977f32264c2e78df Mon Sep 17 00:00:00 2001 From: Felipe Monteiro Date: Thu, 17 May 2018 19:16:43 +0100 Subject: [PATCH] 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 | 4 ++-- {docs => doc}/requirements.txt | 0 {docs => doc}/source/HACKING.rst | 0 {docs => doc}/source/_static/.placeholder | 0 {docs => doc}/source/api_client.rst | 2 +- {docs => doc}/source/api_ref.rst | 0 {docs => doc}/source/conf.py | 0 {docs => doc}/source/document-types.rst | 0 {docs => doc}/source/documents.rst | 0 {docs => doc}/source/exceptions.rst | 0 {docs => doc}/source/getting-started.rst | 0 {docs => doc}/source/glossary.rst | 0 {docs => doc}/source/index.rst | 0 {docs => doc}/source/layering.rst | 0 {docs => doc}/source/overview.rst | 0 {docs => doc}/source/policy-enforcement.rst | 0 {docs => doc}/source/releasenotes | 0 {docs => doc}/source/replacement.rst | 14 +++++++------- {docs => doc}/source/revision-history.rst | 0 {docs => doc}/source/substitution.rst | 0 {docs => doc}/source/testing.rst | 0 {docs => doc}/source/validation.rst | 4 ++-- tox.ini | 11 +++++------ 23 files changed, 17 insertions(+), 18 deletions(-) rename {docs => doc}/requirements.txt (100%) rename {docs => doc}/source/HACKING.rst (100%) rename {docs => doc}/source/_static/.placeholder (100%) rename {docs => doc}/source/api_client.rst (98%) rename {docs => doc}/source/api_ref.rst (100%) rename {docs => doc}/source/conf.py (100%) rename {docs => doc}/source/document-types.rst (100%) rename {docs => doc}/source/documents.rst (100%) rename {docs => doc}/source/exceptions.rst (100%) rename {docs => doc}/source/getting-started.rst (100%) rename {docs => doc}/source/glossary.rst (100%) rename {docs => doc}/source/index.rst (100%) rename {docs => doc}/source/layering.rst (100%) rename {docs => doc}/source/overview.rst (100%) rename {docs => doc}/source/policy-enforcement.rst (100%) rename {docs => doc}/source/releasenotes (100%) rename {docs => doc}/source/replacement.rst (96%) rename {docs => doc}/source/revision-history.rst (100%) rename {docs => doc}/source/substitution.rst (100%) rename {docs => doc}/source/testing.rst (100%) rename {docs => doc}/source/validation.rst (98%) diff --git a/.gitignore b/.gitignore index 34420bd7..4289d053 100644 --- a/.gitignore +++ b/.gitignore @@ -67,8 +67,8 @@ instance/ .scrapy # Sphinx documentation -docs/_build/ -docs/source/_static/ +doc/_build/ +doc/source/_static/ # PyBuilder target/ diff --git a/docs/requirements.txt b/doc/requirements.txt similarity index 100% rename from docs/requirements.txt rename to doc/requirements.txt diff --git a/docs/source/HACKING.rst b/doc/source/HACKING.rst similarity index 100% rename from docs/source/HACKING.rst rename to doc/source/HACKING.rst diff --git a/docs/source/_static/.placeholder b/doc/source/_static/.placeholder similarity index 100% rename from docs/source/_static/.placeholder rename to doc/source/_static/.placeholder diff --git a/docs/source/api_client.rst b/doc/source/api_client.rst similarity index 98% rename from docs/source/api_client.rst rename to doc/source/api_client.rst index d826136f..61dedca0 100644 --- a/docs/source/api_client.rst +++ b/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 diff --git a/docs/source/api_ref.rst b/doc/source/api_ref.rst similarity index 100% rename from docs/source/api_ref.rst rename to doc/source/api_ref.rst diff --git a/docs/source/conf.py b/doc/source/conf.py similarity index 100% rename from docs/source/conf.py rename to doc/source/conf.py diff --git a/docs/source/document-types.rst b/doc/source/document-types.rst similarity index 100% rename from docs/source/document-types.rst rename to doc/source/document-types.rst diff --git a/docs/source/documents.rst b/doc/source/documents.rst similarity index 100% rename from docs/source/documents.rst rename to doc/source/documents.rst diff --git a/docs/source/exceptions.rst b/doc/source/exceptions.rst similarity index 100% rename from docs/source/exceptions.rst rename to doc/source/exceptions.rst diff --git a/docs/source/getting-started.rst b/doc/source/getting-started.rst similarity index 100% rename from docs/source/getting-started.rst rename to doc/source/getting-started.rst diff --git a/docs/source/glossary.rst b/doc/source/glossary.rst similarity index 100% rename from docs/source/glossary.rst rename to doc/source/glossary.rst diff --git a/docs/source/index.rst b/doc/source/index.rst similarity index 100% rename from docs/source/index.rst rename to doc/source/index.rst diff --git a/docs/source/layering.rst b/doc/source/layering.rst similarity index 100% rename from docs/source/layering.rst rename to doc/source/layering.rst diff --git a/docs/source/overview.rst b/doc/source/overview.rst similarity index 100% rename from docs/source/overview.rst rename to doc/source/overview.rst diff --git a/docs/source/policy-enforcement.rst b/doc/source/policy-enforcement.rst similarity index 100% rename from docs/source/policy-enforcement.rst rename to doc/source/policy-enforcement.rst diff --git a/docs/source/releasenotes b/doc/source/releasenotes similarity index 100% rename from docs/source/releasenotes rename to doc/source/releasenotes diff --git a/docs/source/replacement.rst b/doc/source/replacement.rst similarity index 96% rename from docs/source/replacement.rst rename to doc/source/replacement.rst index c323dda4..30fe58af 100644 --- a/docs/source/replacement.rst +++ b/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: diff --git a/docs/source/revision-history.rst b/doc/source/revision-history.rst similarity index 100% rename from docs/source/revision-history.rst rename to doc/source/revision-history.rst diff --git a/docs/source/substitution.rst b/doc/source/substitution.rst similarity index 100% rename from docs/source/substitution.rst rename to doc/source/substitution.rst diff --git a/docs/source/testing.rst b/doc/source/testing.rst similarity index 100% rename from docs/source/testing.rst rename to doc/source/testing.rst diff --git a/docs/source/validation.rst b/doc/source/validation.rst similarity index 98% rename from docs/source/validation.rst rename to doc/source/validation.rst index 37434e5f..165b95e1 100644 --- a/docs/source/validation.rst +++ b/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. diff --git a/tox.ini b/tox.ini index 28e688f8..faf991c1 100644 --- a/tox.ini +++ b/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