From cfb394f85fb25dfd7272d46465349b0b0e12241b Mon Sep 17 00:00:00 2001
From: Drew Walters <andrew.walters@att.com>
Date: Thu, 11 Jun 2020 19:26:26 +0000
Subject: [PATCH] Add links to other Airship projects
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>
---
doc/source/conf.py | 8 ++++----
doc/source/develop/developers.rst | 26 +++++++++++++++++++----
doc/source/develop/index.rst | 33 ------------------------------
doc/source/index.rst | 34 +++++++++++++++++++++++--------
doc/source/learn/index.rst | 20 ------------------
5 files changed, 52 insertions(+), 69 deletions(-)
delete mode 100644 doc/source/develop/index.rst
delete mode 100644 doc/source/learn/index.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
index f6faf25..4e5ccbb 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -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
diff --git a/doc/source/develop/developers.rst b/doc/source/develop/developers.rst
index 4272b5d..aa7d13f 100644
--- a/doc/source/develop/developers.rst
+++ b/doc/source/develop/developers.rst
@@ -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
diff --git a/doc/source/develop/index.rst b/doc/source/develop/index.rst
deleted file mode 100644
index d657a7c..0000000
--- a/doc/source/develop/index.rst
+++ /dev/null
@@ -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
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 0d45bbd..cba3b91 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -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/
diff --git a/doc/source/learn/index.rst b/doc/source/learn/index.rst
deleted file mode 100644
index a6dc924..0000000
--- a/doc/source/learn/index.rst
+++ /dev/null
@@ -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