Commit Graph

5 Commits

Author SHA1 Message Date
Sean Dague 12c0a66657 Fix list rendering in code-review.rst
Sub lists have to be indented exactly 2 additional spaces from their
parent, otherwise it is treated as a blockquote, which isn't what we
want.

Part of bp: doc-migration

Change-Id: Iab46b5e39e4bd0d154f33dc795f24362c77a88a5
2017-08-03 07:45:25 -04:00
Sean Dague ce53afce8c Fix lists in process doc
A lot of our rst was actually misformatted with extra spaces indenting
the bullet lists. This wasn't very visually noticable in the
oslosphinx theme, but it's really bad in the new theme. There will
need to be lots of fixes here, but will do them one page at a time.

Part of bp: doc-migration

Change-Id: Ic1d1383148b005b884fdfa3e9a9658adcb13ee70
2017-08-03 07:29:51 -04:00
Stephen Finucane ef9cbc0017 doc: Populate the 'user' section
Per the spec [1]:

  user/ – end-user content such as concept guides, advice, tutorials,
  step-by-step instructions for using the CLI to perform specific tasks,
  etc.

The remaining content all ends up in here.

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

Change-Id: I480eee9cd7568efe2f76dd185004774588eb4a99
2017-07-18 15:41:20 +01:00
Stephen Finucane 83e7763518 doc: Populate the 'reference' section
Per the spec [1]:

  reference/ – any reference information associated with a project that
  is not covered by one of the above categories. Library projects should
  place their automatically generated class documentation here.

There are a couple of documents that focus on nova internals, but won't
necessarily be applicable to user. These are moved here.

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

Change-Id: I94614c2383329e1fbed60d9c5aca3fab5170ef8f
2017-07-18 15:41:20 +01:00
Stephen Finucane a2165cf651 doc: Populate the 'contributor' section
Per the spec [1]:

  contributor/ – anything related to contributing to the project or how
  the team is managed. Applies to some of the current content under
  /developer, we are changing the name to emphasize that not all
  contributors are developers and sometimes developers are users but not
  contributors.

We currently have a handful of docs that focus on the "how to develop or
contribute" aspects of nova, and these are moved. Docs that focus on
architecture or design decisions for nova are not moved, as these will
go into 'reference'.

A TODO is added to the former 'api_plugins' document as it's mega
out-of-date and needs some serious work.

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

Change-Id: Iad770688b4eafeb9caa710b4398b02d80a017a70
2017-07-18 15:41:19 +01:00