airship-in-a-bottle/doc/source/index.rst
Roman Gorshunov ff024eb81a Unify publishing of docs, update code convention
Unified publishing to the readthedocs with other Airship projects.
Updated code convention for new documentation location.

Change-Id: If3b634bf04ed36b3f88831f0a276809ce6539b42
2018-09-14 23:47:43 +02:00

2.2 KiB

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

Airship

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

conventions security/guide dev-getting-started