Commit Graph

2 Commits

Author SHA1 Message Date
Sylvain Bauza 74abd14baf Add some devref for AZs
Since the AZ knowledge is mostly tribal and can have some corner cases, we could
help the operators by giving more visibility on how it's made and what to prevent.

The related ticket mentioned below is one example of a common mistake that is
quite not easily fixable from the Nova standpoint since the design is mostly broken.

Change-Id: I092c8caa9e450a68a7a952940b0bb288b8fe6fb0
Related-Bug: #1444841
2015-09-22 22:33:26 +02:00
Joe Gordon a1e8fc6dd9 Update docs layout
* Explain these docs are for trunk (copied from ironic)
* All the docs in this repo are meant to be developer docs, so having a
  devref inside of the docs is redundant and just makes the docs more
  complicated to navigate. Move everything out of the devref folder and
  link to everything from main index.
* Move man pages into separate section. The man pages are pretty sparse
* right now, we should either make them useful or just delete them
* Remove dead docs from unused_docs list in doc/source/conf.py
* Shuffle docs landing page, move common referees to the top (API,
  hypervisor support matrix), Add a introduction section and more. The
  hope is the updated layout makes this document easier to navigate.
* Use maxdepth of 1
* Rename a few sections with what are hopefully better names

The next step is to prune out outdated documents and further cleanup
this page.

Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-15 10:47:18 -07:00