Add documentation to docs.airshipit.org
This change adds publishing to docs.airshipit.org and updates the theme to match the other Airship projects on the site. This change also updates orphaned links and removes the Read the Docs jobs. The documentation can be found at docs.airshipit.org/armada when this change merges. Change-Id: I9641753f6084f911e3286c623d0c2de7b3f6040a Signed-off-by: Drew Walters <andrew.walters@att.com>
This commit is contained in:
Drew Walters
Roman Gorshunov
parent
d31aefb76c
commit
7bf1423752
2
.github/SECURITY.md
vendored
2
.github/SECURITY.md
vendored
@ -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
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@ -68,7 +68,6 @@ instance/
|
||||
|
||||
# Sphinx documentation
|
||||
doc/build/
|
||||
doc/source/_static
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
@ -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
|
||||
|
||||
14
README.rst
14
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 <https://airship-armada.readthedocs.io/>`_.
|
||||
Find more documentation for Armada in the `Armada documentation <https://docs.airshipit.org/armada>`_.
|
||||
|
||||
Overview
|
||||
--------
|
||||
@ -111,16 +111,14 @@ Further Reading
|
||||
|
||||
`Airship <https://airshipit.org>`_.
|
||||
|
||||
.. _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/
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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:
|
||||
|
||||
|
||||
@ -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
|
||||
|
||||
1
doc/source/_static/airship.logo.white.svg
Normal file
1
doc/source/_static/airship.logo.white.svg
Normal file
@ -0,0 +1 @@
|
||||
<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" width="1.51in" height="0.41in" viewBox="0 0 108.66 29.2"><defs><style>.cls-1{fill:#fff;}</style></defs><title>logo_white</title><path class="cls-1" d="M166.93,99.47a4,4,0,0,1-.36-1.2,4.31,4.31,0,0,1-3.36,1.45A4.72,4.72,0,0,1,160,98.58a3.64,3.64,0,0,1-1.29-2.86,3.75,3.75,0,0,1,1.57-3.25,7.74,7.74,0,0,1,4.54-1.15h1.64v-.77a2.16,2.16,0,0,0-.47-1.47,1.88,1.88,0,0,0-1.5-.56A2.1,2.1,0,0,0,163,89a1.47,1.47,0,0,0-.51,1.19H159a3.57,3.57,0,0,1,.72-2.15,4.78,4.78,0,0,1,2-1.55,7.44,7.44,0,0,1,2.94-.56,5.8,5.8,0,0,1,3.91,1.24A4.33,4.33,0,0,1,170,90.6v5.79a6.34,6.34,0,0,0,.53,2.87v.21ZM164,97a3.15,3.15,0,0,0,1.46-.35,2.29,2.29,0,0,0,1-.94V93.4h-1.33c-1.78,0-2.73.62-2.85,1.85v.21a1.44,1.44,0,0,0,.47,1.1A1.8,1.8,0,0,0,164,97Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M172.47,82.68a1.73,1.73,0,0,1,.53-1.32,2.31,2.31,0,0,1,2.92,0,1.88,1.88,0,0,1,0,2.65,2.28,2.28,0,0,1-2.9,0A1.77,1.77,0,0,1,172.47,82.68Zm3.78,16.79h-3.58V86.13h3.58Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M186.42,89.47a9,9,0,0,0-1.28-.1,2.61,2.61,0,0,0-2.65,1.37v8.73h-3.56V86.13h3.36l.1,1.59a3.3,3.3,0,0,1,3-1.84,3.92,3.92,0,0,1,1.11.16Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M195.74,95.78a1.16,1.16,0,0,0-.65-1,7.43,7.43,0,0,0-2.07-.67c-3.18-.66-4.76-2-4.76-4a3.68,3.68,0,0,1,1.47-3,6,6,0,0,1,3.85-1.19,6.35,6.35,0,0,1,4.06,1.2,3.76,3.76,0,0,1,1.53,3.1H195.6a1.72,1.72,0,0,0-.49-1.26,2.1,2.1,0,0,0-1.54-.5,2.13,2.13,0,0,0-1.39.41,1.29,1.29,0,0,0-.5,1,1.1,1.1,0,0,0,.56,1,6,6,0,0,0,1.9.63,14.77,14.77,0,0,1,2.24.6q2.82,1,2.82,3.58a3.49,3.49,0,0,1-1.56,3,6.77,6.77,0,0,1-4,1.13,7,7,0,0,1-3-.6,5,5,0,0,1-2-1.64,3.79,3.79,0,0,1-.74-2.25h3.38a1.82,1.82,0,0,0,.7,1.45,2.76,2.76,0,0,0,1.75.51,2.59,2.59,0,0,0,1.55-.39A1.21,1.21,0,0,0,195.74,95.78Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M205.35,87.58a4.48,4.48,0,0,1,3.57-1.7q4.34,0,4.4,5v8.55h-3.56V91a2.45,2.45,0,0,0-.5-1.69,2.09,2.09,0,0,0-1.64-.55A2.43,2.43,0,0,0,205.35,90v9.48h-3.56V80.53h3.56Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M215.82,82.68a1.73,1.73,0,0,1,.54-1.32,2,2,0,0,1,1.46-.52,2,2,0,0,1,1.46.52,1.73,1.73,0,0,1,.54,1.32,1.78,1.78,0,0,1-.55,1.33,2.28,2.28,0,0,1-2.9,0A1.78,1.78,0,0,1,215.82,82.68Zm3.79,16.79H216V86.13h3.58Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M234.33,92.92a8,8,0,0,1-1.4,4.94,4.48,4.48,0,0,1-3.78,1.86,4.13,4.13,0,0,1-3.26-1.41v6.29h-3.57V86.13h3.31l.12,1.31a4.18,4.18,0,0,1,3.38-1.56A4.51,4.51,0,0,1,233,87.71a8.15,8.15,0,0,1,1.37,5Zm-3.56-.26a5.23,5.23,0,0,0-.66-2.87,2.16,2.16,0,0,0-1.92-1,2.32,2.32,0,0,0-2.3,1.28v5.46a2.37,2.37,0,0,0,2.33,1.32Q230.77,96.84,230.77,92.66Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M135.45,97.76l-1.55-.9A1.9,1.9,0,0,1,133,95.6l-.58-3a26.6,26.6,0,0,1-1.65-3.73l-4.9,8.49a1.4,1.4,0,0,0,1.21,2.1h7.69a.51.51,0,0,0,.45-.26l.72-1.25A2,2,0,0,1,135.45,97.76Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M140.56,76.1a1.41,1.41,0,0,0-2.43,0l-6.06,10.51a1.3,1.3,0,0,1,.74-.5c2-.53,5.94-1.23,9,.56a9.74,9.74,0,0,1,3.52,3.79h3.2a.51.51,0,0,1,.4.19Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M152.84,97.37,149,90.78a.53.53,0,0,1-.11.54l-2,2L153,97.81A1.46,1.46,0,0,0,152.84,97.37Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M138.66,92.16A28.39,28.39,0,0,1,132,86.74l-.12.2a1.08,1.08,0,0,0,0,.81,16.31,16.31,0,0,0,1.85,4.36l.63,3.23a.51.51,0,0,0,.25.34l1.55.9a.51.51,0,0,0,.7-.18l.5-.86a10.11,10.11,0,0,0,4.56.9l1.6,2.77a.51.51,0,0,0,.94-.11l.88-3.11c.21,0,.39-.09.57-.14a1.32,1.32,0,0,0,.82-.63A28.65,28.65,0,0,1,138.66,92.16Z" transform="translate(-125.67 -75.4)"/><path class="cls-1" d="M152.09,99.39l-5.62-2.47-.73,2.55h5.89A1.39,1.39,0,0,0,152.09,99.39Z" transform="translate(-125.67 -75.4)"/></svg>
|
||||
|
After Width: | Height: | Size: 3.8 KiB |
@ -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,
|
||||
|
||||
@ -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 <https://docs.airshipit.org>
|
||||
Armada <https://docs.airshipit.org/armada>
|
||||
Deckhand <https://docs.airshipit.org/deckhand>
|
||||
Divingbell <https://docs.airshipit.org/divingbell>
|
||||
Drydock <https://docs.airshipit.org/drydock>
|
||||
Pegleg <https://docs.airshipit.org/pegleg>
|
||||
Promenade <https://docs.airshipit.org/promenade>
|
||||
Shipyard <https://docs.airshipit.org/shipyard>
|
||||
Treasuremap <https://docs.airshipit.org/treasuremap>
|
||||
|
||||
@ -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
|
||||
^^^^^^^
|
||||
|
||||
@ -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
|
||||
^^^^^^^
|
||||
|
||||
@ -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://airship-armada.readthedocs.io/en/latest/operations/exceptions/guide-exceptions.html>`_.
|
||||
A guide for interpreting errors/exceptions can be found `here <https://docs.airshipit.org/armada/operations/exceptions/guide-exceptions.html>`_.
|
||||
|
||||
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 <https://storyboard.openstack.org/#!/project/airship/armada>`_.
|
||||
`GitHub <https://github.com/airshipit/armada/issues>`_.
|
||||
If the issue does not exist, please create an issue.
|
||||
|
||||
@ -1 +0,0 @@
|
||||
.. include:: ../../README.rst
|
||||
@ -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'
|
||||
|
||||
@ -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'
|
||||
|
||||
@ -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'
|
||||
|
||||
@ -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
|
||||
|
||||
Loading…
Reference in New Issue
Block a user