Move doc/source/dev to doc/source/contributor
Change-Id: I6a3d143cff31348c62d8825f29f7484bafb9c8f0
This commit is contained in:
Sam Betts
parent
02015a4be6
commit
5647bfc246
2
.gitignore
vendored
2
.gitignore
vendored
@ -6,7 +6,7 @@
|
||||
|
||||
# Sphinx
|
||||
_build
|
||||
doc/source/api/
|
||||
doc/source/contributor/api/
|
||||
|
||||
# release notes build
|
||||
releasenotes/build
|
||||
|
||||
@ -331,7 +331,7 @@ Request a change to the Node's provision state.
|
||||
|
||||
Acceptable target states depend on the Node's current provision state. More
|
||||
detailed documentation of the Ironic State Machine is available
|
||||
`in the developer docs <http://docs.openstack.org/developer/ironic/dev/states.html>`_.
|
||||
`in the developer docs <http://docs.openstack.org/ironic/latest/contributor/states.html>`_.
|
||||
|
||||
Normal response code: 202
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@
|
||||
"rel": "self"
|
||||
},
|
||||
{
|
||||
"href": "https://docs.openstack.org/developer/ironic/dev/webapi.html",
|
||||
"href": "https://docs.openstack.org/ironic/latest/contributor/webapi.html",
|
||||
"rel": "describedby",
|
||||
"type": "text/html"
|
||||
}
|
||||
|
||||
@ -112,10 +112,10 @@ cluster, nodes may be remapped to different Conductors, thus triggering various
|
||||
driver actions such as take-over or clean-up.
|
||||
|
||||
|
||||
.. _API service: ../webapi/v1.html
|
||||
.. _BaseDriver: ../api/ironic.drivers.base.html#ironic.drivers.base.BaseDriver
|
||||
.. _Conductor service: ../api/ironic.conductor.manager.html
|
||||
.. _DB API: ../api/ironic.db.api.html
|
||||
.. _API service: webapi.html
|
||||
.. _BaseDriver: api/ironic.drivers.base.html#ironic.drivers.base.BaseDriver
|
||||
.. _Conductor service: api/ironic.conductor.manager.html
|
||||
.. _DB API: api/ironic.db.api.html
|
||||
.. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/
|
||||
.. _consistent hashing algorithm: http://docs.openstack.org/developer/tooz/tutorial/hashring.html
|
||||
.. _periodic: http://docs.openstack.org/developer/futurist/api.html#futurist.periodics.periodic
|
||||
86
doc/source/contributor/index.rst
Normal file
86
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,86 @@
|
||||
Developer's Guide
|
||||
=================
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
If you are new to ironic, this section contains information that should help
|
||||
you get started as a developer working on the project or contributing to the
|
||||
project.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Developer Contribution Guide <code-contribution-guide>
|
||||
Setting Up Your Development Environment <dev-quickstart>
|
||||
Frequently Asked Questions <faq>
|
||||
|
||||
The following pages describe the architecture of the Bare Metal service
|
||||
and may be helpful to anyone working on or with the service, but are written
|
||||
primarily for developers.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Ironic System Architecture <architecture>
|
||||
Provisioning State Machine <states>
|
||||
Developing New Notifications <notifications>
|
||||
|
||||
These pages contain information for PTLs, cross-project liaisons, and core
|
||||
reviewers.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Releasing Ironic Projects <releasing>
|
||||
Ironic Governance Structure <governance>
|
||||
|
||||
|
||||
Writing Drivers
|
||||
---------------
|
||||
|
||||
Ironic's community includes many hardware vendors who contribute drivers that
|
||||
enable more advanced functionality when Ironic is used in conjunction with that
|
||||
hardware. To do this, the Ironic developer community is committed to
|
||||
standardizing on a `Python Driver API <api/ironic.drivers.base.html>`_ that
|
||||
meets the common needs of all hardware vendors, and evolving this API without
|
||||
breaking backwards compatibility. However, it is sometimes necessary for driver
|
||||
authors to implement functionality - and expose it through the REST API - that
|
||||
can not be done through any existing API.
|
||||
|
||||
To facilitate that, we also provide the means for API calls to be "passed
|
||||
through" ironic and directly to the driver. Some guidelines on how to implement
|
||||
this are provided below. Driver authors are strongly encouraged to talk with
|
||||
the developer community about any implementation using this functionality.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Driver Overview <drivers>
|
||||
Driver Base Class Definition <api/ironic.drivers.base>
|
||||
Writing "vendor_passthru" methods <vendor-passthru>
|
||||
Third party continuous integration testing <third-party-ci>
|
||||
|
||||
Testing Network Integration
|
||||
---------------------------
|
||||
|
||||
In order to test the integration between the Bare Metal and Networking
|
||||
services, support has been added to `devstack <http://launchpad.net/devstack>`_
|
||||
to mimic an external physical switch. Here we include a recommended
|
||||
configuration for devstack to bring up this environment.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Configuring Devstack for multitenant network testing <ironic-multitenant-networking>
|
||||
|
||||
Full Ironic Server Python API Reference
|
||||
---------------------------------------
|
||||
|
||||
* :ref:`modindex`
|
||||
|
||||
.. # api/autoindex is hidden since it's in the modindex link above.
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
api/autoindex
|
||||
@ -40,7 +40,7 @@ Things to do before releasing
|
||||
|
||||
* For ironic releases only, not ironic-inspector releases: if any new API
|
||||
microversions have been added since the last release, update the REST API
|
||||
version history (doc/source/dev/webapi-version-history.rst) to
|
||||
version history (doc/source/contributor/webapi-version-history.rst) to
|
||||
indicate that they were part of the new release.
|
||||
|
||||
* To support rolling upgrades, add this new release version (and release name
|
||||
@ -54,7 +54,7 @@ Things to do before releasing
|
||||
* Regenerate the sample config file, so that the choices for the
|
||||
``[DEFAULT]/pin_release_version`` configuration are accurate.
|
||||
|
||||
.. _`standards`: http://docs.openstack.org/developer/ironic/dev/faq.html#know-if-a-release-note-is-needed-for-my-change
|
||||
.. _`standards`: http://docs.openstack.org/ironic/latest/contributor/faq.html#know-if-a-release-note-is-needed-for-my-change
|
||||
|
||||
Things to do after releasing
|
||||
============================
|
||||
@ -45,87 +45,19 @@ guide as well as more detailed reference documentation.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
API Concept Guide <dev/webapi>
|
||||
API Concept Guide <contributor/webapi>
|
||||
API Reference (latest) <http://developer.openstack.org/api-ref/baremetal/>
|
||||
API Version History <dev/webapi-version-history>
|
||||
API Reference (latest) <api/index>
|
||||
API Version History <contributor/webapi-version-history>
|
||||
|
||||
|
||||
Developer's Guide
|
||||
=================
|
||||
|
||||
Getting Started
|
||||
---------------
|
||||
|
||||
If you are new to ironic, this section contains information that should help
|
||||
you get started as a developer working on the project or contributing to the
|
||||
project.
|
||||
Contributor's Guide
|
||||
===================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Developer Contribution Guide <dev/code-contribution-guide>
|
||||
Setting Up Your Development Environment <dev/dev-quickstart>
|
||||
Frequently Asked Questions <dev/faq>
|
||||
|
||||
The following pages describe the architecture of the Bare Metal service
|
||||
and may be helpful to anyone working on or with the service, but are written
|
||||
primarily for developers.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Ironic System Architecture <dev/architecture>
|
||||
Provisioning State Machine <dev/states>
|
||||
Developing New Notifications <dev/notifications>
|
||||
|
||||
These pages contain information for PTLs, cross-project liaisons, and core
|
||||
reviewers.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Releasing Ironic Projects <dev/releasing>
|
||||
Ironic Governance Structure <dev/governance>
|
||||
|
||||
|
||||
Writing Drivers
|
||||
---------------
|
||||
|
||||
Ironic's community includes many hardware vendors who contribute drivers that
|
||||
enable more advanced functionality when Ironic is used in conjunction with that
|
||||
hardware. To do this, the Ironic developer community is committed to
|
||||
standardizing on a `Python Driver API <api/ironic.drivers.base.html>`_ that
|
||||
meets the common needs of all hardware vendors, and evolving this API without
|
||||
breaking backwards compatibility. However, it is sometimes necessary for driver
|
||||
authors to implement functionality - and expose it through the REST API - that
|
||||
can not be done through any existing API.
|
||||
|
||||
To facilitate that, we also provide the means for API calls to be "passed
|
||||
through" ironic and directly to the driver. Some guidelines on how to implement
|
||||
this are provided below. Driver authors are strongly encouraged to talk with
|
||||
the developer community about any implementation using this functionality.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Driver Overview <dev/drivers>
|
||||
Driver Base Class Definition <api/ironic.drivers.base>
|
||||
Writing "vendor_passthru" methods <dev/vendor-passthru>
|
||||
Third party continuous integration testing <dev/third-party-ci>
|
||||
|
||||
Testing Network Integration
|
||||
---------------------------
|
||||
|
||||
In order to test the integration between the Bare Metal and Networking
|
||||
services, support has been added to `devstack <http://launchpad.net/devstack>`_
|
||||
to mimic an external physical switch. Here we include a recommended
|
||||
configuration for devstack to bring up this environment.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
Configuring Devstack for multitenant network testing <dev/ironic-multitenant-networking>
|
||||
:maxdepth: 2
|
||||
|
||||
contributor/index
|
||||
|
||||
Administrator's Guide
|
||||
=====================
|
||||
@ -161,17 +93,14 @@ Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
.. # NOTE(jaegerandi): This is where we hide things that we don't want
|
||||
# shown in the top level table of contents. api/autoindex is hidden
|
||||
# since it's in the modindex link above.
|
||||
# shown in the top level table of contents.
|
||||
# user/index is referenced above but not in a toctree.
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
api/autoindex
|
||||
admin/install-guide.rst
|
||||
user/index
|
||||
releasenotes/index
|
||||
|
||||
@ -290,4 +290,4 @@ See `driver-specific documentation`_ for required configuration of each driver.
|
||||
.. _ironic-inspector: https://docs.openstack.org/developer/ironic-inspector/
|
||||
.. _inspection documentation: https://docs.openstack.org/ironic/latest/admin/inspection.html
|
||||
.. _RAID documentation: https://docs.openstack.org/ironic/latest/admin/raid.html
|
||||
.. _vendor methods documentation: https://docs.openstack.org/developer/ironic/dev/vendor-passthru.html
|
||||
.. _vendor methods documentation: https://docs.openstack.org/ironic/latest/contributor/vendor-passthru.html
|
||||
|
||||
@ -449,7 +449,7 @@ To move a node from ``manageable`` to ``available`` provision state:
|
||||
+------------------------+--------------------------------------------------------------------+
|
||||
|
||||
For more details on the Bare Metal service's state machine, see the
|
||||
`state machine <http://docs.openstack.org/developer/ironic/dev/states.html>`_
|
||||
`state machine <http://docs.openstack.org/ironic/latest/contributor/states.html>`_
|
||||
documentation.
|
||||
|
||||
.. _ComputeCapabilitiesFilter: http://docs.openstack.org/developer/nova/devref/filter_scheduler.html?highlight=computecapabilitiesfilter
|
||||
|
||||
@ -1,5 +0,0 @@
|
||||
========
|
||||
REST API
|
||||
========
|
||||
|
||||
The API documentation reference `has been moved here <../dev/webapi.html>`_.
|
||||
@ -102,7 +102,7 @@ class V1(base.APIBase):
|
||||
'v1', '', bookmark=True),
|
||||
link.Link.make_link('describedby',
|
||||
'https://docs.openstack.org',
|
||||
'developer/ironic/dev',
|
||||
'/ironic/latest/contributor/',
|
||||
'webapi.html',
|
||||
bookmark=True, type='text/html')
|
||||
]
|
||||
|
||||
Loading…
Reference in New Issue
Block a user