From 304251007edcfa32eb82f1376818632a4a33b001 Mon Sep 17 00:00:00 2001 From: Brian Rosmaita Date: Tue, 3 Mar 2020 08:35:54 -0500 Subject: [PATCH] Ussuri contrib docs community goal This patch standardizes CONTRIBUTING.rst and adds doc/source/contributor/contributing.rst Change-Id: I0fb219c678991078a592ef4c06890c1a14e7af0d --- CONTRIBUTING.rst | 23 +++++++++++++---------- doc/source/contributor/contributing.rst | 14 ++++++++++++++ doc/source/index.rst | 8 ++++++++ 3 files changed, 35 insertions(+), 10 deletions(-) create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8420d4804..4501d0503 100644 --- a/CONTRIBUTING.rst +++ b/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 diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..5e1e9094b --- /dev/null +++ b/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 `_ 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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 496779343..6d96c7cf4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -28,3 +28,11 @@ Reference :maxdepth: 2 reference/index + +Contributing +------------ + +.. toctree:: + :maxdepth: 2 + + contributor/contributing