diff --git a/README.rst b/README.rst index d4fb28b73..ea6ae16fe 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,3 @@ -====== Kayobe ====== diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst new file mode 100644 index 000000000..5f2fdad83 --- /dev/null +++ b/doc/source/getting-started.rst @@ -0,0 +1,30 @@ +Getting Started +--------------- + +We advise new users start by reading the :doc:`Architecture ` +documentation first in order to understand Kayobe's various components. + +For users wishing to learn interactively we recommend starting at either +the :doc:`all-in-one overcloud ` deployment or +the :ref:`'A Universe From Nothing' ` +deployment guide. + +Once familiar with Kayobe's constituent parts, move on to the +:doc:`Installation ` section to prepare a baremetal environment +and then :doc:`Deployment ` to deploy to it. + +* :doc:`Architecture ` - The function of Kayobe's host and + networking components +* :doc:`Installation ` - The prerequisites and options for + installing Kayobe +* :doc:`Usage ` - An introduction to the Kayobe CLI +* :doc:`Configuration ` - How to configure Kayobe's + various components +* :doc:`Deployment `- Using Kayobe to deploy OpenStack +* :doc:`Upgrading ` - Upgrading from one OpenStack release to + another +* :doc:`Administration ` - Post-deploy administration + tasks +* :doc:`Resources ` - External links to Kayobe resources +* :doc:`Development ` - Deploying Kayobe development + environments diff --git a/doc/source/index.rst b/doc/source/index.rst index b3f41d793..1a7e62d5f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,13 +3,29 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +================================== Welcome to Kayobe's documentation! ================================== +Overview +======== + +Welcome to the Kayobe documentation, the official source of information for +understanding and using Kayobe. + +This documentation is maintained at opendev.org +`here `_. Feedback and contributions welcome, +see :doc:`contributing ` for information on how. + .. include:: ../../README.rst Documentation -------------- +============= + +.. include:: getting-started.rst + +Contents +======== .. toctree:: :maxdepth: 2 diff --git a/doc/source/resources.rst b/doc/source/resources.rst index 11fea507a..ae9570cac 100644 --- a/doc/source/resources.rst +++ b/doc/source/resources.rst @@ -4,6 +4,8 @@ Resources This section contains links to external Kayobe resources. +.. _a-universe-from-nothing: + A Universe From Nothing ========================