From 0469f861827d63e436916ea5c95e6b8c64fdf56d Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Tue, 21 Apr 2020 20:13:55 -0500 Subject: [PATCH] [ussuri][goal] Update contributor documentation This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38554 Change-Id: I11f746df8ddfba5cf0b1e33778c9939a0a5fc760 --- CONTRIBUTING.rst | 26 ++++++------ doc/source/contributing.rst | 1 - doc/source/contributor/contributing.rst | 55 +++++++++++++++++++++++++ doc/source/index.rst | 10 ++++- 4 files changed, 77 insertions(+), 15 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index e8ddfd7..e81f89e 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,19 +1,19 @@ -Contributing -============ -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: -* http://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/stackviz -If you already have a good understanding of how the system works and your -OpenStack accounts are set up, you can skip to the development workflow -section of this documentation to learn how changes to OpenStack should be -submitted for review via the Gerrit tool: +Pull requests submitted through GitHub are not monitored. -* http://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/stackviz + https://bugs.launchpad.net/tempest (We use Tempest Launchpad for Stackviz bugs tracking.) + +For more specific information about contributing to this repository, see the +Stackviz contributor guide: + + https://docs.openstack.org/stackviz/latest/contributor/contributing.html diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index ac7b6bc..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..c4ce68a --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,55 @@ +============================ +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. + +Below will cover the more project specific information you need to get started +with Stackviz. + +Communication +~~~~~~~~~~~~~ +* IRC channel ``#openstack-qa`` at FreeNode +* Mailing list (prefix subjects with ``[qa]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer to the `Stackviz Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +If you want to propose a new feature please read `Feature Proposal Process`_ + +Task Tracking +~~~~~~~~~~~~~ +There is no separate task tracking tool for Stackviz, we track our tasks in +`Launchpad `__. + +Reporting a Bug +~~~~~~~~~~~~~~~ +You found an issue and want to make sure we are aware of it? You can do so on +`Launchpad `__. There is no separate +Launchpad for Stackviz. +More info about Launchpad usage can be found on `OpenStack docs page +`_ + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the Stackviz requires single ``Code-Review +2`` votes as minimum from +Stackviz core reviewers who can approve patch by giving ``Workflow +1`` vote. + +Project Team Lead Duties +~~~~~~~~~~~~~~~~~~~~~~~~ +All common PTL duties are enumerated in the `PTL guide +`_. + +The Release Process for QA is documented in `QA Release Process +`_. + +.. _Feature Proposal Process: https://wiki.openstack.org/wiki/QA#Feature_Proposal_.26_Design_discussions diff --git a/doc/source/index.rst b/doc/source/index.rst index aaa177f..3249e67 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -19,7 +19,15 @@ Local Stackviz readme installation usage - contributing + +For Contributor +--------------- +If you are a new contributor to Stackviz please refer: :doc:`contributor/contributing` + +.. toctree:: + :hidden: + + contributor/contributing Manual Pages ------------