Commit Graph

13 Commits

Author SHA1 Message Date
Jenkins c7153048f3 Merge "Clean up *most* ec2 / euca2ools references" 2017-08-16 19:55:12 +00:00
Jenkins 33f3614135 Merge "doc: address review comments in stable-api guide updates" 2017-08-14 08:02:09 +00:00
Jenkins f401d18a3d Merge "Improve stable-api doc with current API state" 2017-08-10 22:01:02 +00:00
Matt Riedemann 430af62aa3 doc: address review comments in stable-api guide updates
This addresses review comments made in change
I6522100a78241400b1ea059a39a32c259fe6ab90 which
updated the stable API docs.

Change-Id: Ib0ffe3e9702fd39914b2025096667e699bc432a0
2017-08-10 17:11:50 -04:00
Sean Dague 7e693e9c5c Clean up *most* ec2 / euca2ools references
The ec2 / euca2ools command references definitely don't work any more,
this deletes most of them. The exception is the policy reference doc
which is over a year out of date, and needs more then surgical removal
of ec2 from it.

Change-Id: I963170f99037d5ed085e8c676ab55750c7f6372e
2017-08-09 11:20:12 -04:00
ghanshyam a03c667109 Improve stable-api doc with current API state
extensions, stevedore and extensions config options are gone
and plain router is introduced in Pike.

Also this documents was little bit confusing about current and
old state of APIs.

This commit makes it more clear and reflect the current API state
and also describe the evolution of APIs.

Change-Id: I6522100a78241400b1ea059a39a32c259fe6ab90
2017-08-09 14:13:17 +00:00
Sean Dague b9efc9d641 Create reference subpage
In an attempt to make the main navigation sidebar not be visual mud
(and really confusing) create a reference sub page that explains all
the references.

Part of bp: doc-migration

Change-Id: I005fc24e49487631d7fe73cb498c61619bcaac9d
2017-08-08 12:28:50 +00:00
Stephen Finucane 24cdb620f9 doc: Make use of definition lists, literals
Part of bp: doc-migration

Change-Id: I270c29fa9d7f02ccc4437f05a86edb79a3a373ba
2017-08-03 14:42:34 +01:00
Sean Dague a87afe2fc2 reflow rpc doc to 80 columns
And add some additional horizontal white space to make it easier to
understand different long bullets are different.

Part of bp: doc-migration

Change-Id: I36cd7513fa5d482b6cd85a062eace21704c49f85
2017-08-03 14:28:48 +01:00
Sean Dague ea669d3488 fix list rendering in policy-enforcement
Part of bp: doc-migration

Change-Id: Ia0355c14fba16416d0d6068d2478377dccfa2ed9
2017-08-03 08:10:16 -04:00
Sean Dague dafd133ab8 fix list rendering in rpc doc
list bullets have to be exactly 2 spaces indented from the parent, and
the top level is left justified, otherwise we get lots of <blockquote>
html tags inserted.

Part of bp: doc-migration

Change-Id: Ie8b311ca286601a47475b33ef80da272efc9be31
2017-08-03 07:50:27 -04:00
Sean Dague dc94d8ad5b fix rpc broken rst comment
The license header isn't in a comment correctly, so it shows up
inline in the rpc page and looks pretty ugly. Add missing '.'

Change-Id: I7c05ee9c4074d1e29f77b4c1c292196bcf0b801d
2017-08-02 20:47:36 +00: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