summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoshua Powers <josh.powers@canonical.com>2019-09-18 11:45:47 +0000
committerServer Team CI Bot <josh.powers+server-team-bot@canonical.com>2019-09-18 11:45:47 +0000
commit4df0065998961ad21a9b733fb23ae2ebd78b7380 (patch)
treef9186538aef24335186faf1ba5b0fb2d559d7aea
parentac8ef3eed1ca78d779b9fc414439e5dc4153735c (diff)
downloadvyos-cloud-init-4df0065998961ad21a9b733fb23ae2ebd78b7380.tar.gz
vyos-cloud-init-4df0065998961ad21a9b733fb23ae2ebd78b7380.zip
docs: organize TOC and update summary of project
-rw-r--r--doc/rtd/index.rst82
1 files changed, 59 insertions, 23 deletions
diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst
index c670b20e..db1cdb49 100644
--- a/doc/rtd/index.rst
+++ b/doc/rtd/index.rst
@@ -1,41 +1,77 @@
.. _index:
-#############
-Documentation
-#############
+cloud-init Documentation
+########################
-.. rubric:: Everything about cloud-init, a set of **python** scripts and
- utilities to make your cloud images be all they can be!
+Cloud-init is the *industry standard* multi-distribution method for
+cross-platform cloud instance initialization. It is supported across all
+major public cloud providers, provisioning systems for private cloud
+infrastructure, and bare-metal installations.
-*******
-Summary
-*******
+Cloud instances are initialized from a disk image and instance data:
-`Cloud-init`_ is the *defacto* multi-distribution package that handles early
-initialization of a cloud instance.
+- Cloud metadata
+- User data (optional)
+- Vendor data (optional)
-----
+Cloud-init will identify the cloud it is running on during boot, read any
+provided metadata from the cloud and initialize the system accordingly. This
+may involve setting up the network and storage devices to configuring SSH
+access key and many other aspects of a system. Later on the cloud-init will
+also parse and any optional user or vendor data that was passed to the
+instance.
+
+Getting help
+************
+
+Having trouble? We would like to help!
+
+- Try the :ref:`FAQ` – its got answers to some common questions
+- Ask a question in the ``#cloud-init`` IRC channel on Freenode
+- Join and ask questions on the `cloud-init mailing list <https://launchpad.net/~cloud-init>`_
+- Find a bug? `Report bugs on Launchpad <https://bugs.launchpad.net/cloud-init/+filebug>`_
.. toctree::
- :maxdepth: 2
+ :hidden:
+ :titlesonly:
+ :caption: Getting Started
- topics/capabilities.rst
topics/availability.rst
+ topics/boot.rst
+ topics/cli.rst
+ topics/faq.rst
+
+.. toctree::
+ :hidden:
+ :titlesonly:
+ :caption: User Data
+
topics/format.rst
- topics/instancedata.rst
- topics/dir_layout.rst
topics/examples.rst
- topics/boot.rst
- topics/datasources.rst
- topics/logging.rst
topics/modules.rst
topics/merging.rst
- topics/network-config.rst
+
+.. toctree::
+ :hidden:
+ :titlesonly:
+ :caption: Instance Data
+
+ topics/instancedata.rst
+ topics/datasources.rst
topics/vendordata.rst
- topics/debugging.rst
- topics/moreinfo.rst
+ topics/network-config.rst
+
+.. toctree::
+ :hidden:
+ :titlesonly:
+ :caption: Development
+
topics/hacking.rst
+ topics/debugging.rst
+ topics/logging.rst
+ topics/dir_layout.rst
+ topics/analyze.rst
+ topics/docs.rst
topics/tests.rst
-.. _Cloud-init: https://launchpad.net/cloud-init
-.. vi: textwidth=78
+.. vi: textwidth=79