diff options
author | Matthew Oliver <matt@oliver.net.au> | 2020-05-13 15:36:22 +1000 |
---|---|---|
committer | Matthew Oliver <matt@oliver.net.au> | 2020-05-13 15:36:22 +1000 |
commit | 6e000d11e45e6c6c4d7c236d3c42338d685b95ae (patch) | |
tree | 0b3d38416a74f876586ba5facaafaaf7d0010eea /doc | |
parent | eecdcdefbc2c2c0a1c6720ee324d95875a92ea0d (diff) | |
download | python-swiftclient-6e000d11e45e6c6c4d7c236d3c42338d685b95ae.tar.gz |
Ussuri contrib docs community goal
This patch standardizes the CONTRIBUTING.rst file and adds the
required doc/source/contributor/contributing.rst
The contibuting.txt points to the Swift contributor documentation.
Change-Id: Ia6c105698dd0269479536645270d12a7c1061bc7
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/contributor/contributing.rst | 14 | ||||
-rw-r--r-- | doc/source/index.rst | 1 |
2 files changed, 15 insertions, 0 deletions
diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..b9f1e91 --- /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-swiftclient is maintained by the OpenStack Swift project. +To understand our development process and how you can contribute to it, please +look at the Swift project's general contributor's page: +http://docs.openstack.org/swift/latest/contributor/contributing.html
\ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index ab05c6b..ae30972 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,6 +16,7 @@ Developer Documentation .. toctree:: :maxdepth: 2 + contributor/contributing cli/index service-api client-api |