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