diff --git a/.github/SECURITY.md b/.github/SECURITY.md index bd5888ab..da9a2a56 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -6,4 +6,4 @@ The Airship community is committed to expediently confirming, resolving, and disclosing all reported security vulnerabilities. To report a security vulnerabillity, please refer to our [vulnerability management process][1]. -[1]: https://airship-docs.readthedocs.io/en/latest/security/vulnerabilities.html +[1]: https://docs.airshipit.org/learn/vulnerabilities.html diff --git a/.gitignore b/.gitignore index eb372f15..0bb45a47 100644 --- a/.gitignore +++ b/.gitignore @@ -68,7 +68,6 @@ instance/ # Sphinx documentation doc/build/ -doc/source/_static # PyBuilder target/ diff --git a/.zuul.yaml b/.zuul.yaml index 7816d4d9..057e86a1 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -13,14 +13,11 @@ - project: templates: - openstack-cover-jobs - - docs-on-readthedocs - openstack-python35-jobs - openstack-python36-jobs - vars: - rtd_webhook_id: '47578' - rtd_project_name: 'airship-armada' check: jobs: + - openstack-tox-docs - openstack-tox-pep8 - armada-chart-build-gate - armada-chart-build-latest-htk @@ -31,6 +28,7 @@ - armada-airship2-integration gate: jobs: + - openstack-tox-docs - openstack-tox-pep8 - armada-chart-build-gate - armada-docker-build-gate-ubuntu_bionic @@ -42,6 +40,9 @@ - armada-docker-publish-ubuntu_xenial - armada-docker-publish-opensuse - armada-upload-git-mirror + promote: + jobs: + - promote-airship-project-docs - nodeset: name: armada-single-node diff --git a/README.rst b/README.rst index 3d3f94d6..26e74a9d 100644 --- a/README.rst +++ b/README.rst @@ -1,13 +1,13 @@ Armada ====== -|Docker Repository on Quay| |Doc Status| +|Docker Repository on Quay| Armada is a 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. -Find more documentation for Armada on `Read The Docs `_. +Find more documentation for Armada in the `Armada documentation `_. Overview -------- @@ -111,16 +111,14 @@ Further Reading `Airship `_. -.. _Manual Install Guide: https://airship-armada.readthedocs.io/en/latest/development/getting-started.html#developer-install-guide -.. _Armada Quickstart: https://airship-armada.readthedocs.io/en/latest/operations/guide-use-armada.html -.. _metrics: https://airship-armada.readthedocs.io/en/latest/operations/metrics.html#metrics +.. _Manual Install Guide: https://docs.airshipit.org/armada/development/getting-started.html#developer-install-guide +.. _Armada Quickstart: https://docs.airshipit.org/armada/operations/guide-use-armada.html +.. _metrics: https://docs.airshipit.org/armada/operations/metrics.html#metrics .. _kubectl: https://kubernetes.io/docs/user-guide/kubectl/kubectl_config/ .. _Tiller: https://docs.helm.sh/using_helm/#easy-in-cluster-installation -.. _Deckhand: https://github.com/openstack/airship-deckhand +.. _Deckhand: https://opendev.org/airship/deckhand .. _Prometheus: https://prometheus.io .. _Keystone: https://github.com/openstack/keystone .. |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 - :target: https://airship-armada.readthedocs.io/ diff --git a/armada/cli/apply.py b/armada/cli/apply.py index 6a46bf16..cbc8c236 100644 --- a/armada/cli/apply.py +++ b/armada/cli/apply.py @@ -43,7 +43,7 @@ command once will install all charts defined in manifest. Re-executing apply command will execute upgrade. To see how to create an Armada manifest: - https://airship-armada.readthedocs.io/en/latest/operations/ + https://docs.airshipit.org/armada/operations/ To install or upgrade charts, run: diff --git a/armada/utils/validation_message.py b/armada/utils/validation_message.py index e43e787c..7125adb2 100644 --- a/armada/utils/validation_message.py +++ b/armada/utils/validation_message.py @@ -17,7 +17,7 @@ import json class ValidationMessage(object): """ ValidationMessage per Airship convention: - https://airshipit.readthedocs.io/en/latest/api-conventions.html#output-structure # noqa + https://docs.airshipit.org/armada/api-conventions.html#output-structure # noqa Construction of ValidationMessage message: diff --git a/charts/armada/Chart.yaml b/charts/armada/Chart.yaml index fd96290c..524d4850 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 +home: https://airshipit.org sources: - https://opendev.org/airship/armada.git engine: gotpl diff --git a/doc/source/_static/airship.logo.white.svg b/doc/source/_static/airship.logo.white.svg new file mode 100644 index 00000000..b664296d --- /dev/null +++ b/doc/source/_static/airship.logo.white.svg @@ -0,0 +1 @@ +logo_white \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 20073242..6ed6273d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -60,18 +60,18 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Armada' -copyright = u'2017, Armada Team' -author = u'Armada Team' +project = 'Armada' +copyright = u'2017-2020, The Airship Authors' +author = 'The Airship Authors' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u'0.2.0' +#version = u'0.2.0' # The full version, including alpha/beta/rc tags. -release = u'0.2.0' +#release = u'0.2.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -98,14 +98,16 @@ todo_include_todos = False # a list of builtin themes. # import sphinx_rtd_theme +html_logo = '_static/airship.logo.white.svg' html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +html_theme_options = { + 'display_version': False, + 'logo_only': True +} -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} +html_show_sourcelink = False +html_show_sphinx = False # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/doc/source/index.rst b/doc/source/index.rst index 18a9fd4f..754abaa5 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,21 +3,31 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +================================== Welcome to Armada's documentation! ================================== -.. toctree:: - :maxdepth: 2 - :caption: Contents: +.. include:: ../../README.rst + +.. toctree:: + :caption: Armada + :hidden: + :maxdepth: 2 - readme development/index operations/index commands/index -Indices and tables -================== +.. toctree:: + :caption: Airship 1 Project Documentation + :hidden: -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + Airship Documentation + Armada + Deckhand + Divingbell + Drydock + Pegleg + Promenade + Shipyard + Treasuremap diff --git a/doc/source/operations/documents/v1/schemas.rst b/doc/source/operations/documents/v1/schemas.rst index 7128feb2..6670ba70 100644 --- a/doc/source/operations/documents/v1/schemas.rst +++ b/doc/source/operations/documents/v1/schemas.rst @@ -54,10 +54,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://airship-deckhand.readthedocs.io/en/latest/document-types.html?highlight=dataschema#dataschema +.. _Deckhand DataSchema: https://docs.airshipit.org/deckhand/document-types.html?highlight=dataschema#dataschema .. _Helm charts: https://docs.helm.sh/developing_charts/ -.. _layering: https://airship-deckhand.readthedocs.io/en/latest/layering.html -.. _substitution: https://airship-deckhand.readthedocs.io/en/latest/substitution.html +.. _layering: https://docs.airshipit.org/deckhand/layering.html +.. _substitution: https://docs.airshipit.org/deckhand/substitution.html Schemas ^^^^^^^ diff --git a/doc/source/operations/documents/v2/schemas.rst b/doc/source/operations/documents/v2/schemas.rst index f1d4cc38..fb269058 100644 --- a/doc/source/operations/documents/v2/schemas.rst +++ b/doc/source/operations/documents/v2/schemas.rst @@ -54,10 +54,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://airship-deckhand.readthedocs.io/en/latest/document-types.html?highlight=dataschema#dataschema +.. _Deckhand DataSchema: https://docs.airshipit.org/deckhand/document-types.html?highlight=dataschema#dataschema .. _Helm charts: https://docs.helm.sh/developing_charts/ -.. _layering: https://airship-deckhand.readthedocs.io/en/latest/layering.html -.. _substitution: https://airship-deckhand.readthedocs.io/en/latest/substitution.html +.. _layering: https://docs.airshipit.org/deckhand/layering.html +.. _substitution: https://docs.airshipit.org/deckhand/substitution.html Schemas ^^^^^^^ diff --git a/doc/source/operations/guide-troubleshooting.rst b/doc/source/operations/guide-troubleshooting.rst index c270a80b..c9a79742 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 ---------------- @@ -54,5 +54,5 @@ Issue If the issue that you are having does not appear here please check the Armada issues on -`StoryBoard `_. +`GitHub `_. If the issue does not exist, please create an issue. diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/images/armada/Dockerfile.opensuse_15 b/images/armada/Dockerfile.opensuse_15 index 87ba5eb0..0a77d738 100644 --- a/images/armada/Dockerfile.opensuse_15 +++ b/images/armada/Dockerfile.opensuse_15 @@ -3,7 +3,7 @@ FROM ${FROM} LABEL org.opencontainers.image.authors='airship-discuss@lists.airshipit.org, irc://#airshipit@freenode' \ org.opencontainers.image.url='https://airshipit.org' \ - org.opencontainers.image.documentation='https://airship-armada.readthedocs.org' \ + org.opencontainers.image.documentation='https://docs.airshipit.org/armada' \ org.opencontainers.image.source='https://opendev.org/airship/armada' \ org.opencontainers.image.vendor='The Airship Authors' \ org.opencontainers.image.licenses='Apache-2.0' diff --git a/images/armada/Dockerfile.ubuntu_bionic b/images/armada/Dockerfile.ubuntu_bionic index 9909ba64..05c256ea 100644 --- a/images/armada/Dockerfile.ubuntu_bionic +++ b/images/armada/Dockerfile.ubuntu_bionic @@ -3,7 +3,7 @@ FROM ${FROM} LABEL org.opencontainers.image.authors='airship-discuss@lists.airshipit.org, irc://#airshipit@freenode' \ org.opencontainers.image.url='https://airshipit.org' \ - org.opencontainers.image.documentation='https://airship-armada.readthedocs.org' \ + org.opencontainers.image.documentation='https://docs.airshipit.org/armada' \ org.opencontainers.image.source='https://opendev.org/airship/armada' \ org.opencontainers.image.vendor='The Airship Authors' \ org.opencontainers.image.licenses='Apache-2.0' diff --git a/images/armada/Dockerfile.ubuntu_xenial b/images/armada/Dockerfile.ubuntu_xenial index 40998381..989b949e 100644 --- a/images/armada/Dockerfile.ubuntu_xenial +++ b/images/armada/Dockerfile.ubuntu_xenial @@ -3,7 +3,7 @@ FROM ${FROM} LABEL org.opencontainers.image.authors='airship-discuss@lists.airshipit.org, irc://#airshipit@freenode' \ org.opencontainers.image.url='https://airshipit.org' \ - org.opencontainers.image.documentation='https://airship-armada.readthedocs.org' \ + org.opencontainers.image.documentation='https://docs.airshipit.org/armada' \ org.opencontainers.image.source='https://opendev.org/airship/armada' \ org.opencontainers.image.vendor='The Airship Authors' \ org.opencontainers.image.licenses='Apache-2.0' diff --git a/setup.cfg b/setup.cfg index fd05045c..24be4c36 100644 --- a/setup.cfg +++ b/setup.cfg @@ -4,7 +4,7 @@ summary = Tool for managing multiple Helm charts with dependencies by centralizi description-file = README.rst author = The Airship Authors author-email = airship-discuss@lists.airshipit.org -home-page = https://airship-armada.readthedocs.io/ +home-page = https://airshipit.org classifier = Intended Audience :: Information Technology