docs/doc/source/index.rst
Kristal Dale 22f4e7843e Add nav sections/folders for config guides and admin guides
- New nav section: Configuration, topic specific config guides
- New nav section: Operation Guides, task specific guides
- New nav item: CLI Reference
- Sections organized by general, kubernetes, openstack
- Stubb pages added for all top level topics in sections, with
  link to associated StoryBoard story

Change-Id: I59f58adbb27bf4d65755cddc40a8ec565fb949f1
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2019-11-15 16:38:53 -08:00

2.4 KiB
Executable File

Welcome to the StarlingX Documentation

The latest release of StarlingX is StarlingX R2.0. Additional information about this release is available in the release-notes.

For more information about the StarlingX project, refer to the Project Specifications.

Documentation

The documentation is organized into the following sections:

introduction/index deploy_install_guides/index configuration/index operations/index api-ref/index cli_ref/index contributor/index releasenotes/index developer_resources/index

Projects

StarlingX contains multiple sub-projects that include additional edge cloud support services and clients. API documentation and release notes for each project are found on the specific project page:

Supporting projects and repositories:

Contribute

StarlingX utilizes tooling and CI/CD environments from the OpenStack Foundation. The source is hosted on OpenDev's Git server.

Additional information regarding contributing to the project can be found in the StarlingX contributor guides <contribute>.

Governance

StarlingX is a top-level OpenStack Foundation pilot project that is governed by two separate bodies: The OpenStack Foundation Board of Directors and the StarlingX Technical Steering Committee.

See StarlingX Governance for additional information about StarlingX project governance.