There were a lot of artifacts left from the HTML translation.
The toctree at the end is to suppress the errors until the remaining
docs are cleaned up.
Change-Id: I4a8f29f0be524d0a15c7c6f590ffc3ceed6ff811
| ... | ... |
@@ -1,40 +1,19 @@ |
| 1 |
-`DevStack </>`__ |
|
| 2 |
- |
|
| 3 |
-- `Overview <overview.rst>`__ |
|
| 4 |
-- `Changes <changes.rst>`__ |
|
| 5 |
-- `FAQ <faq.rst>`__ |
|
| 6 |
-- `git.openstack.org <https://git.openstack.org/cgit/openstack-dev/devstack>`__ |
|
| 7 |
-- `Gerrit <https://review.openstack.org/#/q/status:open+project:openstack-dev/devstack,n,z>`__ |
|
| 8 |
- |
|
| 9 |
-.. toctree:: |
|
| 10 |
- :glob: |
|
| 11 |
- :maxdepth: 2 |
|
| 12 |
- |
|
| 13 |
- * |
|
| 14 |
- guides/* |
|
| 15 |
- |
|
| 16 |
- |
|
| 17 |
- |
|
| 18 | 1 |
DevStack - an OpenStack Community Production |
| 19 | 2 |
============================================ |
| 20 | 3 |
|
| 21 |
-| A documented shell script to build complete OpenStack development environments. |
|
| 22 |
-| An OpenStack program maintained by the developer community. |
|
| 23 |
- |
|
| 24 |
-#. Setup a fresh supported Linux installation. |
|
| 25 |
-#. Clone devstack from git.openstack.org. |
|
| 26 |
- |
|
| 27 |
- :: |
|
| 28 |
- |
|
| 29 |
- git clone https://git.openstack.org/openstack-dev/devstack |
|
| 30 |
- |
|
| 31 |
-#. Deploy your OpenStack Cloud |
|
| 4 |
+.. toctree:: |
|
| 5 |
+ :glob: |
|
| 6 |
+ :maxdepth: 1 |
|
| 32 | 7 |
|
| 33 |
- :: |
|
| 8 |
+ overview |
|
| 9 |
+ configuration |
|
| 10 |
+ plugins |
|
| 11 |
+ faq |
|
| 12 |
+ changes |
|
| 13 |
+ contributing |
|
| 34 | 14 |
|
| 35 |
- cd devstack && ./stack.sh |
|
| 15 |
+ guides/* |
|
| 36 | 16 |
|
| 37 |
- |
|
| 38 | 17 |
|
| 39 | 18 |
Quick Start This ain't your first rodeo |
| 40 | 19 |
--------------------------------------- |
| ... | ... |
@@ -75,68 +54,45 @@ Quick Start This ain't your first rodeo |
| 75 | 75 |
It takes a few minutes, we recommend `reading the |
| 76 | 76 |
script <stack.sh.html>`__ while it is building. |
| 77 | 77 |
|
| 78 |
-Guides Walk through various setups used by stackers |
|
| 78 |
+Guides |
|
| 79 |
+====== |
|
| 80 |
+ |
|
| 81 |
+Walk through various setups used by stackers |
|
| 79 | 82 |
|
| 80 | 83 |
OpenStack on VMs |
| 81 | 84 |
---------------- |
| 82 | 85 |
|
| 83 |
-Title |
|
| 84 |
- |
|
| 85 |
-Description |
|
| 86 |
- |
|
| 87 |
-Link |
|
| 86 |
+These guides tell you how to virtualize your OpenStack cloud in virtual |
|
| 87 |
+machines. This means that you can get started without having to purchase |
|
| 88 |
+any hardware. |
|
| 88 | 89 |
|
| 89 | 90 |
Virtual Machine |
| 91 |
+~~~~~~~~~~~~~~~ |
|
| 90 | 92 |
|
| 91 |
-Run OpenStack in a VM. The VMs launched in your cloud will be slow as |
|
| 93 |
+`Run OpenStack in a VM <guides/single-vm.html>`__. The VMs launched in your cloud will be slow as |
|
| 92 | 94 |
they are running in QEMU (emulation), but it is useful if you don't have |
| 93 |
-spare hardware laying around. |
|
| 94 |
- |
|
| 95 |
-`Read » <guides/single-vm.html>`__ |
|
| 96 |
- |
|
| 97 |
-1 Guide |
|
| 98 |
- |
|
| 99 |
-What is this? |
|
| 100 |
-^^^^^^^^^^^^^ |
|
| 101 |
- |
|
| 102 |
-These guides tell you how to virtualize your OpenStack cloud in virtual |
|
| 103 |
-machines. This means that you can get started without having to purchase |
|
| 104 |
-any hardware. |
|
| 95 |
+spare hardware laying around. `[Read] <guides/single-vm.html>`__ |
|
| 105 | 96 |
|
| 106 | 97 |
OpenStack on Hardware |
| 107 | 98 |
--------------------- |
| 108 | 99 |
|
| 109 |
-Title |
|
| 110 |
- |
|
| 111 |
-Description |
|
| 112 |
- |
|
| 113 |
-Link |
|
| 100 |
+These guides tell you how to deploy a development environment on real |
|
| 101 |
+hardware. Guides range from running OpenStack on a single laptop to |
|
| 102 |
+running a multi-node deployment on datacenter hardware. |
|
| 114 | 103 |
|
| 115 | 104 |
All-In-One |
| 105 |
+~~~~~~~~~~ |
|
| 116 | 106 |
|
| 117 |
-Run OpenStack on dedicated hardware to get real performance in your VMs. |
|
| 118 |
-This can include a server-class machine or a laptop at home. |
|
| 119 |
- |
|
| 120 |
-`Read » <guides/single-machine.html>`__ |
|
| 107 |
+`Run OpenStack on dedicated hardware <guides/single-machine.html>`__ to get real performance in your VMs. |
|
| 108 |
+This can include a server-class machine or a laptop at home. `[Read] <guides/single-machine.html>`__ |
|
| 121 | 109 |
|
| 122 | 110 |
Multi-Node + VLANs |
| 111 |
+~~~~~~~~~~~~~~~~~~ |
|
| 123 | 112 |
|
| 124 |
-Setup a multi-node cluster with dedicated VLANs for VMs & Management. |
|
| 125 |
- |
|
| 126 |
-`Read » <guides/multinode-lab.html>`__ |
|
| 127 |
- |
|
| 128 |
-2 Guides |
|
| 129 |
- |
|
| 130 |
-What is this? |
|
| 131 |
-^^^^^^^^^^^^^ |
|
| 113 |
+`Setup a multi-node cluster <guides/multinode-lab.html>`__ with dedicated VLANs for VMs & Management. `[Read] <guides/multinode-lab.html>`__ |
|
| 132 | 114 |
|
| 133 |
-These guides tell you how to deploy a development environment on real |
|
| 134 |
-hardware. Guides range from running OpenStack on a single laptop to |
|
| 135 |
-running a multi-node deployment on datacenter hardware. |
|
| 136 |
- |
|
| 137 |
-Documentation Help yourself to stack |
|
| 115 |
+Documentation |
|
| 116 |
+============= |
|
| 138 | 117 |
|
| 139 | 118 |
Overview |
| 140 | 119 |
-------- |
| ... | ... |
@@ -168,11 +124,15 @@ Contributing |
| 168 | 168 |
|
| 169 | 169 |
`Pitching in to make DevStack a better place <contributing.html>`__ |
| 170 | 170 |
|
| 171 |
-Code A look at the bits that make it all go |
|
| 171 |
+Code |
|
| 172 |
+==== |
|
| 173 |
+ |
|
| 174 |
+A look at the bits that make it all go |
|
| 175 |
+ |
|
| 176 |
+Scripts |
|
| 177 |
+------- |
|
| 172 | 178 |
|
| 173 |
-Scripts Generated documentation of DevStack scripts. |
|
| 179 |
+Generated documentation of DevStack scripts. |
|
| 174 | 180 |
|
| 175 | 181 |
+-------------------------------+----------------------------------------------+ |
| 176 | 182 |
| Filename | Link | |
| ... | ... |
@@ -254,8 +214,8 @@ Scripts Generated documentation of DevStack scripts. |
| 254 | 254 |
| extras.d/80-tempest.sh | `Read » <extras.d/80-tempest.html>`__ | |
| 255 | 255 |
+-------------------------------+----------------------------------------------+ |
| 256 | 256 |
|
| 257 |
-Configuration Setting the table |
|
| 257 |
+Configuration |
|
| 258 |
+------------- |
|
| 258 | 259 |
|
| 259 | 260 |
+--------------+--------------------------------+ |
| 260 | 261 |
| Filename | Link | |
| ... | ... |
@@ -271,8 +231,8 @@ Configuration Setting the table |
| 271 | 271 |
| eucarc | `Read » <eucarc.html>`__ | |
| 272 | 272 |
+--------------+--------------------------------+ |
| 273 | 273 |
|
| 274 |
-Tools Support scripts |
|
| 274 |
+Tools |
|
| 275 |
+----- |
|
| 275 | 276 |
|
| 276 | 277 |
+-----------------------------+----------------------------------------------+ |
| 277 | 278 |
| Filename | Link | |
| ... | ... |
@@ -292,8 +252,10 @@ Tools Support scripts |
| 292 | 292 |
| tools/upload\_image.sh | `Read » <tools/upload_image.sh.html>`__ | |
| 293 | 293 |
+-----------------------------+----------------------------------------------+ |
| 294 | 294 |
|
| 295 |
-Samples Generated documentation of DevStack sample files. |
|
| 295 |
+Samples |
|
| 296 |
+------- |
|
| 297 |
+ |
|
| 298 |
+Generated documentation of DevStack sample files. |
|
| 296 | 299 |
|
| 297 | 300 |
+------------+--------------------------------------+ |
| 298 | 301 |
| Filename | Link | |
| ... | ... |
@@ -303,8 +265,8 @@ Samples Generated documentation of DevStack sample files. |
| 303 | 303 |
| localrc | `Read » <samples/localrc.html>`__ | |
| 304 | 304 |
+------------+--------------------------------------+ |
| 305 | 305 |
|
| 306 |
-Exercises Generated documentation of DevStack scripts. |
|
| 306 |
+Exercises |
|
| 307 |
+--------- |
|
| 307 | 308 |
|
| 308 | 309 |
+---------------------------------+-------------------------------------------------+ |
| 309 | 310 |
| Filename | Link | |
| ... | ... |
@@ -343,3 +305,9 @@ Exercises Generated documentation of DevStack scripts. |
| 343 | 343 |
+---------------------------------+-------------------------------------------------+ |
| 344 | 344 |
| exercises/zaqar.sh | `Read » <exercises/zaqar.sh.html>`__ | |
| 345 | 345 |
+---------------------------------+-------------------------------------------------+ |
| 346 |
+ |
|
| 347 |
+.. toctree:: |
|
| 348 |
+ :glob: |
|
| 349 |
+ :maxdepth: 1 |
|
| 350 |
+ |
|
| 351 |
+ * |