44 Commits

Author SHA1 Message Date
John Garbutt
09c2afa85b devref: add information to clarify nova scope
This adds a document that helps clarify the scope of the Nova mission
statement.

We need to keep the Nova project a manageable size. Agreeing on what
Nova should focus on is a great way to make sure we grow Nova in a
consistent way, leaving open opportunities for other projects to do a
better job of things Nova doesn't see as part of its core mission.

Part of blueprint devref-refresh-liberty

Change-Id: I4e46ee252e6b29b063bcc8204d60d670eb79daef
2015-05-12 16:24:45 -07:00
Joe Gordon
57423c9788 Cleanup docs landing page
Our docs our wildly out of date and pretty bad, this is a first step at
beginning to clean them up and make them more useful.

* remove the guidelines section. 2 of them are explicitly wrong (API
  Compatibility and Open Standards), and no one actually uses these
  guidelines during development. Yes we want high availability and fault
  tolerance, but listing these design guidelines here is misleading at
  best.
* Don't explain how this document is built, don't need to explain that
  so prominently
* Update the intro based on Nova's mission statement

Change-Id: Ia564a7cacdac0ddab913464ca1c7f9fefb0ee0b5
2015-05-01 19:21:58 -07:00
Matthew Gilliard
cf71b18ff7 Adds toctree to v2 section of docs
The toctree was globbing a nonexistent directory, and not producing
useful output. This patch lists the contents correctly.

Change-Id: I414120d948bd3eeeec84ac279bab11c276ef5eee
2015-04-28 11:43:47 +01:00
Davanum Srinivas
07b5373f90 Fix API links and labels
Per email discussion[1], v2.1 API is our CURRENT when we get to kilo and
v2 is SUPPORTED. Added links to the v2.1 API, v2 API and v2 extensions
API in our documentation

[1] http://markmail.org/message/p32p5jbvvjedg657

Depends-On: Ibe990ec93d8f9d18ef21c28979e180472df6a33d
Closes-Bug: #1435507
Change-Id: Iaa62be9612dd039f7669ff2b5587c922aba54093
2015-03-30 23:59:40 +00:00
Anne Gentle
ffc4cedb2b Adds Compute API v2 docs
Imported from public API docs plus fixes to make them more accurate.

Change-Id: I6d5ba6b96772e0f17fc7484312222110ec103bbf
2015-03-27 10:52:18 -05: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
Anne Gentle
6b5d4f30ec Corrects link to API Reference on landing page
Point directly to the document being referenced,
instead of the API documentation site.

Change-Id: I7796d6a53ed0f21a5873202dfdc50d456325d70f
2014-12-16 13:12:50 +00:00
Joe Gordon
bd7e62f796 Don't list entire module autoindex on docs index
Don't list entire api/autoindex under Developer Docs,  we already have a
model index link at the  bottom of the page, showing the entire
autoindex on the home page is makes the page overwhelming.

Change-Id: I25c5b50412881b55aa745ce3da2c22466e879fcf
2014-09-17 18:33:45 -07:00
Davanum Srinivas
a507d42cf5 docs - Set pbr 'warnerrors' option for doc build
By setting this pbr option in setup.cfg, the doc build will fail in case
of any warnings or errors occur during the build process.

Closes-Bug: #1351350

Change-Id: Id4858062d2aaa4c2fe5b597e40e4e8947f544a4d
2014-08-11 12:53:37 +00:00
Davanum Srinivas
24a24fcf52 docs - Add an index for the command line utilities
Change-Id: I03376a9159c3ef6c2b65cce417a217db68e8c246
2014-08-01 15:42:57 +00:00
Monty Taylor
e4decf693a Fixed two minor docs niggles.
The doc todo list didn't actually work, so remove it. Also, the
documentation is not written by Anso Labs quite so much anymore.

Change-Id: I746a26505d331ab55565e952a1a46425458b1412
2013-05-31 08:30:13 -04:00
annegentle
fd6b21b948 Removes RST documentation and moves it to openstack-manuals
Avoiding redundant information and confusion.

