Merge "doc: Populate the 'contributor' section"
This commit is contained in:
commit
2f110810be
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
|
@ -14,6 +14,10 @@
|
|||
License for the specific language governing permissions and limitations
|
||||
under the License.
|
||||
|
||||
.. TODO::
|
||||
|
||||
This should be merged into contributor/api
|
||||
|
||||
Adding a Method to the OpenStack API
|
||||
====================================
|
||||
|
|
@ -1,5 +1,9 @@
|
|||
API Plugins
|
||||
===========
|
||||
Extending the API
|
||||
=================
|
||||
|
||||
.. TODO::
|
||||
|
||||
Update this to reflect the removal of the legacy v2 API code
|
||||
|
||||
Background
|
||||
----------
|
||||
|
@ -15,10 +19,9 @@ change should be made to the V2 API code. API changes should only be
|
|||
made through V2.1 microversions.
|
||||
|
||||
This document covers how to write plugins for the v2.1 framework. A
|
||||
`microversions specific document
|
||||
<http://docs.openstack.org/developer/nova/api_microversion_dev.html>`_
|
||||
covers the details around what is required for the microversions
|
||||
part. It does not cover V2 plugins which should no longer be developed.
|
||||
:doc:`microversions specific document <microversions>` covers the details
|
||||
around what is required for the microversions part. It does not cover V2
|
||||
plugins which should no longer be developed.
|
||||
|
||||
There may still be references to a v3 API both in comments and in the
|
||||
directory path of relevant files. This is because v2.1 first started
|
|
@ -241,8 +241,9 @@ If a new microversion API is added, the following needs to happen:
|
|||
|
||||
Notifications
|
||||
=============
|
||||
|
||||
* Every new notification type shall use the new versioned notification
|
||||
infrastructure documented in :doc:`notifications`
|
||||
infrastructure documented in :doc:`/notifications`
|
||||
|
||||
Release Notes
|
||||
=============
|
|
@ -18,16 +18,16 @@
|
|||
Overview
|
||||
========
|
||||
|
||||
The Nova project introduced the :doc:`placement service <placement>` as part of
|
||||
the Newton release. The service provides an HTTP API to manage inventories of
|
||||
different classes of resources, such as disk or virtual cpus, made available by
|
||||
entities called resource providers. Information provided through the placement
|
||||
API is intended to enable more effective accounting of resources in an
|
||||
OpenStack deployment and better scheduling of various entities in the cloud.
|
||||
The Nova project introduced the :doc:`placement service </placement>` as part
|
||||
of the Newton release. The service provides an HTTP API to manage inventories
|
||||
of different classes of resources, such as disk or virtual cpus, made available
|
||||
by entities called resource providers. Information provided through the
|
||||
placement API is intended to enable more effective accounting of resources in
|
||||
an OpenStack deployment and better scheduling of various entities in the cloud.
|
||||
|
||||
The document serves to explain the architecture of the system and to provide
|
||||
some guidance on how to maintain and extend the code. For more detail on why
|
||||
the system was created and how it does its job see :doc:`placement`.
|
||||
the system was created and how it does its job see :doc:`/placement`.
|
||||
|
||||
Big Picture
|
||||
===========
|
||||
|
@ -131,13 +131,13 @@ surprising or unexpected.
|
|||
Microversions
|
||||
=============
|
||||
|
||||
The placement API makes use of `microversions`_ to allow the release of
|
||||
new features on an opt in basis. See :doc:`placement` for an up to date
|
||||
history of the available microversions.
|
||||
The placement API makes use of `microversions`_ to allow the release of new
|
||||
features on an opt in basis. See :doc:`/placement` for an up to date history of
|
||||
the available microversions.
|
||||
|
||||
The rules around `when a microversion is needed`_ are the same as for the
|
||||
compute API. When adding a new microversion there are a few bits of
|
||||
required housekeeping that must be done in the code:
|
||||
The rules around when a microversion is needed are the same as for the
|
||||
:doc:`compute API </contributor/microversions>`. When adding a new microversion
|
||||
there are a few bits of required housekeeping that must be done in the code:
|
||||
|
||||
* Update the ``VERSIONS`` list in
|
||||
`nova.api.openstack.placement.microversion` to indicate the new
|
||||
|
@ -364,7 +364,6 @@ for an eventual extraction and avoid creating unnecessary interdependencies.
|
|||
.. _Request: http://docs.webob.org/en/latest/reference.html#request
|
||||
.. _Response: http://docs.webob.org/en/latest/#response
|
||||
.. _microversions: http://specs.openstack.org/openstack/api-wg/guidelines/microversion_specification.html
|
||||
.. _when a microversion is needed: http://docs.openstack.org/developer/nova/api_microversion_dev.html#when-do-i-need-a-new-microversion
|
||||
.. _release note: http://docs.openstack.org/developer/reno/usage.html
|
||||
.. _gabbi: https://gabbi.readthedocs.io/
|
||||
.. _telemetry: http://specs.openstack.org/openstack/telemetry-specs/specs/kilo/declarative-http-tests.html
|
|
@ -197,7 +197,7 @@ But let's put a Nova specific twist on things...
|
|||
Overview
|
||||
~~~~~~~~
|
||||
|
||||
.. image:: ./images/Nova_spec_process.svg
|
||||
.. image:: /_static/images/nova-spec-process.svg
|
||||
:alt: Flow chart showing the Nova bug/feature process
|
||||
|
||||
Where do you track bugs?
|
|
@ -27,7 +27,7 @@ Reporting Test Coverage
|
|||
=======================
|
||||
|
||||
For details on plans to report the current test coverage, please see:
|
||||
:doc:`feature_classification`
|
||||
:doc:`/feature_classification`
|
||||
|
||||
Running tests and reporting results
|
||||
===================================
|
|
@ -85,7 +85,7 @@ integration testing efforts.
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
test_strategy
|
||||
contributor/testing
|
||||
feature_classification
|
||||
support-matrix
|
||||
|
||||
|
@ -98,11 +98,11 @@ actually does, and why.
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
how_to_get_involved
|
||||
process
|
||||
contributor/how-to-get-involved
|
||||
contributor/process
|
||||
architecture
|
||||
project_scope
|
||||
development.environment
|
||||
contributor/project-scope
|
||||
contributor/development-environment
|
||||
|
||||
Development Policies
|
||||
--------------------
|
||||
|
@ -124,11 +124,11 @@ community, while keeping users happy and keeping developers productive.
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
process
|
||||
blueprints
|
||||
policies
|
||||
code-review
|
||||
releasenotes
|
||||
contributor/process
|
||||
contributor/blueprints
|
||||
contributor/policies
|
||||
contributor/code-review
|
||||
contributor/releasenotes
|
||||
|
||||
Architecture Concepts
|
||||
----------------------
|
||||
|
@ -146,7 +146,7 @@ Open Development.
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
addmethod.openstackapi
|
||||
contributor/api-2
|
||||
rpc
|
||||
block_device_mapping
|
||||
conductor
|
||||
|
@ -155,7 +155,7 @@ Open Development.
|
|||
i18n
|
||||
notifications
|
||||
placement
|
||||
placement_dev
|
||||
contributor/placement
|
||||
quotas
|
||||
threading
|
||||
vmstates
|
||||
|
@ -176,8 +176,8 @@ these are a great place to start reading up on the current plans.
|
|||
|
||||
cells
|
||||
upgrade
|
||||
api_plugins
|
||||
api_microversion_dev
|
||||
contributor/api
|
||||
contributor/microversions
|
||||
policy_enforcement
|
||||
stable_api
|
||||
scheduler_evolution
|
||||
|
@ -189,9 +189,9 @@ Advanced testing and guides
|
|||
:maxdepth: 1
|
||||
|
||||
gmr
|
||||
testing/libvirt-numa
|
||||
testing/serial-console
|
||||
testing/zero-downtime-upgrade
|
||||
contributor/testing/libvirt-numa
|
||||
contributor/testing/serial-console
|
||||
contributor/testing/zero-downtime-upgrade
|
||||
|
||||
Sample Configuration File
|
||||
-------------------------
|
||||
|
|
Loading…
Reference in New Issue