1. devstack
  2. Commit 26dd21be8cbf789a8774c9a1941b364a497c4643
Browse code

One last format and content cleanup for the index page

Update the form of the links to other documents in the tree;
the generated HTML links must remain in the original form.
The layout is changed from the previous tables to a more Sphinx-y
TOC-like list.

Also editorial changes to the index page and guide titles

Change-Id: I52df0cc542754c386fb3c99d9efdf2524c11bf48

Dean Troyer authored on 2014/11/07 00:33:02
Showing 4 changed files
doc/source/guides/single-machine.rst
History View file @ 26dd21b
... ... 
@@ -1,6 +1,6 @@
1 
-==========
2 
-All-In-One
3 
-==========
1 
+=========================
2 
+All-In-One Single Machine
3 
+=========================
4 4
5 5 
 Things are about to get real! Using OpenStack in containers or VMs is
6 6 
 nice for kicking the tires, but doesn't compare to the feeling you get
doc/source/guides/single-vm.rst
History View file @ 26dd21b
... ... 
@@ -1,6 +1,6 @@
1 
-=============
2 
-Cloud in a VM
3 
-=============
1 
+====================
2 
+All-In-One Single VM
3 
+====================
4 4
5 5 
 Use the cloud to build the cloud! Use your cloud to launch new versions
6 6 
 of OpenStack in about 5 minutes. When you break it, start over! The VMs
doc/source/index.rst
History View file @ 26dd21b
... ... 
@@ -12,11 +12,8 @@ DevStack - an OpenStack Community Production
12 12 
    changes
13 13 
    contributing
