From fe4728d0acfc7ca9c9a2010af25d5ed0c7d6ad38 Mon Sep 17 00:00:00 2001 From: Jeremy Freudberg Date: Wed, 22 Apr 2020 13:43:23 -0400 Subject: [PATCH] Ussuri contributor docs community goal - Updated CONTRIBUTING.rst per goal guidelines - Created doc/source/contributor/contributing.rst per goal guidelines Change-Id: I8b0a19d70e84a75a3ed165505d012a7291f80148 --- CONTRIBUTING.rst | 19 +++++++++++++++++++ doc/source/contributor/contributing.rst | 14 ++++++++++++++ doc/source/contributor/index.rst | 8 ++++++++ doc/source/index.rst | 1 + 4 files changed, 42 insertions(+) create mode 100644 CONTRIBUTING.rst create mode 100644 doc/source/contributor/contributing.rst create mode 100644 doc/source/contributor/index.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..105514a --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,19 @@ +The source repository for this project can be found at: + + https://opendev.org/openstack/sahara-plugin-ambari + +Pull requests submitted through GitHub are not monitored. + +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: + + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html + +Bugs should be filed on Storyboard: + + https://storyboard.openstack.org/#!/project/openstack/sahara-plugin-ambari + +For more specific information about contributing to this repository, see the +sahara-plugin-ambari contributor guide: + + https://docs.openstack.org/sahara-plugin-ambari/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..14e8c8c --- /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. + +sahara-plugin-ambari 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 new file mode 100644 index 0000000..5534923 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,8 @@ +================= +Contributor Guide +================= + +.. toctree:: + :maxdepth: 2 + + contributing diff --git a/doc/source/index.rst b/doc/source/index.rst index b6dcb6a..50733dc 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,3 +5,4 @@ Ambari plugin for Sahara :maxdepth: 2 user/index + contributor/index