docs/doc/source/index.rst
Kristal Dale c92b00d074 General clean up of presentation; migrate release notes from wiki
- Landing page:
	- General clean up (org of page, improve wording, markdown clean up)
	- Replace Abstract with welcome text, move link to project spec to welcome.
	- Include ref to contribute guide in Contribute section
	- Remove "Contents" caption from toctree (so it wont render in side nav)
- Release notes page:
	- Remove "StarlingX" from page title.
	- Integrate wiki content from https://wiki.openstack.org/wiki/StarlingX/stx.2018.10_Release_Notes
        - Improve wording, link text
- API ref page: Update page title to "REST API Reference"
- All pages:
	- Capitalization corrections
	- Clean up section heading markdown for consistency
- libvert installation page:
	- corrected heading levels (I believe section headings got swapped so they weren't in the correct hierarchy)

Change-Id: I8b7a8cd143e335dd27cd2dc6241fd25a6374bd5d
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
2018-11-13 14:44:17 -08:00

1.8 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

installation_guide/index developer_guide/index Project Specifications <https://docs.starlingx.io/specs/> api-ref/index releasenotes/index contributor/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>.