Commit Graph

22 Commits

Author SHA1 Message Date
Andrey Volkov 3a26ad77e8 Docs: Add Placement to Nova system architecture
Changes in svg:
- schema with nova-network is removed and one with Neutron is made as default
- Placement service is added to a party
- titles and arrows are aligned

Change-Id: If7e4a0b92c8713dabcb16a5e7820fbf479d82917
2018-07-23 14:44:27 +03: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
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
John Garbutt 027b92dc4e Add prototype feature classification matrix
Add in feature_classification.ini that makes use of new sphinx
extension feature_matrix. While it is loosely based on the
support_matrix extension, longer term this extension will live
outside the Nova tree. As such, this has been created as a new
separate sphinx plugin.

The matrix has links to wiki page for the CI in the header of the
summary matrix. This is called a target.

Also, there are links to admin docs, API docs, and tempest test uuids
added into the feature details. An option is added to ensure these are
always present in the prototype matrix.

A maturity status is added to be clear about the level of maturity
of each feature. When in maturity mode, this is added into the summary
table in place of the status. There is also some formating for the
different maturity levels.

blueprint feature-classification

Change-Id: Ib5895e8de901f1a282d0f5c0ecb811ff8b451497
2016-07-18 18:31:03 +00:00
Markus Zoeller 6a6059a9a6 hypervisor support matrix: add CLI commands to features
Some features could be made clearer if the CLI commands which are
related to that feature are listed. This patch set allows to set
CLI commands per feature.
This is an interim solution until the new feature classification
system is established.

Change-Id: If599627187080a8349811f50f6561e9efbc35138
2015-06-26 08:11:18 +00:00
Markus Zoeller 36f7451c33 hypervisor support matrix: add status "unknown"
When a new feature gets added to the hypervisor support matrix it
was not possible to state that the hypervisor did not make a support
statement yet. You had to choose between "complete", "partial" and
"missing" wich could be missleading.
This change set adds the status "unknown" which could make the
statements more precise.

Change-Id: If94fc772796742de88af5893839945834b9d3eb6
2015-06-15 10:18:37 +02:00
Daniel P. Berrange 4837c42127 Add formal doc recording hypervisor feature capability matrix
Add document to replace / obsolete the giant table on

  https://wiki.openstack.org/wiki/HypervisorSupportMatrix

This initial draft is a fairly straightforward conversion of
that table. Over time, it needs much work to improve the coverage
of API operations and and coverage of important configuration
information that users will care about.

It is using the .ini file syntax in order to record the data in
an easily machine parsable format, while remaining human friendly
by avoiding the syntax heavy approach of XML / JSON / YAML

An extension is registered with sphinx that can convert the
.ini file content into docutils content that then gets rendered
into the developer docs, linked from the index page

Change-Id: I4d3db4bce5737dba30a026a11083a9ea64459cd4
2015-02-03 15:15:49 +00:00
Doug Hellmann 47500553d9 Use oslo.sphinx and remove local copy of doc theme
Use the new oslo.sphinx version of the OpenStack doc
theme instead of copying it into this repo.

blueprint oslo.sphinx

Signed-off-by: Doug Hellmann <doug.hellmann@dreamhost.com>
Change-Id: I0bd91f7bb43f97b99051fed65b75fc05d5149cc8
2013-07-06 13:18:04 -04:00
jakedahn 3ddece6553 Making docs pretty!
* Before: http://stsh.me/2Qv
  * After: http://stsh.me/2Qw

Change-Id: I4609e66820cd49b7443d18b9e0decf638da42581
2012-07-11 15:30:42 -07:00
Monty Taylor c586de1c58 Removed a bunch of cruft files.
Ohai. We dont't uses any of theses anymores. Let's just make buh-bye.

Change-Id: Ib81c92ab9196552150d81d158befb0747966965d
2012-07-07 16:32:19 -05:00
Hengqing Hu 9a042d3c50 Remove trailing whitespaces in regular file
Fixes bug #945346

Change-Id: I07a303c2e503e50d7138585c683e0d1310339276
2012-03-07 13:43:37 +08:00
Monty Taylor 3b081fea08 Finally fix the docs venv bug.
Closes bug 902846.

Turns out that without providing a default css file,
docutils tries to pull one in from a location using
very bad path logic. Glance was providing the css file
explicitly and it worked, so I just copied them.

Change-Id: I6cc9d0ca148149637104c27f6c020030bdbcfe18
2012-03-05 20:22:51 -08:00
Anne Gentle bacce305a9 Adding a sidebar element to the nova.openstack.org site to point people to additional versions of the site. 2011-03-11 17:13:56 -06:00
Anne Gentle c9dd8ce2e4 Updated Cloud101 and admonition color 2010-11-11 16:32:24 -06:00
Anne Gentle ed4662db64 Updated CSS and community.rst file 2010-11-11 13:39:54 -06:00
root 9c2af052e4 shrink tweet text a bit 2010-11-05 15:36:19 -07:00
root 9675be4ffd add twitter feed to the home page 2010-11-05 15:29:54 -07:00
root dd505245c2 add in custom todo, and custom css 2010-11-05 12:49:42 -07:00
Monty Taylor 67711b8aa4 Added a few more missing files to MANIFEST.in and added some placeholder
files so that setup.py would carry the empty dir.
2010-07-27 21:52:01 -07:00
Monty Taylor 87e27afec0 Updated sphinx layout to a two-dir layout like swift.
Updated a doc string to get rid of a Sphinx warning.
2010-07-24 18:06:22 -07:00