Add more documentation content
This change adds additional content for users landing on docs.airshipit.org. Change-Id: Icf791df287d5655833dea8b3b351b093d0cd1c2c Signed-off-by: Drew Walters <andrew.walters@att.com>
This commit is contained in:
parent
acc376171b
commit
951ab6d899
Before Width: | Height: | Size: 3.8 KiB After Width: | Height: | Size: 3.8 KiB |
@ -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
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
# of the sidebar.
|
# 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 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
|
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
|
@ -96,7 +96,7 @@ smaller, demo site.
|
|||||||
`Airsloop`_ is a fully-authored Airship site that can be quickly deployed as a
|
`Airsloop`_ is a fully-authored Airship site that can be quickly deployed as a
|
||||||
baremetal, demo lab.
|
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
|
.. _Airskiff: https://docs.airshipit.org/treasuremap/airskiff.html
|
||||||
|
|
||||||
@ -198,8 +198,7 @@ component images.
|
|||||||
|
|
||||||
.. _Airskiff: https://docs.airshipit.org/treasuremap/airskiff.html
|
.. _Airskiff: https://docs.airshipit.org/treasuremap/airskiff.html
|
||||||
|
|
||||||
.. _Airship-in-a-Bottle Multinode: http://git.openstack.org/cgit/openstack/
|
.. _Airship-in-a-Bottle Multinode: https://opendev.org/airship/treasuremap/src/branch/master/tools/deployment/aiab
|
||||||
airship-in-a-bottle/tree/tools/multi_nodes_gate/README.rst
|
|
||||||
|
|
||||||
Final Checks
|
Final Checks
|
||||||
------------
|
------------
|
||||||
|
@ -14,43 +14,84 @@
|
|||||||
License for the specific language governing permissions and limitations
|
License for the specific language governing permissions and limitations
|
||||||
under the License.
|
under the License.
|
||||||
|
|
||||||
|
=================================
|
||||||
Welcome to Airship documentation!
|
Welcome to Airship documentation!
|
||||||
=================================
|
=================================
|
||||||
|
|
||||||
Airship is a collection of components that declaratively configure, deploy
|
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::
|
.. toctree::
|
||||||
:caption: Learn About Airship
|
:caption: Learn About Airship
|
||||||
:maxdepth: 3
|
:maxdepth: 1
|
||||||
:hidden:
|
|
||||||
|
|
||||||
|
What is Airship? <https://www.airshipit.org/collateral/Airship_OnePager.pdf>
|
||||||
learn/vulnerabilities.rst
|
learn/vulnerabilities.rst
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: Try Airship
|
:caption: Try Airship
|
||||||
:maxdepth: 3
|
:maxdepth: 1
|
||||||
:hidden:
|
|
||||||
|
|
||||||
try/index.rst
|
Airship-in-a-Bottle <https://opendev.org/airship/treasuremap/src/branch/master/tools/deployment/aiab>
|
||||||
|
Airsloop: Simple Bare-Metal Airship <https://docs.airshipit.org/treasuremap/airsloop.html>
|
||||||
|
Seaworthy: Production-grade Airship <https://docs.airshipit.org/treasuremap/seaworthy.html>
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: Develop Airship
|
:caption: Develop Airship
|
||||||
:maxdepth: 3
|
:maxdepth: 1
|
||||||
:hidden:
|
|
||||||
|
|
||||||
develop/developers.rst
|
develop/developers.rst
|
||||||
develop/conventions.rst
|
develop/conventions.rst
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:caption: Airship Project Documentation
|
:caption: Airship Project Documentation
|
||||||
:hidden:
|
:maxdepth: 1
|
||||||
|
|
||||||
Airship Documentation <https://docs.airshipit.org>
|
Airship Documentation <https://docs.airshipit.org>
|
||||||
Airshipctl <https://docs.airshipit.org/airshipctl>
|
Airshipctl <https://docs.airshipit.org/airshipctl>
|
||||||
Airshipui <https://docs.airshipit.org/airshipui>
|
Airshipui <https://docs.airshipit.org/airshipui>
|
||||||
Treasuremap <https://docs.airshipit.org/treasuremap>
|
Treasuremap <https://docs.airshipit.org/treasuremap>
|
||||||
|
|
||||||
.. _airshipit.org: https://airshipit.org
|
Other Resources
|
||||||
.. _Kubernetes: https://kubernetes.io/
|
---------------
|
||||||
.. _yaml: http://yaml.org/
|
|
||||||
|
* `Airship Blog <https://www.airshipit.org/blog>`_
|
||||||
|
* `Airship Website <https://www.airshipit.org>`_
|
||||||
|
* `Airship Wiki <https://wiki.openstack.org/wiki/Airship>`_
|
||||||
|
|
||||||
|
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
|
||||||
|
@ -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.
|
|
Loading…
x
Reference in New Issue
Block a user