starlingx/docs
Code Issues Proposed changes
docs/doc/source/contributor/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.4 KiB
Raw Blame History

Contribute

Please use the following guides when contributing to the StarlingX documentation. Additional information about contributing to OpenStack documentation can be found in the OpenStack API documentation guide and the OpenStack Documentation Contributor Guide.

api_contribute_guide release_note_contribute_guide doc_contribute_guide

For information on the StarlingX development process, see the following:

development_process

Build guides for StarlingX are release-specific. The following list provides help on choosing the correct build guide based on a release:

  • The "current" release is the most recent offically released version of StarlingX. Following is the current build guide:

    build_guides/current/index

  • The "latest" release is the forthcoming version under development. Following is the latest build guide:

    build_guides/latest/index

  • The "archived" build guides are as follows:

    • Currently, no archived build guides exist.