summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Freudberg <jeremyfreudberg@gmail.com>2020-04-22 13:59:09 -0400
committerJeremy Freudberg <jeremyfreudberg@gmail.com>2020-04-22 14:00:21 -0400
commitcaf07f433f7728877326baf3f20fa3a3ff736ac7 (patch)
tree5abde5ea5cd9d95fef670bb674a52ca6a0995733
parent8c7735d7acc1962e410af2d0d2d2be8e756f395f (diff)
downloadpython-saharaclient-caf07f433f7728877326baf3f20fa3a3ff736ac7.tar.gz
Ussuri contributor docs community goal
- Updated CONTRIBUTING.rst per goal guidelines - Created doc/source/contributor/contributing.rst per goal guidelines Change-Id: I4a72ec5cec7e48aacc5ce080609fc89f063e7337
-rw-r--r--CONTRIBUTING.rst24
-rw-r--r--doc/source/contributor/contributing.rst14
-rw-r--r--doc/source/contributor/index.rst20
-rw-r--r--doc/source/index.rst1
4 files changed, 31 insertions, 28 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 918dede..358d773 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,21 +1,19 @@
-If you would like to contribute to the development of OpenStack,
-you must follow the steps in the "If you're a developer"
-section of this page:
+The source repository for this project can be found at:
- https://wiki.openstack.org/wiki/How_To_Contribute
+ https://opendev.org/openstack/python-saharaclient
-You can find more Sahara-specific info in our How To Participate guide:
+Pull requests submitted through GitHub are not monitored.
- https://docs.openstack.org/python-saharaclient/latest/how_to_participate.html
+To start contributing to OpenStack, follow the steps in the contribution guide
+to set up and use Gerrit:
-Once those steps have been completed, changes to OpenStack
-should be submitted for review via the Gerrit tool, following
-the workflow documented at:
+ https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
- https://docs.openstack.org/infra/manual/developers.html#development-workflow
+Bugs should be filed on Storyboard:
-Pull requests submitted through GitHub will be ignored.
+ https://storyboard.openstack.org/#!/project/openstack/python-saharaclient
-Bugs should be filed on Storyboard, not GitHub:
+For more specific information about contributing to this repository, see the
+python-saharaclient contributor guide:
- https://storyboard.openstack.org/#!/project/934
+ https://docs.openstack.org/python-saharaclient/latest/contributor/contributing.html
diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst
new file mode 100644
index 0000000..14e88dd
--- /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.
+
+python-saharaclient is maintained by the OpenStack Sahara project.
+To understand our development process and how you can contribute to it, please
+look at the Sahara project's general contributor's page:
+http://docs.openstack.org/sahara/latest/contributor/contributing.html
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
index f89906b..5534923 100644
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@@ -1,16 +1,8 @@
-Contributing
-============
+=================
+Contributor Guide
+=================
-``python-saharaclient`` is part of the Sahara project.
-It has a separate `storyboard`_ page which should be used to report bugs.
-Like the other projects of the OpenStack community, code contribution happens
-through `gerrit`_.
+.. toctree::
+ :maxdepth: 2
-Please refer to the `Sahara documentation`_ and its
-`How to Participate section`_ for more information on
-how to contribute to the project.
-
-.. _Sahara documentation: https://docs.openstack.org/sahara/latest/
-.. _How to Participate section: https://docs.openstack.org/sahara/latest/contributor/how-to-participate.html
-.. _storyboard: https://storyboard.openstack.org/#!/project/934
-.. _gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow
+ contributing
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 68c0f56..f6969fb 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -23,4 +23,3 @@ Contents:
reference/index
cli/index
contributor/index
-