Commit Graph

4 Commits

Author SHA1 Message Date
Stephen Finucane 3a6e1e2396 doc: Rework man pages
Rework the man pages by:

- Wording the synopsis sections similarly for all commands
- Not using upper-case section names, as this is unnecessary and results
  in worse HTML output
- Formatting code and file names as literals

The 'nova-idmapshift' man page is excluded as this utility will be
removed shortly.

Change-Id: I67914a757f9436461960a8d6b92d157f59ccad66
2017-10-09 16:08:40 +01:00
Andreas Jaeger 4e6eec5c9b Fix broken URLs
Fix broken nova URLs that linked to the old developer/nova places and
use the new link instead.

Change-Id: Ideb50626e140201dded19fc82584440f1a407e47
2017-09-07 15:42:31 +02:00
Matt Riedemann 3414ab14ca Deprecate cells v1
With multi-cell support in Pike, we should deprecate cells v1
so we can at least start the deprecation signaling in the
docs and release notes. We may not end up removing cells v1
code in Queens, but this at least gives us the option.

Note that we also want to do this because nova-network cannot
be removed until we remove cells v1.

Change-Id: I1a173f7ce0715e684850e030c358e8175fa8724c
2017-08-01 11:07:55 -04:00
Stephen Finucane be8fa67024 doc: Populate the 'cli' section
Per the spec [1]:

  cli/ – command line tool reference docs, similar to man pages These
  may be automatically generated with cliff's sphinx integration, or
  manually written when auto-generation is not possible.

All of the docs currently found in 'man' fit that category, so those and
those alone are moved. It'll be a great day in the parish when we can
replace all of these with cliff's Sphinx integration.

[1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration

Change-Id: I45bed324ec37cfea7c1a574ec06af38e7b875a1c
2017-07-13 14:54:11 +01:00