docs/doc/source/index.rst
Scott Rifenbark 3b0b2b0199 stx-docs refactoring for new doc structure
Changes included updating the StarlingX docs landing
page to conform to a new list of available documents
as follows:

 * StarlingX Introduction
 * Deployment Guides
 * Installation Guides
 * Developer resources
 * Operation Guides
 * Project Specifications
 * REST API Reference
 * Release Notes
 * Contribute

So-called "dead-end" links have an explanation of content
coming.  Any destination associated with an existing story
ID have the link to the story for reference.

The existence of a "current" and "latest" Developer
Guides resulted in the top-level list of doc resources
including both the "Developer Guides" and
"Developer Resources" bullets.  Ideally, the Developer
Guides would be included as part of the "Developer
Resources" area.  For "latest" they are.  However, for
"current" I left them alone since the 2018.10 release
is out there.  This organization can settle out as more
releases launch.

Finally, I did not focus on the writing aspect for this
PR. That part can be cleaned up going forward.

Change-Id: I0442e948d5d9a41add9eb3bdde8882c157a8f752
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
2019-04-03 15:43:39 -07:00

1.7 KiB

StarlingX Documentation

Welcome to the StarlingX documentation. This is the documentation for release stx.2018.10. Additional information about this release is available in the release-notes.

For more information about the project, consult the Project Specifications.

Sections

introduction/index deployment_guides/index installation_guide/index operation_guides/index contributor/index releasenotes/index developer_resources/index

Projects

StarlingX contains a number of sub-projects that include additional Edge Cloud support services and clients:

There are several supporting projects and repositories:

Contribute

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

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