summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Rosmaita <rosmaita.fossdev@gmail.com>2020-03-03 08:42:23 -0500
committerBrian Rosmaita <rosmaita.fossdev@gmail.com>2020-03-05 09:31:16 -0500
commit9191d76450c0d80400a08e730a8f54f826e23022 (patch)
treeb9789d7dabb4386df99acf2aa76f24d6f6177702
parent8d0d0521c62aafc5cb364dd8033635fd8f88f826 (diff)
downloadpython-cinderclient-9191d76450c0d80400a08e730a8f54f826e23022.tar.gz
Ussuri contrib docs community goal
This patch standardizes the CONTRIBUTING.rst file and adds doc/source/contributor/contributing.rst Change-Id: I892e49f96573b77b46bd8847a5d2ac8254e8e5e1
-rw-r--r--CONTRIBUTING.rst23
-rw-r--r--doc/source/contributor/contributing.rst14
-rw-r--r--doc/source/index.rst1
3 files changed, 28 insertions, 10 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 80ea3b5..5d5f772 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/python-cinderclient
-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 in GitHub's issue tracker:
+Bugs should be filed on Launchpad:
- https://bugs.launchpad.net/python-cinderclient
+ https://bugs.launchpad.net/python-cinderclient
+
+For more specific information about contributing to this repository, see the
+cinderclient contributor guide:
+
+ https://docs.openstack.org/python-cinderclient/latest/contributor/contributing.html
diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst
new file mode 100644
index 0000000..b43385a
--- /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 <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-cinderclient 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 0859574..557bddc 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -57,6 +57,7 @@ Developer Guides
.. toctree::
:maxdepth: 2
+ contributor/contributing
contributor/functional_tests
contributor/unit_tests