6 Commits

Author SHA1 Message Date
Andreas Jaeger
20d15b80df Arch Design: Add glossentries, use common glossary
Use the common documentation glossary.
Move entries from ch_glossary to the common documentation glossary and
add glossterm so that the entry gets displayed in the glossary.
Remove entries from the Arch Design specific glossary that are fully
explained in the text.
Remove entries that are already in the common glossary and add glossterm
for them in the text.
Add glossary as final chapter to the manual.

The remaining glossary entries need some further discussion.

Change-Id: Ic82ae5235e1306fc13be81fa4971710321da5072
2014-08-09 20:13:41 +02:00
Andreas Jaeger
32e98f5045 Arch Design: Small edits
Fix capitalization and markup.

Change-Id: I38a4a20cf9830fa07c769c34eb1ffd7578948317
2014-08-07 20:28:18 +02:00
Andreas Jaeger
bfe149fcd2 Arch Design: Move introductory sections up
Move the introductory sections one level up, removing the separate
section for them. This reads much nicer in HTML now.
There's also no need to name the first paragraphs of a chapter
"Introduction", this is implied.

Change-Id: Ife4275807561dae2ca57dc71b7602240efa94663
2014-08-03 19:59:53 +02:00
Andreas Jaeger
9212c749de Arch Design: Heading capitalization
Follow conventions for heading capitalization in the Architecture Design
Guide.

Change-Id: I49c246968f55de106e138e6de0e76dd05a2693ff
2014-07-25 10:32:42 +02:00
Christian Berendt
a5d88c7ce7 Unified the syntax of the XML root element (arch-design)
The XML root element of Docbook XML files should match the following
format:
<ELEMENT xmlns="http://docbook.org/ns/docbook"
  xmlns:xi="http://www.w3.org/2001/XInclude"
  xmlns:xlink="http://www.w3.org/1999/xlink"
  version="5.0"
  xml:id="THE_XML_ID_OF_THE_ELEMENT">

Change-Id: I6124101642054dddf9a2ff7f1dbb4fa25af51ce9
2014-07-23 09:34:18 +02:00
Anne Gentle
483b337b9e Adds starting point for Architecture and Design Guide
The areas that still need work are:
- needs double-checking for tables
- see http://docs.openstack.org/arc/OpenStackArchitectureDesignGuide.epub
  for intended structure

Co-Authored-By: Nick Chase <nchase@mirantis.com>
Co-Authored-By: Beth Cohen <beth.cohen@verizon.com>
Co-Authored-By: Sean Collins <sean_collins2@cable.comcast.com>
Co-Authored-By: Steve Gordon <sgordon@redhat.com>
Co-Authored-By: Sebastian Gutierrez <segutier@redhat.com>
Co-Authored-By: Kevin Jackson <Kevin.Jackson@rackspace.co.uk>
Co-Authored-By: Scott Lowe <slowe@vmware.com>
Co-Authored-By: Maish Saidel-Keesing <msaidelk@cisco.com>
Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com>
Co-Authored-By: Vinny Valdez <vvaldez@redhat.com>
Co-Authored-By: Anthony Veiga <Anthony_Veiga@cable.comcast.com>
Co-Authored-By: Sean Winn <sean.winn@cloudscaling.com>

Change-Id: Ia0ca278cd5d2d0ee67b9b7528870c1a2a80fdadf
2014-07-22 20:42:31 +02:00