fc72b4d904
This patch is enabling the doc8 style checker for the *.rst files in
Ironic.
Since this patch is just the first stab at enabling this new check two
errors are currently being ignored by doc8 because of the number of
occurrences in our docs:
* D000 - Duplicated target names. We do have many links with generic
names scattered around the docs (e.g "see", "link")
* D001 - Line's too long
These errors will be fixed in a following patch.
Change-Id: I32fb5a3104b9773c55a80a84dd81e49c567c76ac
61 lines
1.3 KiB
ReStructuredText
61 lines
1.3 KiB
ReStructuredText
.. _contributing:
|
|
|
|
======================
|
|
Contributing to Ironic
|
|
======================
|
|
|
|
If you're interested in contributing to the Ironic project,
|
|
the following will help get you started.
|
|
|
|
Contributor License Agreement
|
|
-----------------------------
|
|
|
|
.. index::
|
|
single: license; agreement
|
|
|
|
In order to contribute to the Ironic project, you need to have
|
|
signed OpenStack's contributor's agreement.
|
|
|
|
.. seealso::
|
|
|
|
* http://docs.openstack.org/infra/manual/developers.html
|
|
* http://wiki.openstack.org/CLA
|
|
|
|
LaunchPad Project
|
|
-----------------
|
|
|
|
Most of the tools used for OpenStack depend on a launchpad.net ID for
|
|
authentication.
|
|
|
|
.. seealso::
|
|
|
|
* https://launchpad.net
|
|
* https://launchpad.net/ironic
|
|
|
|
Related Projects
|
|
-----------------
|
|
|
|
* https://launchpad.net/ironic-inspector
|
|
* https://launchpad.net/python-ironicclient
|
|
* https://launchpad.net/python-ironic-inspector-client
|
|
* https://launchpad.net/bifrost
|
|
|
|
Project Hosting Details
|
|
-------------------------
|
|
|
|
Bug tracker
|
|
http://launchpad.net/ironic
|
|
|
|
Mailing list (prefix subjects with ``[ironic]`` for faster responses)
|
|
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
|
|
|
|
Wiki
|
|
http://wiki.openstack.org/Ironic
|
|
|
|
Code Hosting
|
|
https://github.com/openstack/ironic
|
|
|
|
Code Review
|
|
https://review.openstack.org/#/q/status:open+project:openstack/ironic,n,z
|
|
|