openstack/nova
Code Issues Proposed changes
09a9129218
nova/doc/source/index.rst

158 lines
3.0 KiB
ReStructuredText
Raw Normal View History

initial commit
2010-05-27 23:05:26 -07:00
..
Removes RST documentation and moves it to openstack-manuals Avoiding redundant information and confusion. Change-Id: Iab1913ff359699db977b74554bad6088fab6ab2f
2012-04-30 12:45:10 -05:00
Copyright 2010-2012 United States Government as represented by the
Remove trailing whitespaces in regular file Fixes bug #945346 Change-Id: I07a303c2e503e50d7138585c683e0d1310339276
2012-03-07 13:43:37 +08:00
Administrator of the National Aeronautics and Space Administration.
Updated licenses
2010-06-23 22:04:16 -07:00
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
initial commit
2010-05-27 23:05:26 -07:00
http://www.apache.org/licenses/LICENSE-2.0
Updated licenses
2010-06-23 22:04:16 -07:00
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
initial commit
2010-05-27 23:05:26 -07:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
==========================================
Removes RST documentation and moves it to openstack-manuals Avoiding redundant information and confusion. Change-Id: Iab1913ff359699db977b74554bad6088fab6ab2f
2012-04-30 12:45:10 -05:00
Welcome to Nova's developer documentation!
==========================================
initial commit
2010-05-27 23:05:26 -07:00
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
Nova is an OpenStack project designed to provide power massively scalable, on
demand, self service access to compute resources.
New structure for documentation.
2010-10-27 00:05:42 -04:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
The developer documentation provided here is continually kept up-to-date
based on the latest code, and may not represent the state of the project at
any specific prior release.
Add note to doc explaining scope This is developer oriented documentation, make sure that is clear and point to docs.openstack.org for more docs. Change-Id: I0680e331b0fcf57dddb157c99e59d690fea349cb
2015-05-13 12:34:40 -07:00
.. note:: This is documentation for developers, if you are looking for more
general documentation including API, install, operator and user
guides see `docs.openstack.org`_
.. _`docs.openstack.org`: https://docs.openstack.org
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
Compute API References
Changes conf.py for Sphinx build because oslosphinx now contains GA - Changes api to API to force build of all source files. - Ensures tracking is consistent across all openstack.org web properties. - Tracks only docs.openstack.org/developer/{{ project }} where project name is taken from conf.py. - Removes ability to build local without GA. If you have ideas for how to build local without GA, please patch. Change-Id: Ibb61e5c1668e6a0782daf91d4faf0950c5bf77d7 Partial-bug: 1441315
2015-04-09 12:40:04 -05:00
======================
Add note to doc explaining scope This is developer oriented documentation, make sure that is clear and point to docs.openstack.org for more docs. Change-Id: I0680e331b0fcf57dddb157c99e59d690fea349cb
2015-05-13 12:34:40 -07:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
* `v2.1 (CURRENT)`_
* `v2 (SUPPORTED)`_ and `v2 extensions (SUPPORTED)`_ (Will be deprecated in
the near future.)
modifications and additions based on doc sprint
2010-11-11 11:07:47 -08:00
Link to microversion history in docs Make the API microversion history more accessible by adding it to nova's doc landing page. Making sure it is easy to discover what the difference between each microversion is fundamental piece of the microversion puzzle, so lets not require end users to have to look through git. rename api_microversions.rst to api_microversion_dev.rst to clarify that it is about development and versus history. Change-Id: I270944bf9739b113a43b932948fdbf83e449603b
2015-06-10 18:31:58 +03:00
API Microversion History:
.. toctree::
:maxdepth: 1
api_microversion_history
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
Local copy of v2 docs:
.. toctree::
:maxdepth: 1
v2/index
.. _`v2.1 (CURRENT)`: http://developer.openstack.org/api-ref-compute-v2.1.html
.. _`v2 (SUPPORTED)`: http://developer.openstack.org/api-ref-compute-v2.html
.. _`v2 extensions (SUPPORTED)`: http://developer.openstack.org/api-ref-compute-v2-ext.html
Hypervisor Support Matrix
=========================
initial commit
2010-05-27 23:05:26 -07:00
.. toctree::
New structure for documentation.
2010-10-27 00:05:42 -04:00
:maxdepth: 1
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
2014-11-21 14:57:07 +00:00
support-matrix
additions to home page
2010-11-05 11:56:12 -07:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
Developer Guide
===============
Introduction
-------------
Adds Compute API v2 docs Imported from public API docs plus fixes to make them more accurate. Change-Id: I6d5ba6b96772e0f17fc7484312222110ec103bbf
2014-12-17 10:14:37 -06:00
.. toctree::
:maxdepth: 1
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
architecture
project_scope
.. toctree::
:maxdepth: 1
development.environment
Remove jenkins, launchpad and gerrit docs All of that information can be found at http://docs.openstack.org/infra/manual/developers.html, so just make the link to developers.html more prominent in development.environment * Rename development.environment to a shorter title, Developer quickstart. Change-Id: I1460e6c86a7e0a1efb4a81c6c5cb594476171214
2015-05-14 14:57:54 -07:00
Adds Compute API v2 docs Imported from public API docs plus fixes to make them more accurate. Change-Id: I6d5ba6b96772e0f17fc7484312222110ec103bbf
2014-12-17 10:14:37 -06:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
APIs Development
----------------
.. toctree::
:maxdepth: 1
Adds extension documentation for some but not all extensions Change-Id: I187483ccacd9c29c1c414fbf8481ead23f9c457a
2011-12-02 13:02:06 -06:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
addmethod.openstackapi
api_plugins
Link to microversion history in docs Make the API microversion history more accessible by adding it to nova's doc landing page. Making sure it is easy to discover what the difference between each microversion is fundamental piece of the microversion puzzle, so lets not require end users to have to look through git. rename api_microversions.rst to api_microversion_dev.rst to clarify that it is about development and versus history. Change-Id: I270944bf9739b113a43b932948fdbf83e449603b
2015-06-10 18:31:58 +03:00
api_microversion_dev
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
policy_enforcement
The devref for Nova stable API This document describes the expect of Nova REST API from Nova team. Also can resolve some confuse what you see in the current Nova code. The Nova team will try to reach the final goal of this document described. Co-Authored-By: Jay Pipes <jaypipes@gmail.com> Change-Id: Ia837bca561fa8a7c48eadfcd9bd791dc8c8d29ac
2015-03-10 16:01:27 +08:00
stable_api
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
Concepts
---------
.. toctree::
:maxdepth: 1
aggregates
cells
threading
vmstates
i18n
filter_scheduler
rpc
hooks
upgrade
Development policies
--------------------
.. toctree::
:maxdepth: 1
Make blueprints doc a reference for nova blueprints Previously kilo.blueprints was a document to propose a change to the blueprints process. Turn the document into a reference for blueprints, specs and priorities in nova. * Just state current policy instead of references to how it was before. This information will still be around in the git history if we never need to look it up. * Now that we have been doing this for a cycle we don't need hypothetical examples anymore. * Make this reflect the fact that we just use an etherpad to track * priority reviews. Change-Id: I0d6e568fe1a8ef40de1d7f7d7e45260b1400e407
2015-05-14 15:31:18 -07:00
blueprints
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
policies
Advanced testing and guides
----------------------------
.. toctree::
:maxdepth: 1
gmr
testing/libvirt-numa
testing/serial-console
Man Pages
----------
.. toctree::
:maxdepth: 1
man/index
Module Reference
----------------
.. toctree::
:maxdepth: 1
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-03 15:57:19 -06:00
Update docs layout * Explain these docs are for trunk (copied from ironic) * All the docs in this repo are meant to be developer docs, so having a devref inside of the docs is redundant and just makes the docs more complicated to navigate. Move everything out of the devref folder and link to everything from main index. * Move man pages into separate section. The man pages are pretty sparse * right now, we should either make them useful or just delete them * Remove dead docs from unused_docs list in doc/source/conf.py * Shuffle docs landing page, move common referees to the top (API, hypervisor support matrix), Add a introduction section and more. The hope is the updated layout makes this document easier to navigate. * Use maxdepth of 1 * Rename a few sections with what are hopefully better names The next step is to prune out outdated documents and further cleanup this page. Change-Id: Iff453e47ccc902a0e72b1a5f6ce1ee939ff3a1a0
2015-05-14 14:18:53 -07:00
services
Adds extension documentation for some but not all extensions Change-Id: I187483ccacd9c29c1c414fbf8481ead23f9c457a
2011-12-02 13:02:06 -06:00
initial commit
2010-05-27 23:05:26 -07:00
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Copy Permalink