Restructure Documentation
This change restructures the documentation into three categories that we will expand on later: 1. Try Airship 2. Develop Airship 3. Learn About Airship Change-Id: I52286c3b1d87222a436be86b4ab748dba61d080c Signed-off-by: Drew Walters <andrew.walters@att.com>
This commit is contained in:
parent
aa710cd6f5
commit
bc6b004dba
@ -14,10 +14,10 @@
|
||||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
.. _dev-getting-started:
|
||||
.. _getting-started:
|
||||
|
||||
Getting Started for Airship Developers
|
||||
======================================
|
||||
Getting Started
|
||||
===============
|
||||
Airship uses many foundational concepts that should be understood by developers
|
||||
wanting to get started. This documentation attempts to provide a survey of
|
||||
those topics.
|
21
doc/source/develop/index.rst
Normal file
21
doc/source/develop/index.rst
Normal file
@ -0,0 +1,21 @@
|
||||
..
|
||||
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
|
||||
===============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
getting-started
|
||||
conventions
|
@ -1,5 +1,5 @@
|
||||
..
|
||||
Copyright 2017 AT&T Intellectual Property.
|
||||
Copyright 2017-2020 AT&T Intellectual Property.
|
||||
All Rights Reserved.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
||||
@ -23,51 +23,16 @@
|
||||
Welcome to Airship documentation!
|
||||
=================================
|
||||
|
||||
Airship is a collection of components that coordinate to form a means of
|
||||
configuring, deploying and maintaining a `Kubernetes`_ environment using a
|
||||
declarative set of `yaml`_ documents. More details on using parts of Airship
|
||||
may be found by using the `Treasuremap`_
|
||||
|
||||
Approach
|
||||
--------
|
||||
Airship revolves around the setup and use of Kubernetes and `Helm`_ and takes
|
||||
cues from these projects. The first use case of Airship is the deployment
|
||||
of `OpenStack-Helm`_ which also influences Airship's direction.
|
||||
|
||||
Building this Documentation
|
||||
---------------------------
|
||||
|
||||
Use of ``make docs`` will build a html version of this documentation that can
|
||||
be viewed using a browser at doc/build/index.html on the local filesystem.
|
||||
|
||||
Specification Details
|
||||
---------------------
|
||||
|
||||
Proposed, approved, and implemented specifications_ for
|
||||
Airship projects are available.
|
||||
|
||||
Conventions and Standards
|
||||
-------------------------
|
||||
Airship is a collection of components that declaratively configure, deploy
|
||||
and maintain a `Kubernetes`_ environment defined by `yaml`_ documents.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
conventions
|
||||
security/guide
|
||||
dev-getting-started
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
learn/index.rst
|
||||
try/index.rst
|
||||
develop/index.rst
|
||||
|
||||
.. _airshipit.org: https://airshipit.org
|
||||
.. _Helm: https://helm.sh/
|
||||
.. _Kubernetes: https://kubernetes.io/
|
||||
.. _Openstack: https://www.openstack.org/
|
||||
.. _Openstack-Helm: https://docs.openstack.org/openstack-helm/latest/
|
||||
.. _Treasuremap: https://opendev.org/airship/treasuremap/
|
||||
.. _yaml: http://yaml.org/
|
||||
.. _specifications: /projects/specs
|
||||
|
20
doc/source/learn/index.rst
Normal file
20
doc/source/learn/index.rst
Normal file
@ -0,0 +1,20 @@
|
||||
..
|
||||
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
|
||||
|
||||
../security/guide
|
19
doc/source/try/index.rst
Normal file
19
doc/source/try/index.rst
Normal file
@ -0,0 +1,19 @@
|
||||
..
|
||||
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