Add welcome page overview doc

Change-Id: I8005dd608bbaed3fcafcce56fc5dd9c307434a77
This commit is contained in:
Isaac Prior 2019-05-20 11:41:27 +01:00
parent b9246d9286
commit 4495910428
4 changed files with 49 additions and 2 deletions

View File

@ -1,4 +1,3 @@
======
Kayobe
======

View File

@ -0,0 +1,30 @@
Getting Started
---------------
We advise new users start by reading the :doc:`Architecture <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 <development/automated>` deployment or
the :ref:`'A Universe From Nothing' <a-universe-from-nothing>`
deployment guide.
Once familiar with Kayobe's constituent parts, move on to the
:doc:`Installation <installation>` section to prepare a baremetal environment
and then :doc:`Deployment <deployment>` to deploy to it.
* :doc:`Architecture <architecture>` - The function of Kayobe's host and
networking components
* :doc:`Installation <installation>` - The prerequisites and options for
installing Kayobe
* :doc:`Usage <usage>` - An introduction to the Kayobe CLI
* :doc:`Configuration <configuration/index>` - How to configure Kayobe's
various components
* :doc:`Deployment <deployment>`- Using Kayobe to deploy OpenStack
* :doc:`Upgrading <upgrading>` - Upgrading from one OpenStack release to
another
* :doc:`Administration <administration/index>` - Post-deploy administration
tasks
* :doc:`Resources <resources>` - External links to Kayobe resources
* :doc:`Development <development/index>` - Deploying Kayobe development
environments

View File

@ -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 <https://opendev.org/x/kayobe.git>`_. Feedback and contributions welcome,
see :doc:`contributing <development/contributing>` for information on how.
.. include:: ../../README.rst
Documentation
-------------
=============
.. include:: getting-started.rst
Contents
========
.. toctree::
:maxdepth: 2

View File

@ -4,6 +4,8 @@ Resources
This section contains links to external Kayobe resources.
.. _a-universe-from-nothing:
A Universe From Nothing
========================