Browse Source

Ussuri contrib docs community goal

This patch standardizes CONTRIBUTING.rst and adds
doc/source/contributor/contributing.rst

Change-Id: I0fb219c678991078a592ef4c06890c1a14e7af0d
changes/11/711011/4
Brian Rosmaita 2 years ago
parent
commit
304251007e
  1. 23
      CONTRIBUTING.rst
  2. 14
      doc/source/contributor/contributing.rst
  3. 8
      doc/source/index.rst

23
CONTRIBUTING.rst

@ -1,16 +1,19 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps in this page:
The source repository for this project can be found at:
https://docs.openstack.org/infra/manual/developers.html
https://opendev.org/openstack/os-brick
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
Pull requests submitted through GitHub are not monitored.
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/os-brick
https://bugs.launchpad.net/os-brick
For more specific information about contributing to this repository, see the
os-brick contributor guide:
https://docs.openstack.org/os-brick/latest/contributor/contributing.html

14
doc/source/contributor/contributing.rst

@ -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 os-brick library 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

8
doc/source/index.rst

@ -28,3 +28,11 @@ Reference
:maxdepth: 2
reference/index
Contributing
------------
.. toctree::
:maxdepth: 2
contributor/contributing
Loading…
Cancel
Save