openstack/openstack-manuals
Code Issues Proposed changes
a2a21b1491
openstack-manuals/doc/user-guide/source/index.rst

51 lines
845 B
ReStructuredText
Raw Normal View History

User Guides: Add intros Add abstract and preface content, rework first page for this. Change-Id: I1eed1ea953ba5e9139344471db8257ab6bb69612
2015-04-01 21:08:52 +02:00
========================
User Guides: Fix titles for guides Create titles for both guides to differentiate them. This needs a separate top-level index file and some moving of files around so that the finished guide has an index.html file. Change-Id: Ibe23d0c466b5c5f7d0b909548b55f6c5382f8992
2015-03-30 16:42:45 +02:00
OpenStack End User Guide
========================
User Guides: Add intros Add abstract and preface content, rework first page for this. Change-Id: I1eed1ea953ba5e9139344471db8257ab6bb69612
2015-04-01 21:08:52 +02:00
Abstract
~~~~~~~~
OpenStack is an open-source cloud computing platform for public and
private clouds. A series of interrelated projects deliver a cloud
infrastructure solution. This guide shows OpenStack end users how to
create and manage resources in an OpenStack cloud with the OpenStack
dashboard and OpenStack client commands.
Add Playground RST Userguide This is a first iteration of converting the user guide to RST. Generated html is available via the checkbuild target as usual. Change-Id: I32f133e27b80bd6ff1555d48aeb29b3e505342fe
2014-12-17 13:19:30 +01:00
Unsupport Liberty as EOL Change-Id: I57c7ab48be2eed8eca5f21db9175162e024879ab
2016-12-27 10:48:05 +09:00
This guide documents OpenStack Newton and Mitaka releases.
User Guides: Add intros Add abstract and preface content, rework first page for this. Change-Id: I1eed1ea953ba5e9139344471db8257ab6bb69612
2015-04-01 21:08:52 +02:00
Contents
~~~~~~~~
Add Playground RST Userguide This is a first iteration of converting the user guide to RST. Generated html is available via the checkbuild target as usual. Change-Id: I32f133e27b80bd6ff1555d48aeb29b3e505342fe
2014-12-17 13:19:30 +01:00
.. toctree::
:maxdepth: 2
RST Guides: Add conventions section Converting from DocBook to XML we lost the initial conventions section, write it and add it to all RST guides. Change-Id: I2ff3d863c72af97a3f70a1ae34083623b7c7006e
2015-08-25 19:51:42 +02:00
common/conventions.rst
Move User Guides into separate directories Separate User Guides cleanly, there's little benefit in having them in one directory and it causes quite some strange sphinx challenges. Temporarily disable translation of the guides since first a new release of openstack-doc-tools is needed. Partial implements bp reorganise-user-guides Change-Id: I9e41bb67397c5bc26c1940f67387f3e42a9c5cbc
2015-05-12 08:43:50 +02:00
intro-user.rst
User-guide conversion: Add cli chapter Add skeleton cli "chapter". Rename dashboard "chapter" so that chapter nomenclature is not visible anymore. Change-Id: Ic2794bd0e57232ee756bc5385669ebfec96814a9
2015-02-17 22:10:59 +01:00
dashboard.rst
Reorder top-level user guide content The "old" user guide had first dashboard, then cli. The new one the other way round. Let's keep the same order. Also, add cheat sheet as separate top-level content like before. Change-Id: I486dc9b0d1a669dd302de20c86be873ba030ddc5
2015-03-25 16:36:48 +01:00
cli.rst
Move User Guides into separate directories Separate User Guides cleanly, there's little benefit in having them in one directory and it causes quite some strange sphinx challenges. Temporarily disable translation of the guides since first a new release of openstack-doc-tools is needed. Partial implements bp reorganise-user-guides Change-Id: I9e41bb67397c5bc26c1940f67387f3e42a9c5cbc
2015-05-12 08:43:50 +02:00
sdk.rst
Remove HOT Guide from User Guide The HOT Guide is being moved to the developer heat repository as per Bug-1461720. This patch removes the HOT Guide content and adds a link to its new home in the dev docs. Change-Id: I3503627fa6adb8f3edeb2b2e3fc37be87862880f Closes-Bug: #1461720
2015-06-19 13:05:45 +10:00
hot.rst
[user-guide] Changes underscore to hyphen in RST files Adds the following changes: - Renames all the RST files in the user-guide folder to use hyphens instead of underscores; - Adds redirects to the renamed files to .htaccess. Change-Id: Ic5f1a90421add35d001363cd39bada0b56a04d7f Implements: blueprint consistency-file-rename
2016-08-10 13:22:47 +03:00
cli-cheat-sheet.rst
Updated TOC in the End User Guide Moved HOT guide as a chapter in the End User Guide Change-Id: Ib696786a355666357a765eb47c9eb3ffee2c2b5e backport: juno Closes-Bug: #1419007
2015-04-02 17:20:49 +11:00
[Glossary] Table of contents for glossary file Modified the file to get a list of contents Change-Id: Ib33a8ce346d76ae4ac099d9904bf8e6be1ba3261 Closes-Bug: #1491122 Co-Authored-By: KATO Tomoyuki <kato.tomoyuki@jp.fujitsu.com>
2016-05-05 16:59:02 +05:30
Appendix
~~~~~~~~
.. toctree::
:maxdepth: 1
[common] Use hyphens in filenames Part of "consistency-file-rename" spec [1] This commit also changes the following: * Update corresponding references to common in various guides * Rename excluded_patterns in conf.py of various guide * Rename existing entries in www/static/.htaccess * Add entries to .htaccess to redirect renamed files [1] http://specs.openstack.org/openstack/docs-specs/specs/newton/consistency-file-rename.html Change-Id: I39a9d5b95535cad1918ee64e95dee5ef18ab2cbe
2016-08-01 23:42:40 +09:00
common/app-support.rst
Add Playground RST Userguide This is a first iteration of converting the user guide to RST. Generated html is available via the checkbuild target as usual. Change-Id: I32f133e27b80bd6ff1555d48aeb29b3e505342fe
2014-12-17 13:19:30 +01:00
[Glossary] Table of contents for glossary file Modified the file to get a list of contents Change-Id: Ib33a8ce346d76ae4ac099d9904bf8e6be1ba3261 Closes-Bug: #1491122 Co-Authored-By: KATO Tomoyuki <kato.tomoyuki@jp.fujitsu.com>
2016-05-05 16:59:02 +05:30
Glossary
~~~~~~~~
.. toctree::
:maxdepth: 1
Move RST Glossary to common-rst Build glossary only once and put it into common-rst directory so that all RST guides can use it. Change-Id: I2d3acf25a3af48349b7c10b7e9fea86d5f16444e
2015-05-12 08:11:44 +02:00
common/glossary.rst
Add RST Glossary Automatically convert the glossary from DocBook XML to RST with each build and use it for building the RST guides. Add the glossary to User Guides and Networking Guide. Use glossary in User Guides in places where it was used before. This removes one TODO. Fix CORS capitalization. Partial-Bug: #1421813 Change-Id: I3fba6d54b01759f39f8e1467a7606cdbd2dd0165
2015-04-12 14:07:01 +02:00
RST Guides: Change "Indices and tables" heading We do not have any indices or tables in our RST guides, so rename the heading to "Search in this guide" since that's all that is there now. Change headings for Networking Guide to follow markup conventions. Change-Id: I5bac2ce30a2bd90f7e450d95c2426b392963068b
2015-04-18 20:13:27 +02:00
Search in this guide
~~~~~~~~~~~~~~~~~~~~
User Guides: Remove index link The index is not used currently, let's remove it. Change-Id: Ia86a9085719f5226c3900100234b17e482f9980e
2015-04-06 21:36:49 +02:00
Add Playground RST Userguide This is a first iteration of converting the user guide to RST. Generated html is available via the checkbuild target as usual. Change-Id: I32f133e27b80bd6ff1555d48aeb29b3e505342fe
2014-12-17 13:19:30 +01:00
* :ref:`search`
Copy Permalink