From 09f099e5b2c2940a90ced39749fba5e4484a52eb Mon Sep 17 00:00:00 2001 From: Roman Gorshunov Date: Mon, 24 Sep 2018 12:53:27 +0200 Subject: [PATCH] Fix: various documentation and URL fixes 1) UCP -> Airship 2) readthedocs.org -> readthedocs.io (there is redirect) 3) http -> https 4) attcomdev -> airshipit (repo on quay.io) 5) att-comdev -> openstack/airship-* (repo on github/openstack git) 6) many URLs have been verified and adjusted to be current 7) no need for 'en/latest/' path in URL of the RTD 8) added more info to some setup.cfg and setup.py files 9) ucp-integration docs are now in airship-in-a-bottle 10) various other minor fixes Change-Id: I1e2d133a701dc2dade5bfcbdab5c0950cbe7eed5 --- README.rst | 2 +- armada/common/client.py | 2 +- armada/handlers/document.py | 2 +- armada/utils/validation_message.py | 2 +- charts/armada/Chart.yaml | 2 +- doc/source/commands/apply.rst | 2 +- doc/source/operations/documents.rst | 6 +++--- doc/source/operations/guide-troubleshooting.rst | 2 +- doc/source/operations/guide-use-armada.rst | 2 +- setup.cfg | 8 ++++---- tools/gate/playbooks/readthedocs.yaml | 2 +- 11 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 6577e182..e4b9953c 100644 --- a/README.rst +++ b/README.rst @@ -117,5 +117,5 @@ Further Reading .. |Docker Repository on Quay| image:: https://quay.io/repository/airshipit/armada/status :target: https://quay.io/repository/airshipit/armada -.. |Doc Status| image:: https://readthedocs.org/projects/airship-armada/badge/?version=latest +.. |Doc Status| image:: https://readthedocs.io/projects/airship-armada/badge/?version=latest :target: https://airship-armada.readthedocs.io/ diff --git a/armada/common/client.py b/armada/common/client.py index 7d85fc13..779e58a3 100644 --- a/armada/common/client.py +++ b/armada/common/client.py @@ -55,7 +55,7 @@ class ArmadaClient(object): def post_validate(self, manifest=None, timeout=None): endpoint = self._set_endpoint('1.0', 'validatedesign') - # TODO(sh8121att) Look to update the UCP convention to + # TODO(sh8121att) Look to update the Airship convention to # allow a list of hrefs req_body = {'href': manifest} diff --git a/armada/handlers/document.py b/armada/handlers/document.py index 6e98f142..64e7c017 100644 --- a/armada/handlers/document.py +++ b/armada/handlers/document.py @@ -111,7 +111,7 @@ class ReferenceResolver(object): @classmethod def resolve_reference_ucp(cls, design_uri): - """Retrieve artifacts from a UCP service endpoint. + """Retrieve artifacts from a Airship service endpoint. Return a byte array of the response content. Assumes Keystone authentication required. diff --git a/armada/utils/validation_message.py b/armada/utils/validation_message.py index f1105746..22eb9e88 100644 --- a/armada/utils/validation_message.py +++ b/armada/utils/validation_message.py @@ -16,7 +16,7 @@ import json class ValidationMessage(object): - """ ValidationMessage per UCP convention: + """ ValidationMessage per Airship convention: https://airshipit.readthedocs.io/en/latest/api-conventions.html#output-structure # noqa Construction of ValidationMessage message: diff --git a/charts/armada/Chart.yaml b/charts/armada/Chart.yaml index acba5368..8a663efa 100644 --- a/charts/armada/Chart.yaml +++ b/charts/armada/Chart.yaml @@ -18,7 +18,7 @@ name: armada version: 0.1.0 keywords: - armada -home: https://airship-armada.readthedocs.io/en/latest/ +home: https://airship-armada.readthedocs.io/ sources: - https://github.com/openstack/airship-armada engine: gotpl diff --git a/doc/source/commands/apply.rst b/doc/source/commands/apply.rst index c358fe10..fabc895b 100644 --- a/doc/source/commands/apply.rst +++ b/doc/source/commands/apply.rst @@ -16,7 +16,7 @@ Commands executing apply command will execute upgrade. To see how to create an Armada manifest: - https://airshipit.readthedocs.io/projects/armada/en/latest/operations/ + https://airship-armada.readthedocs.io/en/latest/operations/ To install or upgrade charts, run: diff --git a/doc/source/operations/documents.rst b/doc/source/operations/documents.rst index c5f12e19..d660171d 100644 --- a/doc/source/operations/documents.rst +++ b/doc/source/operations/documents.rst @@ -62,10 +62,10 @@ The validation schemas below are used by Armada to validate all ingested Charts, Chart Groups, and Manifests. Use the schemas below as models for authoring Armada documents. -.. _Deckhand DataSchema: https://airshipit.readthedocs.io/projects/deckhand/en/latest/document-types.html?highlight=dataschema#dataschema +.. _Deckhand DataSchema: https://airship-deckhand.readthedocs.io/en/latest/document-types.html?highlight=dataschema#dataschema .. _Helm charts: https://docs.helm.sh/developing_charts/ -.. _layering: https://airshipit.readthedocs.io/projects/deckhand/en/latest/layering.html -.. _substitution: https://airshipit.readthedocs.io/projects/deckhand/en/latest/substitution.html +.. _layering: https://airship-deckhand.readthedocs.io/en/latest/layering.html +.. _substitution: https://airship-deckhand.readthedocs.io/en/latest/substitution.html Schemas ^^^^^^^ diff --git a/doc/source/operations/guide-troubleshooting.rst b/doc/source/operations/guide-troubleshooting.rst index 04ea74b8..02d48e4c 100644 --- a/doc/source/operations/guide-troubleshooting.rst +++ b/doc/source/operations/guide-troubleshooting.rst @@ -28,7 +28,7 @@ When running Armada in the container you can execute docker logs to retrieve log Errors/Exceptions ----------------- -A guide for interpreting errors/exceptions can be found `here `_. +A guide for interpreting errors/exceptions can be found `here `_. Working with SSL ---------------- diff --git a/doc/source/operations/guide-use-armada.rst b/doc/source/operations/guide-use-armada.rst index 4fa562c6..c9b8e3fd 100644 --- a/doc/source/operations/guide-use-armada.rst +++ b/doc/source/operations/guide-use-armada.rst @@ -10,7 +10,7 @@ Kubernetes Cluster `Tiller Service `_ -`Armada.yaml `_ +`Armada.yaml `_ .. note:: diff --git a/setup.cfg b/setup.cfg index b83dff0a..01ce59e9 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,10 +1,10 @@ [metadata] -name = armada -summary = tool for managing multiple chart orchestration lifecycle +name = Armada +summary = Tool for managing multiple Helm charts with dependencies by centralizing all configurations in a single Armada YAML and providing life-cycle hooks for all Helm releases. description-file = README.rst +author = AT&T - Airship Developers +home-page = https://airship-armada.readthedocs.io/ -author = armada team -home-page = https://airship-armada.readthedocs.io/en/latest/ classifier = Intended Audience :: Information Technology Intended Audience :: System Administrators diff --git a/tools/gate/playbooks/readthedocs.yaml b/tools/gate/playbooks/readthedocs.yaml index 06c4f6ca..c79ab087 100644 --- a/tools/gate/playbooks/readthedocs.yaml +++ b/tools/gate/playbooks/readthedocs.yaml @@ -18,5 +18,5 @@ uri: method: POST body: 'token={{ airship_armada_rtd_credential.token }}' - url: 'https://readthedocs.org/api/v2/webhook/{{ zuul.project.short_name }}/{{ airship_armada_rtd_credential.id }}/' + url: 'https://readthedocs.io/api/v2/webhook/{{ zuul.project.short_name }}/{{ airship_armada_rtd_credential.id }}/' follow_redirects: all