14 14
15 
-   guides/*
16 
-
17 
-
18 
-Quick Start This ain't your first rodeo
15 
+Quick Start
16 
+-----------
19 17
20 18 
 #. Select a Linux Distribution
21 19
... ... 
@@ -59,40 +56,36 @@ Guides
59 59
60 60 
 Walk through various setups used by stackers
61 61
62 
-OpenStack on VMs
62 
+.. toctree::
63 
+   :glob:
64 
+   :maxdepth: 1
63 65
64 
-These guides tell you how to virtualize your OpenStack cloud in virtual
65 
-machines. This means that you can get started without having to purchase
66 
-any hardware.
66 
+   guides/single-vm
67 
+   guides/single-machine
68 
+   guides/multinode-lab
67 69
68 
-Virtual Machine
69 
-~~~~~~~~~~~~~~~
70 
+All-In-One Single VM
71 
+--------------------
70 72
71 
-:doc:`Run OpenStack in a VM <guides/single-vm>`. The VMs launched in your cloud will be slow as
73 
+Run :doc:`OpenStack in a VM <guides/single-vm>`. The VMs launched in your cloud will be slow as
72 74 
 they are running in QEMU (emulation), but it is useful if you don't have
73 75 
 spare hardware laying around. :doc:`[Read] <guides/single-vm>`
74 76
75 
-OpenStack on Hardware
77 
+All-In-One Single Machine
78 
+-------------------------
76 79
77 
-These guides tell you how to deploy a development environment on real
78 
-hardware. Guides range from running OpenStack on a single laptop to
79 
-running a multi-node deployment on datacenter hardware.
80 
+Run :doc:`OpenStack on dedicated hardware <guides/single-machine>`  This can include a
81 
+server-class machine or a laptop at home.
82 
+:doc:`[Read] <guides/single-machine>`
80 83
81 
-All-In-One
82 
-~~~~~~~~~~
83 
-
84 
-:doc:`Run OpenStack on dedicated hardware <guides/single-machine>` to get real performance in your VMs.
85 
-This can include a server-class machine or a laptop at home. :doc:`[Read] <guides/single-machine>`
86 
-
87 
-Multi-Node + VLANs
88 
-~~~~~~~~~~~~~~~~~~
84 
+Multi-Node Lab
85 
+--------------
89 86
90 
-:doc:`Setup a multi-node cluster <guides/multinode-lab>` with dedicated VLANs for VMs & Management. :doc:`[Read] <guides/multinode-lab>`
87 
+Setup a :doc:`multi-node cluster <guides/multinode-lab>` with dedicated VLANs for VMs & Management.
88 
+:doc:`[Read] <guides/multinode-lab>`
91 89
92 
-Documentation
93 
-=============
90 
+DevStack Documentation
91 
+======================
94 92
95 93 
 Overview
96 94 
 --------
... ... 
@@ -127,187 +120,102 @@ Contributing
127 127 
 Code
128 128 
 ====
129 129
130 
-A look at the bits that make it all go
130 
+*A look at the bits that make it all go*
131 131
132 132 
 Scripts
133 133 
 -------
134 134
135 
-Generated documentation of DevStack scripts.
136 
-
137 
-+-------------------------------+----------------------------------------------+
138 
-| Filename                      | Link                                         |
139 
-+===============================+==============================================+
140 
-| stack.sh                      | `Read » <stack.sh.html>`__                   |
141 
-+-------------------------------+----------------------------------------------+
142 
-| functions                     | `Read » <functions.html>`__                  |
143 
-+-------------------------------+----------------------------------------------+
144 
-| functions-common              | `Read » <functions-common.html>`__           |
145 
-+-------------------------------+----------------------------------------------+
146 
-| lib/apache                    | `Read » <lib/apache.html>`__                 |
147 
-+-------------------------------+----------------------------------------------+
148 
-| lib/baremetal                 | `Read » <lib/baremetal.html>`__              |
149 
-+-------------------------------+----------------------------------------------+
150 
-| lib/ceilometer                | `Read » <lib/ceilometer.html>`__             |
151 
-+-------------------------------+----------------------------------------------+
152 
-| lib/cinder                    | `Read » <lib/cinder.html>`__                 |
153 
-+-------------------------------+----------------------------------------------+
154 
-| lib/config                    | `Read » <lib/config.html>`__                 |
155 
-+-------------------------------+----------------------------------------------+
156 
-| lib/database                  | `Read » <lib/database.html>`__               |
157 
-+-------------------------------+----------------------------------------------+
158 
-| lib/glance                    | `Read » <lib/glance.html>`__                 |
159 
-+-------------------------------+----------------------------------------------+
160 
-| lib/heat                      | `Read » <lib/heat.html>`__                   |
161 
-+-------------------------------+----------------------------------------------+
162 
-| lib/horizon                   | `Read » <lib/horizon.html>`__                |
163 
-+-------------------------------+----------------------------------------------+
164 
-| lib/infra                     | `Read » <lib/infra.html>`__                  |
165 
-+-------------------------------+----------------------------------------------+
166 
-| lib/ironic                    | `Read » <lib/ironic.html>`__                 |
167 
-+-------------------------------+----------------------------------------------+
168 
-| lib/keystone                  | `Read » <lib/keystone.html>`__               |
169 
-+-------------------------------+----------------------------------------------+
170 
-| lib/ldap                      | `Read » <lib/ldap.html>`__                   |
171 
-+-------------------------------+----------------------------------------------+
172 
-| lib/zaqar                     | `Read » <lib/zaqar.html>`__                  |
173 
-+-------------------------------+----------------------------------------------+
174 
-| lib/neutron                   | `Read » <lib/neutron.html>`__                |
175 
-+-------------------------------+----------------------------------------------+
176 
-| lib/nova                      | `Read » <lib/nova.html>`__                   |
177 
-+-------------------------------+----------------------------------------------+
178 
-| lib/oslo                      | `Read » <lib/oslo.html>`__                   |
179 
-+-------------------------------+----------------------------------------------+
180 
-| lib/rpc\_backend              | `Read » <lib/rpc_backend.html>`__            |
181 
-+-------------------------------+----------------------------------------------+
182 
-| lib/sahara                    | `Read » <lib/sahara.html>`__                 |
183 
-+-------------------------------+----------------------------------------------+
184 
-| lib/savanna                   | `Read » <lib/savanna.html>`__                |
185 
-+-------------------------------+----------------------------------------------+
186 
-| lib/stackforge                | `Read » <lib/stackforge.html>`__             |
187 
-+-------------------------------+----------------------------------------------+
188 
-| lib/swift                     | `Read » <lib/swift.html>`__                  |
189 
-+-------------------------------+----------------------------------------------+
190 
-| lib/tempest                   | `Read » <lib/tempest.html>`__                |
191 
-+-------------------------------+----------------------------------------------+
192 
-| lib/tls                       | `Read » <lib/tls.html>`__                    |
193 
-+-------------------------------+----------------------------------------------+
194 
-| lib/trove                     | `Read » <lib/trove.html>`__                  |
195 
-+-------------------------------+----------------------------------------------+
196 
-| unstack.sh                    | `Read » <unstack.sh.html>`__                 |
197 
-+-------------------------------+----------------------------------------------+
198 
-| clean.sh                      | `Read » <clean.sh.html>`__                   |
199 
-+-------------------------------+----------------------------------------------+
200 
-| run\_tests.sh                 | `Read » <run_tests.sh.html>`__               |
201 
-+-------------------------------+----------------------------------------------+
202 
-| extras.d/50-ironic.sh         | `Read » <extras.d/50-ironic.html>`__         |
203 
-+-------------------------------+----------------------------------------------+
204 
-| extras.d/70-zaqar.sh          | `Read » <extras.d/70-zaqar.html>`__          |
205 
-+-------------------------------+----------------------------------------------+
206 
-| extras.d/70-sahara.sh         | `Read » <extras.d/70-sahara.html>`__         |
207 
-+-------------------------------+----------------------------------------------+
208 
-| extras.d/70-savanna.sh        | `Read » <extras.d/70-savanna.html>`__        |
209 
-+-------------------------------+----------------------------------------------+
210 
-| extras.d/70-trove.sh          | `Read » <extras.d/70-trove.html>`__          |
211 
-+-------------------------------+----------------------------------------------+
212 
-| extras.d/80-opendaylight.sh   | `Read » <extras.d/80-opendaylight.html>`__   |
213 
-+-------------------------------+----------------------------------------------+
214 
-| extras.d/80-tempest.sh        | `Read » <extras.d/80-tempest.html>`__        |
215 
-+-------------------------------+----------------------------------------------+
135 
+* `stack.sh <stack.sh.html>`__ - The main script
136 
+* `functions <functions.html>`__ - DevStack-specific functions
137 
+* `functions-common <functions-common.html>`__ - Functions shared with other projects
138 
+* `lib/apache <lib/apache.html>`__
139 
+* `lib/baremetal <lib/baremetal.html>`__
140 
+* `lib/ceilometer <lib/ceilometer.html>`__
141 
+* `lib/ceph <lib/ceph.html>`__
142 
+* `lib/cinder <lib/cinder.html>`__
143 
+* `lib/config <lib/config.html>`__
144 
+* `lib/database <lib/database.html>`__
145 
+* `lib/dib <lib/dib.html>`__
146 
+* `lib/dstat <lib/dstat.html>`__
147 
+* `lib/glance <lib/glance.html>`__
148 
+* `lib/heat <lib/heat.html>`__
149 
+* `lib/horizon <lib/horizon.html>`__
150 
+* `lib/infra <lib/infra.html>`__
151 
+* `lib/ironic <lib/ironic.html>`__
152 
+* `lib/keystone <lib/keystone.html>`__
153 
+* `lib/ldap <lib/ldap.html>`__
154 
+* `lib/neutron <lib/neutron.html>`__
155 
+* `lib/nova <lib/nova.html>`__
156 
+* `lib/opendaylight <lib/opendaylight.html>`__
157 
+* `lib/oslo <lib/oslo.html>`__
158 
+* `lib/rpc\_backend <lib/rpc_backend.html>`__
159 
+* `lib/sahara <lib/sahara.html>`__
160 
+* `lib/stackforge <lib/stackforge.html>`__
161 
+* `lib/swift <lib/swift.html>`__
162 
+* `lib/tempest <lib/tempest.html>`__
163 
+* `lib/tls <lib/tls.html>`__
164 
+* `lib/trove <lib/trove.html>`__
165 
+* `lib/zaqar <lib/zaqar.html>`__
166 
+* `unstack.sh <unstack.sh.html>`__
167 
+* `clean.sh <clean.sh.html>`__
168 
+* `run\_tests.sh <run_tests.sh.html>`__
169 
+
170 
+* `extras.d/40-dib.sh <extras.d/40-dib.sh.html>`__
171 
+* `extras.d/50-ironic.sh <extras.d/50-ironic.sh.html>`__
172 
+* `extras.d/60-ceph.sh <extras.d/60-ceph.sh.html>`__
173 
+* `extras.d/70-sahara.sh <extras.d/70-sahara.sh.html>`__
174 
+* `extras.d/70-trove.sh <extras.d/70-trove.sh.html>`__
175 
+* `extras.d/70-zaqar.sh <extras.d/70-zaqar.sh.html>`__
176 
+* `extras.d/80-opendaylight.sh <extras.d/80-opendaylight.sh.html>`__
177 
+* `extras.d/80-tempest.sh <extras.d/80-tempest.sh.html>`__
216 178
217 179 
 Configuration
218 180 
 -------------
219 181
220 
-+--------------+--------------------------------+
221 
-| Filename     | Link                           |
222 
-+==============+================================+
223 
-| local.conf   | `Read » <local.conf.html>`__   |
224 
-+--------------+--------------------------------+
225 
-| stackrc      | `Read » <stackrc.html>`__      |
226 
-+--------------+--------------------------------+
227 
-| openrc       | `Read » <openrc.html>`__       |
228 
-+--------------+--------------------------------+
229 
-| exerciserc   | `Read » <exerciserc.html>`__   |
230 
-+--------------+--------------------------------+
231 
-| eucarc       | `Read » <eucarc.html>`__       |
232 
-+--------------+--------------------------------+
182 
+.. toctree::
183 
+   :glob:
184 
+   :maxdepth: 1
185 
+
186 
+   local.conf
187 
+   stackrc
188 
+   openrc
189 
+   exerciserc
190 
+   eucarc
233 191
234 192 
 Tools
235 193 
 -----
236 194
237 
-+-----------------------------+----------------------------------------------+
238 
-| Filename                    | Link                                         |
239 
-+=============================+==============================================+
240 
-| tools/info.sh               | `Read » <tools/info.sh.html>`__              |
241 
-+-----------------------------+----------------------------------------------+
242 
-| tools/build\_docs.sh        | `Read » <tools/build_docs.sh.html>`__        |
243 
-+-----------------------------+----------------------------------------------+
244 
-| tools/create\_userrc.sh     | `Read » <tools/create_userrc.sh.html>`__     |
245 
-+-----------------------------+----------------------------------------------+
246 
-| tools/fixup\_stuff.sh       | `Read » <tools/fixup_stuff.sh.html>`__       |
247 
-+-----------------------------+----------------------------------------------+
248 
-| tools/install\_prereqs.sh   | `Read » <tools/install_prereqs.sh.html>`__   |
249 
-+-----------------------------+----------------------------------------------+
250 
-| tools/install\_pip.sh       | `Read » <tools/install_pip.sh.html>`__       |
251 
-+-----------------------------+----------------------------------------------+
252 
-| tools/upload\_image.sh      | `Read » <tools/upload_image.sh.html>`__      |
253 
-+-----------------------------+----------------------------------------------+
195 
+* `tools/build\_docs.sh <tools/build_docs.sh.html>`__
196 
+* `tools/create-stack-user.sh <tools/create-stack-user.sh.html>`__
197 
+* `tools/create\_userrc.sh <tools/create_userrc.sh.html>`__
198 
+* `tools/fixup\_stuff.sh <tools/fixup_stuff.sh.html>`__
199 
+* `tools/info.sh <tools/info.sh.html>`__
200 
+* `tools/install\_pip.sh <tools/install_pip.sh.html>`__
201 
+* `tools/install\_prereqs.sh <tools/install_prereqs.sh.html>`__
202 
+* `tools/make\_cert.sh <tools/make_cert.sh.html>`__
203 
+* `tools/upload\_image.sh <tools/upload_image.sh.html>`__
254 204
255 205 
 Samples
256 206 
 -------
257 207
258 
-Generated documentation of DevStack sample files.
259 
-
260 
-+------------+--------------------------------------+
261 
-| Filename   | Link                                 |
262 
-+============+======================================+
263 
-| local.sh   | `Read » <samples/local.sh.html>`__   |
264 
-+------------+--------------------------------------+
265 
-| localrc    | `Read » <samples/localrc.html>`__    |
266 
-+------------+--------------------------------------+
208 
+* `local.sh <samples/local.sh.html>`__
267 209
268 210 
 Exercises
269 211 
 ---------
270 212
271 
-+---------------------------------+-------------------------------------------------+
272 
-| Filename                        | Link                                            |
273 
-+=================================+=================================================+
274 
-| exercise.sh                     | `Read » <exercise.sh.html>`__                   |
275 
-+---------------------------------+-------------------------------------------------+
276 
-| exercises/aggregates.sh         | `Read » <exercises/aggregates.sh.html>`__       |
277 
-+---------------------------------+-------------------------------------------------+
278 
-| exercises/boot\_from\_volume.sh | `Read » <exercises/boot_from_volume.sh.html>`__ |
279 
-+---------------------------------+-------------------------------------------------+
280 
-| exercises/bundle.sh             | `Read » <exercises/bundle.sh.html>`__           |
281 
-+---------------------------------+-------------------------------------------------+
282 
-| exercises/client-args.sh        | `Read » <exercises/client-args.sh.html>`__      |
283 
-+---------------------------------+-------------------------------------------------+
284 
-| exercises/client-env.sh         | `Read » <exercises/client-env.sh.html>`__       |
285 
-+---------------------------------+-------------------------------------------------+
286 
-| exercises/euca.sh               | `Read » <exercises/euca.sh.html>`__             |
287 
-+---------------------------------+-------------------------------------------------+
288 
-| exercises/floating\_ips.sh      | `Read » <exercises/floating_ips.sh.html>`__     |
289 
-+---------------------------------+-------------------------------------------------+
290 
-| exercises/horizon.sh            | `Read » <exercises/horizon.sh.html>`__          |
291 
-+---------------------------------+-------------------------------------------------+
292 
-| exercises/neutron-adv-test.sh   | `Read » <exercises/neutron-adv-test.sh.html>`__ |
293 
-+---------------------------------+-------------------------------------------------+
294 
-| exercises/sahara.sh             | `Read » <exercises/sahara.sh.html>`__           |
295 
-+---------------------------------+-------------------------------------------------+
296 
-| exercises/savanna.sh            | `Read » <exercises/savanna.sh.html>`__          |
297 
-+---------------------------------+-------------------------------------------------+
298 
-| exercises/sec\_groups.sh        | `Read » <exercises/sec_groups.sh.html>`__       |
299 
-+---------------------------------+-------------------------------------------------+
300 
-| exercises/swift.sh              | `Read » <exercises/swift.sh.html>`__            |
301 
-+---------------------------------+-------------------------------------------------+
302 
-| exercises/trove.sh              | `Read » <exercises/trove.sh.html>`__            |
303 
-+---------------------------------+-------------------------------------------------+
304 
-| exercises/volumes.sh            | `Read » <exercises/volumes.sh.html>`__          |
305 
-+---------------------------------+-------------------------------------------------+
306 
-| exercises/zaqar.sh              | `Read » <exercises/zaqar.sh.html>`__            |
307 
-+---------------------------------+-------------------------------------------------+
308 
-
309 
-.. toctree::
310 
-   :glob:
311 
-   :maxdepth: 1
312 
-
313 
-   *
213 
+* `exercise.sh <exercise.sh.html>`__
214 
+* `exercises/aggregates.sh <exercises/aggregates.sh.html>`__
215 
+* `exercises/boot\_from\_volume.sh <exercises/boot_from_volume.sh.html>`__
216 
+* `exercises/bundle.sh <exercises/bundle.sh.html>`__
217 
+* `exercises/client-args.sh <exercises/client-args.sh.html>`__
218 
+* `exercises/client-env.sh <exercises/client-env.sh.html>`__
219 
+* `exercises/euca.sh <exercises/euca.sh.html>`__
220 
+* `exercises/floating\_ips.sh <exercises/floating_ips.sh.html>`__
221 
+* `exercises/horizon.sh <exercises/horizon.sh.html>`__
222 
+* `exercises/neutron-adv-test.sh <exercises/neutron-adv-test.sh.html>`__
223 
+* `exercises/sahara.sh <exercises/sahara.sh.html>`__
224 
+* `exercises/sec\_groups.sh <exercises/sec_groups.sh.html>`__
225 
+* `exercises/swift.sh <exercises/swift.sh.html>`__
226 
+* `exercises/trove.sh <exercises/trove.sh.html>`__
227 
+* `exercises/volumes.sh <exercises/volumes.sh.html>`__
228 
+* `exercises/zaqar.sh <exercises/zaqar.sh.html>`__
doc/source/localrc.rst
History View file @ 26dd21b
314 229 
deleted file mode 100644
... ... 
@@ -1,9 +0,0 @@
1 
-=====================
2 
-localrc - The Old Way
3 
-=====================
4 
-
5 
-``localrc`` is the old file used to configure DevStack. It is deprecated
6 
-and has been replaced by ```local.conf`` <local.conf.html>`__. DevStack
7 
-will continue to use ``localrc`` if it is present and ignore the
8 
-``localrc`` section in ``local.conf.``. Remove ``localrc`` to switch to
9 
-using the new file.