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
This commit is contained in:
Roman Gorshunov 2018-09-24 12:53:27 +02:00
parent 90618f549c
commit 09f099e5b2
11 changed files with 16 additions and 16 deletions

View File

@ -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/

View File

@ -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}

View File

@ -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.

View File

@ -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:

View File

@ -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

View File

@ -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:

View File

@ -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
^^^^^^^

View File

@ -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 <https://airshipit.readthedocs.io/projects/armada/en/latest/operations/exceptions/guide-exceptions.html>`_.
A guide for interpreting errors/exceptions can be found `here <https://airship-armada.readthedocs.io/en/latest/operations/exceptions/guide-exceptions.html>`_.
Working with SSL
----------------

View File

@ -10,7 +10,7 @@ Kubernetes Cluster
`Tiller Service <https://github.com/kubernetes/helm>`_
`Armada.yaml <https://airshipit.readthedocs.io/projects/armada/en/latest/operations/guide-build-armada-yaml.html>`_
`Armada.yaml <https://airship-armada.readthedocs.io/en/latest/operations/guide-build-armada-yaml.html>`_
.. note::

View File

@ -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

View File

@ -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