Add index page for contributors guide
Add "releasenotes", "devstack_setup" and "driver-development-guide" to the index page, and add a releasenote guide for users. Change-Id: Ib9b36d015bac074fe65205c6ca14706e36e20195
This commit is contained in:
parent
27dba65ba6
commit
0da7417ccc
36
doc/source/contributor/index.rst
Normal file
36
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,36 @@
|
||||
===========================
|
||||
Contributor Documentation
|
||||
===========================
|
||||
|
||||
Contributing to Cybrog gives you the power to help add features, fix bugs,
|
||||
enhance documentation, and increase testing. Contributions of any type are
|
||||
valuable, and part of what keeps the project going. Here are a list of
|
||||
resources to get your started.
|
||||
|
||||
Basic Information
|
||||
=================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
contributing
|
||||
|
||||
Reviewing
|
||||
=========
|
||||
|
||||
* :doc:`/contributor/releasenotes`: When we need a release note for a
|
||||
contribution.
|
||||
|
||||
* :doc:`/contributor/devstack_setup`: Guidelines for handling setup devstack
|
||||
|
||||
* :doc:`/contributor/driver-development-guide`: Get your driver development
|
||||
guide to contribute
|
||||
|
||||
.. # NOTE: toctree needs to be placed at the end of the secion to
|
||||
# keep the document structure in the PDF doc.
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
releasenotes
|
||||
devstack_setup
|
||||
driver-development-guide
|
65
doc/source/contributor/releasenotes.rst
Normal file
65
doc/source/contributor/releasenotes.rst
Normal file
@ -0,0 +1,65 @@
|
||||
.. _releasenotes:
|
||||
|
||||
Release Notes
|
||||
=============
|
||||
|
||||
What is reno ?
|
||||
--------------
|
||||
|
||||
Cyborg uses `reno <https://docs.openstack.org/reno/latest/>`__ for providing
|
||||
release notes in-tree. That means that a patch can include a *reno file* or a
|
||||
series can have a follow-on change containing that file explaining what the
|
||||
impact is.
|
||||
|
||||
A *reno file* is a YAML file written in the ``releasenotes/notes`` tree which
|
||||
is generated using the *reno* tool this way:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e venv -- reno new <name-your-file>
|
||||
|
||||
where usually ``<name-your-file>`` can be ``bp-<blueprint_name>`` for a
|
||||
blueprint or ``bug-XXXXXX`` for a bugfix.
|
||||
|
||||
Refer to the `reno documentation
|
||||
<https://docs.openstack.org/reno/latest/user/index.html>`__ for more
|
||||
information.
|
||||
|
||||
|
||||
When a release note is needed
|
||||
-----------------------------
|
||||
|
||||
A release note is required anytime a reno section is needed. Below are some
|
||||
examples for each section. Any sections that would be blank should be left out
|
||||
of the note file entirely. If no section is needed, then you know you don't
|
||||
need to provide a release note :-)
|
||||
|
||||
* ``upgrade``
|
||||
* The patch has an `UpgradeImpact <https://docs.opendev.org/opendev/infra-manual/latest/developers.html#peer-review>`_ tag
|
||||
* A DB change needs some deployer modification (like a migration)
|
||||
* A configuration option change (deprecation, removal or modified default)
|
||||
* some specific changes that have a `DocImpact <https://docs.opendev.org/opendev/infra-manual/latest/developers.html#peer-review>`_ tag
|
||||
but require further action from an deployer perspective
|
||||
* any patch that requires an action from the deployer in general
|
||||
|
||||
* ``security``
|
||||
* If the patch fixes a known vulnerability
|
||||
|
||||
* ``features``
|
||||
* If the patch has an `APIImpact <https://docs.opendev.org/opendev/infra-manual/latest/developers.html#peer-review>`_ tag
|
||||
* For Cyborg api and python-cyborgclient changes, if it adds or changes a
|
||||
new command, including adding new options to existing commands
|
||||
* a new accelerator driver is provided or an existing driver impacts the
|
||||
:doc:`DriversSupportMatrix </reference/support-matrix>`
|
||||
|
||||
* ``critical``
|
||||
* Bugfixes categorized as Critical in storyboard *impacting users*
|
||||
|
||||
* ``fixes``
|
||||
* No clear definition of such bugfixes. Hairy long-standing bugs with high
|
||||
importance that have been fixed are good candidates though.
|
||||
|
||||
Three sections are left intentionally unexplained (``prelude``, ``issues`` and
|
||||
``other``). Those are targeted to be filled in close to the release time for
|
||||
providing details about the soon-ish release. Don't use them unless you know
|
||||
exactly what you are doing.
|
@ -87,9 +87,7 @@ Documentation for Developers
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
contributor/contributing
|
||||
contributor/devstack_setup
|
||||
contributor/driver-development-guide
|
||||
contributor/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
Loading…
Reference in New Issue
Block a user