From 951ab6d899dced78ef25fa2a9184d5a9f3e37340 Mon Sep 17 00:00:00 2001 From: Drew Walters Date: Fri, 12 Jun 2020 14:10:29 +0000 Subject: [PATCH] Add more documentation content This change adds additional content for users landing on docs.airshipit.org. Change-Id: Icf791df287d5655833dea8b3b351b093d0cd1c2c Signed-off-by: Drew Walters --- doc/source/_static/.gitkeep | 0 .../{ => _static}/airship.logo.white.svg | 0 doc/source/conf.py | 2 +- doc/source/develop/developers.rst | 5 +- doc/source/index.rst | 65 +++++++++++++++---- doc/source/try/index.rst | 19 ------ 6 files changed, 56 insertions(+), 35 deletions(-) delete mode 100644 doc/source/_static/.gitkeep rename doc/source/{ => _static}/airship.logo.white.svg (100%) delete mode 100644 doc/source/try/index.rst diff --git a/doc/source/_static/.gitkeep b/doc/source/_static/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/doc/source/airship.logo.white.svg b/doc/source/_static/airship.logo.white.svg similarity index 100% rename from doc/source/airship.logo.white.svg rename to doc/source/_static/airship.logo.white.svg diff --git a/doc/source/conf.py b/doc/source/conf.py index 4e5ccbb..a846ece 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -125,7 +125,7 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = "airship.logo.white.svg" +html_logo = '_static/airship.logo.white.svg' # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 diff --git a/doc/source/develop/developers.rst b/doc/source/develop/developers.rst index aa7d13f..bf5b152 100644 --- a/doc/source/develop/developers.rst +++ b/doc/source/develop/developers.rst @@ -96,7 +96,7 @@ smaller, demo site. `Airsloop`_ is a fully-authored Airship site that can be quickly deployed as a baremetal, demo lab. -.. _Airship-in-a-Bottle: https://opendev.org/airship/in-a-bottle +.. _Airship-in-a-Bottle: https://opendev.org/airship/treasuremap/src/branch/master/tools/deployment/aiab .. _Airskiff: https://docs.airshipit.org/treasuremap/airskiff.html @@ -198,8 +198,7 @@ component images. .. _Airskiff: https://docs.airshipit.org/treasuremap/airskiff.html -.. _Airship-in-a-Bottle Multinode: http://git.openstack.org/cgit/openstack/ - airship-in-a-bottle/tree/tools/multi_nodes_gate/README.rst +.. _Airship-in-a-Bottle Multinode: https://opendev.org/airship/treasuremap/src/branch/master/tools/deployment/aiab Final Checks ------------ diff --git a/doc/source/index.rst b/doc/source/index.rst index cba3b91..4cc53a6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -14,43 +14,84 @@ License for the specific language governing permissions and limitations under the License. +================================= Welcome to Airship documentation! ================================= Airship is a collection of components that declaratively configure, deploy -and maintain a `Kubernetes`_ environment defined by `yaml`_ documents. +and maintain a `Kubernetes`_ environment defined by `YAML`_ documents. Airship +is supported by the `OpenStack Foundation`_. + +.. _OpenStack Foundation: https://www.openstack.org/foundation/ +.. _Kubernetes: https://kubernetes.io/ +.. _YAML: http://yaml.org/ + +About this Documentation +======================== + +Airship documentation serves the entire community with resources for users and +developers. .. toctree:: :caption: Learn About Airship - :maxdepth: 3 - :hidden: + :maxdepth: 1 + What is Airship? learn/vulnerabilities.rst .. toctree:: :caption: Try Airship - :maxdepth: 3 - :hidden: + :maxdepth: 1 - try/index.rst + Airship-in-a-Bottle + Airsloop: Simple Bare-Metal Airship + Seaworthy: Production-grade Airship .. toctree:: :caption: Develop Airship - :maxdepth: 3 - :hidden: + :maxdepth: 1 develop/developers.rst develop/conventions.rst .. toctree:: :caption: Airship Project Documentation - :hidden: + :maxdepth: 1 Airship Documentation Airshipctl Airshipui Treasuremap -.. _airshipit.org: https://airshipit.org -.. _Kubernetes: https://kubernetes.io/ -.. _yaml: http://yaml.org/ +Other Resources +--------------- + +* `Airship Blog `_ +* `Airship Website `_ +* `Airship Wiki `_ + +Get Involved +============ + +Join our mailing lists +---------------------- + +Receive Airship announcements and interact with our community on our `mailing +lists`_. + +.. _mailing lists: http://lists.airshipit.org/cgi-bin/mailman/listinfo + +Join our weekly calls +--------------------- + +Airship is constantly evolving. Contribute to the Airship design process and +day-to-day community operations in our `weekly calls`_. + +.. _weekly calls: https://wiki.openstack.org/wiki/Airship#Get_in_Touch + +Join our Slack workspace +------------------------ + +Get in touch with Airship developers and operators in our `Slack workspace`_. + +.. _Slack workspace: https://airshipit.org/slack diff --git a/doc/source/try/index.rst b/doc/source/try/index.rst deleted file mode 100644 index d9c6b64..0000000 --- a/doc/source/try/index.rst +++ /dev/null @@ -1,19 +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. - -Try Airship -=========== - -.. note:: - - This documentation is a work-in-progress.