airship/docs
Code Issues Proposed changes

Add links to other Airship projects

Browse Source 
This change finalizes the documentation theme and adds links to other
projects on docs.airshipit.org.

The Airship 1 projects will be added once they are publishing.

Change-Id: I6796e2cf8e4d9f8e1b29f831f09bf3eb4aa3257a
Signed-off-by: Drew Walters <andrew.walters@att.com>
This commit is contained in:
Drew Walters 2020-06-11 19:26:26 +00:00
parent 2b85e57b5d
commit cfb394f85f
5 changed files with 52 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/conf.py
View File

@ -49,8 +49,8 @@ master_doc = 'index'
# General information about the project.
project = 'Airship Project'
copyright = '2019, Airship Team'
author = 'Airship Team'
copyright = '2019-2020, The Airship Authors'
author = 'The Airship Authors'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -167,10 +167,10 @@ html_static_path = ['_static']
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

26
doc/source/develop/developers.rst
View File

@ -11,8 +11,25 @@
License for the specific language governing permissions and limitations
under the License.
Getting Started - Airship 2 Development
=======================================
===============
Getting Started
===============
Thank you for your interest in Airship. Our community is eager to help you
contribute to the success of our project and welcome you as a member of our
community!
We invite you to reach out to us at any time via the `Airship mailing list`_ or
on our `Slack workspace`_.
Welcome aboard!
.. _Airship mailing list: http://lists.airshipit.org
.. _Slack workspace: http://airshipit.org/slack
=====================
Airship 2 Development
=====================
Development is underway on Airship 2: the educated evolution of Airship 1,
designed with our experience using Airship in production. Airship 2 makes the
@ -32,8 +49,9 @@ development by referencing the `airshipctl`_ or the `airshipui`_ documentation.
.. _Kustomize: https://github.com/kubernetes-sigs/kustomize
.. _Metal Kubed: https://metal3.io
Getting Started - Airship 1 Development
=======================================
=====================
Airship 1 Development
=====================
Airship 1 is a collection of open source tools that automate cloud provisioning
and management. Airship provides a declarative framework for defining and

33
doc/source/develop/index.rst
View File

@ -1,33 +0,0 @@
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Develop Airship
===============
Thank you for your interest in Airship. Our community is eager to help you
contribute to the success of our project and welcome you as a member of our
community!
We invite you to reach out to us at any time via the `Airship mailing list`_ or
on our `Slack workspace`_.
Welcome aboard!
.. _Airship mailing list: http://lists.airshipit.org
.. _Slack workspace: http://airshipit.org/slack
.. toctree::
:hidden:
developers
conventions

34
doc/source/index.rst
View File

@ -14,12 +14,6 @@
License for the specific language governing permissions and limitations
under the License.
.. note::
These documents will be reworked to reflect the changes associated with
becoming an OpenStack hosted project: Airship. Expect major changes to occur
with time. See more at `airshipit.org`_
Welcome to Airship documentation!
=================================
@ -27,11 +21,35 @@ Airship is a collection of components that declaratively configure, deploy
and maintain a `Kubernetes`_ environment defined by `yaml`_ documents.
.. toctree::
:caption: Learn About Airship
:maxdepth: 3
:hidden:
learn/vulnerabilities.rst
.. toctree::
:caption: Try Airship
:maxdepth: 3
:hidden:
learn/index.rst
try/index.rst
develop/index.rst
.. toctree::
:caption: Develop Airship
:maxdepth: 3
:hidden:
develop/developers.rst
develop/conventions.rst
.. toctree::
:caption: Airship Project Documentation
:hidden:
Airship Documentation <https://docs.airshipit.org>
Airshipctl <https://docs.airshipit.org/airshipctl>
Airshipui <https://docs.airshipit.org/airshipui>
Treasuremap <https://docs.airshipit.org/treasuremap>
.. _airshipit.org: https://airshipit.org
.. _Kubernetes: https://kubernetes.io/

20
doc/source/learn/index.rst
View File

@ -1,20 +0,0 @@
..
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Learn About Airship
===================
.. toctree::
:maxdepth: 3
vulnerabilities