Change-Id: Iab1913ff359699db977b74554bad6088fab6ab2f
2012-04-30 12:45:48 -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
Doug Hellmann
c16cd04cf6 Fix rst formatting and cross-references
blueprint sphinx-doc-cleanup
bug 944385

- Fix formatting and markup issues that produce error messages
- Update TOC lists for missing/new files
- Fix a few links
- Update instructions with dependencies for building the documentation
- Updated base on review comments from oubiwann to fix trailing whitespace in modified files

Change-Id: I589152bfab9c543d2b11fa8bed2344259aa90675
2012-03-06 08:08:25 -05:00
Russell Bryant
aee45cc4ab Fix API extensions documentation, bug 931516.
This patch fixes the docs so that the API extensions documentation gets
included.  In passing, also update the API extensions index to include
an extension that was not listed.

Change-Id: Ia16cab2b29bbc121d940dc4ed9f033340935cde8
2012-02-15 18:52:45 -05:00
annegentle
032a07785d Adds extension documentation for some but not all extensions
Change-Id: I187483ccacd9c29c1c414fbf8481ead23f9c457a
2011-12-02 13:02:06 -06:00
Anne Gentle
3392f6b4b0 Removing duplicate installation docs and adding flag file information, plus pointing to docs.openstack.org for Admin-audience docs 2011-02-21 14:27:37 -06:00
Anne Gentle
fc964378b5 Doc changes for db sync 2011-01-20 14:56:29 -06:00
Anne Gentle
dca2df171d Change all 2010 Copyright statements to 2010-2011 in doc source directory only 2011-01-04 16:58:08 -06:00
Anne Gentle
d60ed93a22 Fixed spelling errors in index.rst 2010-12-10 16:03:30 -06:00
Anne Gentle
d647d6b070 Added livecd instructions plus fixed references to .conf files 2010-12-07 16:48:42 -06:00
root
ee9fc9b530 home page tweaks 2010-11-11 11:43:32 -08:00
root
30f0eb88b7 modifications and additions based on doc sprint 2010-11-11 11:07:47 -08:00
root
4ad2e71f41 incorporate some feedback from todd and anne 2010-11-09 10:11:36 -08:00
root
b78364281d merge in trunk 2010-11-08 20:38:21 -08:00
root
2a81e25f89 working on novadoc structure 2010-11-08 18:40:21 -08:00
Todd Willey
2c01c32571 Merge lp:~termie/nova/trunkdoc (via patch, since bzr though it was already merged) 2010-11-07 14:51:40 -05:00
Todd Willey
a999c8de9e back out stacked merge 2010-11-07 14:46:17 -05:00
Andy Smith
006b3ab0c7 Switch to module-per-file for the module index.
Rename development guide to development reference.
2010-11-08 02:00:48 +09:00
Todd Willey
cb5ffdad03 Merge to remote. 2010-11-05 17:34:09 -04:00
root
64ce9316b6 small tweaks before context switch 2010-11-05 13:44:22 -07:00
Todd Willey
af448fe2a9 Merge to remote. 2010-11-05 16:25:46 -04:00
root
3ef09f689b use include to grab todd's quickstart 2010-11-05 13:25:40 -07:00
Todd Willey
c5e616f590 Format TODO items for sphinx todo extension. 2010-11-05 15:11:04 -04:00
root
0a4785be35 additions to home page 2010-11-05 11:56:12 -07:00
Todd Willey
4ea4eac3f1 Change directory structure for great justice! 2010-11-04 19:00:46 -04:00
Todd Willey
3a8dadd4d3 Getting Started Guide. 2010-11-04 17:36:32 -04:00
Todd Willey
6b8ee54df1 have "contents" look the same as other headings. 2010-11-04 00:02:56 -04:00
Todd Willey
c8e2341c98 API endpoint documentation. 2010-11-01 20:33:03 -04:00
Todd Willey
196ab5b15c Fix wiki link. 2010-10-28 10:39:51 -04:00
Todd Willey
8e12d65af4 New structure for documentation. 2010-10-27 00:05:42 -04:00
Anne Gentle
7233ed2e35 Made updates based on review comments. 2010-10-20 17:06:51 -05:00
Anne Gentle
5c2bc4a709 Updated documentation 2010-10-20 09:50:09 -05: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