Merge ~powersj/cloud-init:docs/toc_index_revamp into cloud-init:master

Proposed by Joshua Powers
Status: Merged
Approved by: Chad Smith
Approved revision: 973c09aa04efbaffc472d79daa440352919d608e
Merge reported by: Server Team CI bot
Merged at revision: not available
Proposed branch: ~powersj/cloud-init:docs/toc_index_revamp
Merge into: cloud-init:master
Diff against target: 105 lines (+59/-23)
1 file modified
doc/rtd/index.rst (+59/-23)
Reviewer Review Type Date Requested Status
Server Team CI bot continuous-integration Approve
Chad Smith Approve
Review via email: mp+372652@code.launchpad.net

Commit message

docs: organize TOC and update summary of project

To post a comment you must log in.
Revision history for this message
Server Team CI bot (server-team-bot) wrote :

PASSED: Continuous integration, rev:bc35e998985ad22df380720ac33554752859625c
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1124/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1124//rebuild

review: Approve (continuous-integration)
Revision history for this message
Server Team CI bot (server-team-bot) wrote :

PASSED: Continuous integration, rev:973c09aa04efbaffc472d79daa440352919d608e
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1161/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    SUCCESS: Ubuntu LTS: Integration
    IN_PROGRESS: Declarative: Post Actions

Click here to trigger a rebuild:
https://jenkins.ubuntu.com/server/job/cloud-init-ci/1161//rebuild

review: Approve (continuous-integration)
Revision history for this message
Chad Smith (chad.smith) wrote :

Looks much cleaner with the new toc.

review: Approve
Revision history for this message
Server Team CI bot (server-team-bot) wrote :

Autolanding: FAILED
More details in the following jenkins job:
https://jenkins.ubuntu.com/server/job/cloud-init-autoland-test/342/
Executed test runs:
    SUCCESS: Checkout
    SUCCESS: Unit & Style Tests
    SUCCESS: Ubuntu LTS: Build
    FAILED: Ubuntu LTS: Integration

review: Needs Fixing (continuous-integration)
Revision history for this message
Server Team CI bot (server-team-bot) :
review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/doc/rtd/index.rst b/doc/rtd/index.rst
2index c670b20..db1cdb4 100644
3--- a/doc/rtd/index.rst
4+++ b/doc/rtd/index.rst
5@@ -1,41 +1,77 @@
6 .. _index:
7
8-#############
9-Documentation
10-#############
11+cloud-init Documentation
12+########################
13
14-.. rubric:: Everything about cloud-init, a set of **python** scripts and
15- utilities to make your cloud images be all they can be!
16+Cloud-init is the *industry standard* multi-distribution method for
17+cross-platform cloud instance initialization. It is supported across all
18+major public cloud providers, provisioning systems for private cloud
19+infrastructure, and bare-metal installations.
20
21-*******
22-Summary
23-*******
24+Cloud instances are initialized from a disk image and instance data:
25
26-`Cloud-init`_ is the *defacto* multi-distribution package that handles early
27-initialization of a cloud instance.
28+- Cloud metadata
29+- User data (optional)
30+- Vendor data (optional)
31
32-----
33+Cloud-init will identify the cloud it is running on during boot, read any
34+provided metadata from the cloud and initialize the system accordingly. This
35+may involve setting up the network and storage devices to configuring SSH
36+access key and many other aspects of a system. Later on the cloud-init will
37+also parse and any optional user or vendor data that was passed to the
38+instance.
39+
40+Getting help
41+************
42+
43+Having trouble? We would like to help!
44+
45+- Try the :ref:`FAQ` – its got answers to some common questions
46+- Ask a question in the ``#cloud-init`` IRC channel on Freenode
47+- Join and ask questions on the `cloud-init mailing list <https://launchpad.net/~cloud-init>`_
48+- Find a bug? `Report bugs on Launchpad <https://bugs.launchpad.net/cloud-init/+filebug>`_
49
50 .. toctree::
51- :maxdepth: 2
52+ :hidden:
53+ :titlesonly:
54+ :caption: Getting Started
55
56- topics/capabilities.rst
57 topics/availability.rst
58+ topics/boot.rst
59+ topics/cli.rst
60+ topics/faq.rst
61+
62+.. toctree::
63+ :hidden:
64+ :titlesonly:
65+ :caption: User Data
66+
67 topics/format.rst
68- topics/instancedata.rst
69- topics/dir_layout.rst
70 topics/examples.rst
71- topics/boot.rst
72- topics/datasources.rst
73- topics/logging.rst
74 topics/modules.rst
75 topics/merging.rst
76- topics/network-config.rst
77+
78+.. toctree::
79+ :hidden:
80+ :titlesonly:
81+ :caption: Instance Data
82+
83+ topics/instancedata.rst
84+ topics/datasources.rst
85 topics/vendordata.rst
86- topics/debugging.rst
87- topics/moreinfo.rst
88+ topics/network-config.rst
89+
90+.. toctree::
91+ :hidden:
92+ :titlesonly:
93+ :caption: Development
94+
95 topics/hacking.rst
96+ topics/debugging.rst
97+ topics/logging.rst
98+ topics/dir_layout.rst
99+ topics/analyze.rst
100+ topics/docs.rst
101 topics/tests.rst
102
103-.. _Cloud-init: https://launchpad.net/cloud-init
104-.. vi: textwidth=78
105+.. vi: textwidth=79

Subscribers

People subscribed via source and target branches