docs/doc/source/index.rst
Keane Lim ceea9dda0d Storage Guide update
Applied review feedback.

Fixed 'grey bars' formatting.
Fixed gerunds and lists
Added abbreviations and references

Change-Id: I104d678ce3ea52bddcbc141f8aad49ea1e1971db
Signed-off-by: Keane Lim <keane.lim@windriver.com>
2021-02-09 12:50:24 -05:00

3.4 KiB
Executable File

Welcome to the StarlingX Documentation

StarlingX is a fully integrated edge cloud software stack that provides everything needed to deploy an edge cloud on one, two, or up to 100 servers.

The most recent supported release of StarlingX is StarlingX R4.0.

For more information about the StarlingX project, refer to the StarlingX wiki.

Note

Community contributions to the documentation are welcome! If you see an empty topic and want to contribute, refer to the linked story in the topic for details.

See our Contributor guide </contributor/index> for more information.

Get started

To get started fast with StarlingX, try the Virtual All-in-one Simplex installation </deploy_install_guides/r4_release/virtual/aio_simplex>, which requires a minimum of hardware and configuration.

Learn more about StarlingX:

introduction/index

Planning

planning/index

Deployment guides

deploy/index

Installation guides

deploy_install_guides/index

Configuration

configuration/index

Data Network Configuration and Management Guides

datanet/index

Node Management

node_management/index

System Configuration

system_configuration/index

Fault Management

fault-mgmt/index

Admin Tasks

admintasks/index

User Tasks

usertasks/index

Storage

storage/index

Operation guides

operations/index

Backup and restore

backup/index

Reference

api-ref/index cli_ref/index

General information

contributor/index releasenotes/index developer_resources/index

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.