Merge "Update front page of contributor guide"
This commit is contained in:
commit
a3ec7e7dc9
@ -17,6 +17,13 @@ team organizes work, please see `Ironic's contribution guide <https://docs.opens
|
|||||||
This document covers both :ref:`unit` and :ref:`integrated`. New contributors
|
This document covers both :ref:`unit` and :ref:`integrated`. New contributors
|
||||||
are recommended to start with unit tests.
|
are recommended to start with unit tests.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
devstack-guide
|
||||||
|
bifrost-dev-guide
|
||||||
|
local-dev-guide
|
||||||
|
|
||||||
.. _integrated:
|
.. _integrated:
|
||||||
|
|
||||||
Integrated Testing Environments
|
Integrated Testing Environments
|
||||||
|
@ -264,8 +264,13 @@ Other Devstack Configurations
|
|||||||
There are additional devstack configurations in other parts of contributor
|
There are additional devstack configurations in other parts of contributor
|
||||||
documentation:
|
documentation:
|
||||||
|
|
||||||
* :ref:`Ironic Boot from Volume <BFVDevstack>`
|
|
||||||
* :ref:`Ironic w/Multitenant Networking <DevstackMTNetwork>`
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Ironic Boot from Volume <ironic-boot-from-volume>
|
||||||
|
Ironic w/Multitenant Networking <ironic-multitenant-networking>
|
||||||
|
|
||||||
|
|
||||||
Deploying to Ironic node using Nova
|
Deploying to Ironic node using Nova
|
||||||
===================================
|
===================================
|
||||||
|
@ -8,15 +8,39 @@ 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
|
you get started as a developer working on the project or contributing to the
|
||||||
project.
|
project.
|
||||||
|
|
||||||
|
This guide assumes you have read the
|
||||||
|
`OpenDev getting started documentation <https://docs.opendev.org/opendev/infra-manual/latest/gettingstarted.html>`_.
|
||||||
|
It will also be helpful to be familiar with
|
||||||
|
`OpenStack contributors documentation <https://docs.openstack.org/contributors/code-and-documentation/>`_,
|
||||||
|
which contains basic information about how to use many of the community tools
|
||||||
|
and OpenStack practices.
|
||||||
|
|
||||||
|
Basics
|
||||||
|
______
|
||||||
|
|
||||||
|
Basic information about setting up development environments with devstack
|
||||||
|
or bifrost, or getting unit tests running can be found in our
|
||||||
|
:ref:`dev-quickstart`.
|
||||||
|
|
||||||
|
Bugs
|
||||||
|
----
|
||||||
|
Information about how ironic projects handle bugs can be found below.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Bugs Reporting and Triaging Guide <bugs>
|
||||||
|
Bug Deputy Guide <bug-deputy>
|
||||||
|
|
||||||
|
|
||||||
|
Community & Policies
|
||||||
|
____________________
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
Bare Metal Community <community>
|
Bare Metal Community <community>
|
||||||
Developer Contribution Guide <contributing>
|
Developer Contribution Guide <contributing>
|
||||||
Bugs Reporting and Triaging Guide <bugs>
|
|
||||||
Bug Deputy Guide <bug-deputy>
|
|
||||||
Setting Up Your Development Environment <dev-quickstart>
|
|
||||||
Priorities <https://specs.openstack.org/openstack/ironic-specs/#priorities>
|
|
||||||
Specifications <https://specs.openstack.org/openstack/ironic-specs/>
|
Specifications <https://specs.openstack.org/openstack/ironic-specs/>
|
||||||
Frequently Asked Questions <faq>
|
Frequently Asked Questions <faq>
|
||||||
Contributor Vision <vision>
|
Contributor Vision <vision>
|
||||||
@ -48,9 +72,7 @@ reviewers.
|
|||||||
:hidden:
|
:hidden:
|
||||||
|
|
||||||
states
|
states
|
||||||
bifrost-dev-guide
|
dev-quickstart
|
||||||
local-dev-guide
|
|
||||||
devstack-guide
|
|
||||||
|
|
||||||
Writing Drivers
|
Writing Drivers
|
||||||
---------------
|
---------------
|
||||||
@ -78,30 +100,6 @@ the developer community about any implementation using this functionality.
|
|||||||
Third party continuous integration testing <third-party-ci>
|
Third party continuous integration testing <third-party-ci>
|
||||||
Writing Deploy or Clean Steps <deploy-steps>
|
Writing Deploy or Clean Steps <deploy-steps>
|
||||||
|
|
||||||
Testing Network Integration
|
|
||||||
---------------------------
|
|
||||||
|
|
||||||
In order to test the integration between the Bare Metal and Networking
|
|
||||||
services, support has been added to `devstack <https://docs.openstack.org/devstack/latest/>`_
|
|
||||||
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>
|
|
||||||
|
|
||||||
Testing Boot-from-Volume
|
|
||||||
------------------------
|
|
||||||
|
|
||||||
Starting with the Pike release, it is also possible to use DevStack for testing
|
|
||||||
booting from Cinder volumes with VMs.
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
Configuring Devstack for boot-from-volume testing <ironic-boot-from-volume>
|
|
||||||
|
|
||||||
Full Ironic Server Python API Reference
|
Full Ironic Server Python API Reference
|
||||||
---------------------------------------
|
---------------------------------------
|
||||||
|
|
||||||
@ -123,25 +121,3 @@ the documentation below.
|
|||||||
Job roles in the CI <jobs-description>
|
Job roles in the CI <jobs-description>
|
||||||
How to add a new job? <adding-new-job>
|
How to add a new job? <adding-new-job>
|
||||||
How to debug failures in CI jobs <debug-ci-failures>
|
How to debug failures in CI jobs <debug-ci-failures>
|
||||||
|
|
||||||
Our policy for stable branches
|
|
||||||
------------------------------
|
|
||||||
|
|
||||||
Stable branches that are on `Extended Maintenance`_ and haven't received
|
|
||||||
backports in a while, can be tagged as ``Unmaintained``, after discussions
|
|
||||||
within the ironic community. If such a decision is taken, an email will
|
|
||||||
be sent to the OpenStack mailing list.
|
|
||||||
|
|
||||||
What does ``Unmaintained`` mean? The branch still exists, but the ironic
|
|
||||||
upstream community will not actively backport patches from maintained
|
|
||||||
branches. Fixes can still be merged, though, if pushed into review by
|
|
||||||
operators or other downstream developers. It also means that branchless
|
|
||||||
projects (e.g.: ironic-tempest-plugin), may not have configurations that are
|
|
||||||
compatible with those branches.
|
|
||||||
|
|
||||||
As of 09 March 2020, the list of ``Unmaintained`` branches includes:
|
|
||||||
|
|
||||||
* Ocata (Last commit - Jun 28, 2019)
|
|
||||||
* Pike (Last commit - Oct 2, 2019)
|
|
||||||
|
|
||||||
.. _Extended Maintenance: https://docs.openstack.org/project-team-guide/stable-branches.html#maintenance-phases
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user