Ussuri contrib docs community goal
This patch standardizes the CONTRIBUTING.rst file and adds doc/source/contributor/contributing.rst Change-Id: I3e66bc36b22bcae65e5f3363b49fe9fa455758a7
This commit is contained in:
parent
56ba19d1c3
commit
3d331c37e2
@ -1,17 +1,25 @@
|
|||||||
If you would like to contribute to the development of OpenStack, you must
|
The source repository for this project can be found at:
|
||||||
follow the steps in this page:
|
|
||||||
|
|
||||||
https://docs.openstack.org/infra/manual/developers.html
|
https://opendev.org/openstack/python-brick-cinderclient-ext
|
||||||
|
|
||||||
If you already have a good understanding of how the system works and your
|
Pull requests submitted through GitHub are not monitored.
|
||||||
OpenStack accounts are set up, you can skip to the development workflow
|
|
||||||
section of this documentation to learn how changes to OpenStack should be
|
|
||||||
submitted for review via the Gerrit tool:
|
|
||||||
|
|
||||||
https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
To start contributing to OpenStack, follow the steps in the contribution guide
|
||||||
|
to set up and use Gerrit:
|
||||||
|
|
||||||
Pull requests submitted through GitHub will be ignored.
|
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||||
|
|
||||||
Bugs should be filed on Launchpad, not GitHub:
|
Bugs should be filed on Launchpad:
|
||||||
|
|
||||||
https://bugs.launchpad.net/brick-python-cinderclient-ext
|
https://bugs.launchpad.net/python-cinderclient
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
When creating a bug, please tag it with 'brick-cinderclient-ext'.
|
||||||
|
To create a tag, select the 'Extra options' after filling in the
|
||||||
|
bug description and type **brick-cinderclient-ext** in the 'Tags'
|
||||||
|
text box.
|
||||||
|
|
||||||
|
For more specific information about contributing to this repository, see the
|
||||||
|
python-brick-cinderclient-ext contributor guide:
|
||||||
|
|
||||||
|
https://docs.openstack.org/python-brick-cinderclient-ext/latest/contributor/contributing.html
|
||||||
|
@ -1,4 +0,0 @@
|
|||||||
============
|
|
||||||
Contributing
|
|
||||||
============
|
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
|
14
doc/source/contributor/contributing.rst
Normal file
14
doc/source/contributor/contributing.rst
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
============================
|
||||||
|
So You Want to Contribute...
|
||||||
|
============================
|
||||||
|
|
||||||
|
For general information on contributing to OpenStack, please check out the
|
||||||
|
`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
|
||||||
|
It covers all the basics that are common to all OpenStack projects: the
|
||||||
|
accounts you need, the basics of interacting with our Gerrit review system, how
|
||||||
|
we communicate as a community, etc.
|
||||||
|
|
||||||
|
The python-brick-cinderclient-ext is maintained by the OpenStack Cinder
|
||||||
|
project. To understand our development process and how you can contribute to
|
||||||
|
it, please look at the Cinder project's general contributor's page:
|
||||||
|
http://docs.openstack.org/cinder/latest/contributor/contributing.html
|
@ -14,7 +14,7 @@ Contents:
|
|||||||
readme
|
readme
|
||||||
installation
|
installation
|
||||||
usage
|
usage
|
||||||
contributing
|
contributor/contributing
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
Loading…
Reference in New Issue
Block a user