From 32c7a6cdd4d08983dbd260bfb349ceb5008e37d7 Mon Sep 17 00:00:00 2001 From: Roman Gorshunov Date: Fri, 24 Apr 2020 15:26:51 +0200 Subject: [PATCH] Add Project Specific Contributor and PTL Docs This patch amends contributor guidelines for the Ussuri goals. Change-Id: I9207d02a386e1250963b378bd9fd2188d78a613e Task: 38545 Story: 2007236 --- CONTRIBUTING.rst | 23 ++--- README.rst | 26 ++++-- doc/source/contributing.rst | 4 - doc/source/contributor/contributing.rst | 107 ++++++++++++++++++++++++ doc/source/index.rst | 2 +- doc/source/troubleshooting/index.rst | 9 +- horizon/values.yaml | 2 +- 7 files changed, 146 insertions(+), 27 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 2aa2b46788..b9c1e2d815 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/openstack-helm -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 as stories in Storyboard, not GitHub: +Bugs should be filed on StoryBoard: -https://storyboard.openstack.org/#!/project/886 + https://storyboard.openstack.org/#!/project/openstack/openstack-helm + +For more specific information about contributing to this repository, see the +openstack-helm contributor guide: + + https://docs.openstack.org/openstack-helm/latest/contributor/contributing.html diff --git a/README.rst b/README.rst index 0ce74bd3c0..0d1e942c2e 100644 --- a/README.rst +++ b/README.rst @@ -12,29 +12,35 @@ on Kubernetes. Communication ------------- -* Join us on `Slack `_ - #openstack-helm * Join us on `IRC `_: #openstack-helm on freenode -* Community IRC Meetings: [Every Tuesday @ 3PM UTC], - #openstack-meeting-4 on freenode +* Community `IRC Meetings + `_: + [Every Tuesday @ 3PM UTC], #openstack-meeting-alt on freenode * Meeting Agenda Items: `Agenda `_ +* Join us on `Slack `_ + - #openstack-helm Storyboard ---------- -Bugs and enhancements are tracked via OpenStack-Helm's `Storyboard `_. +Bugs and enhancements are tracked via OpenStack-Helm's +`Storyboard `_. Installation and Development ---------------------------- -Please review our `documentation `_. +Please review our +`documentation `_. For quick installation, evaluation, and convenience, we have a kubeadm based all-in-one solution that runs in a Docker container. The Kubeadm-AIO set -up can be found `here `_. +up can be found +`here `_. This project is under active development. We encourage anyone interested in -OpenStack-Helm to review our `Installation `_ +OpenStack-Helm to review our +`Installation `_ documentation. Feel free to ask questions or check out our current `Storyboard backlog `_. @@ -49,3 +55,9 @@ Developers wishing to work on the OpenStack-Helm project should always base their work on the latest code, available from the OpenStack-Helm git repository. `OpenStack-Helm git repository `_ + +Contributing +------------ + +We welcome contributions. Check out `this `_ document if +you would like to get involved. diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 1728a61ca2..0000000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,4 +0,0 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000000..07df2e767f --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,107 @@ +============================ +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. + +Additional information could be found in +`OpenDev Developer's Guide +`_. + +Below will cover the more project specific information you need to get started +with OpenStack-Helm. + +Communication +~~~~~~~~~~~~~ +.. This would be a good place to put the channel you chat in as a project; when/ + where your meeting is, the tags you prepend to your ML threads, etc. + +* Join us on `IRC `_: + #openstack-helm on freenode +* Community `IRC Meetings + `_: + [Every Tuesday @ 3PM UTC], #openstack-meeting-alt on freenode +* Meeting Agenda Items: `Agenda + `_ +* Join us on `Slack `_ + - #openstack-helm + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +.. This section should list the core team, their irc nicks, emails, timezones + etc. If all this info is maintained elsewhere (i.e. a wiki), you can link to + that instead of enumerating everyone here. + +Project's Core Team could be contacted via IRC or Slack, usually during weekly +meetings. List of current Cores could be found on a Members tab of +`openstack-helm-core `_ +Gerrit group. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +.. This section is for talking about the process to get a new feature in. Some + projects use blueprints, some want specs, some want both! Some projects + stick to a strict schedule when selecting what new features will be reviewed + for a release. + +New features are planned and implemented trough the process described in +`Project Specifications <../specs/index.html>`_ section of this document. + +Task Tracking +~~~~~~~~~~~~~ +.. This section is about where you track tasks- launchpad? storyboard? is there + more than one launchpad project? what's the name of the project group in + storyboard? + +We track our tasks on our StoryBoard_. + +If you're looking for some smaller, easier work item to pick up and get started +on, search for the 'low-hanging-fruit' tag. + +.. NOTE: If your tag is not 'low-hanging-fruit' please change the text above. + +Other OpenStack-Helm component's tasks could be found on the `group Storyboard`_. + +Reporting a Bug +~~~~~~~~~~~~~~~ +.. Pretty self explanatory section, link directly to where people should report + bugs for your project. + +You found an issue and want to make sure we are aware of it? You can do so on our +Storyboard_. + +If issue is on one of other OpenStack-Helm components, report it to the +appropriate `group Storyboard`_. + +Bugs should be filed as stories in Storyboard, not GitHub. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +.. This section should have info about what it takes to get something merged. Do + you require one or two +2's before +W? Do some of your repos require unit + test changes with all patches? etc. + +We require two Code-Review +2's from reviewers, before getting your patch merged +with giving Workforce +1. Trivial patches (e.g. typos) could be merged with one +Code-Review +2. + +Changes affecting code base often require CI tests and documentation to be added +in the same patch set. + +Pull requests submitted through GitHub will be ignored. + +Project Team Lead Duties +~~~~~~~~~~~~~~~~~~~~~~~~ +.. this section is where you can put PTL specific duties not already listed in + the common PTL guide (linked below), or if you already have them written + up elsewhere you can link to that doc here. + +All common PTL duties are enumerated in the `PTL guide +`_. + +.. _Storyboard: https://storyboard.openstack.org/#!/project/openstack/openstack-helm +.. _group Storyboard: https://storyboard.openstack.org/#!/project_group/64 diff --git a/doc/source/index.rst b/doc/source/index.rst index bf007f29bb..4d41927f22 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,7 +6,7 @@ Contents: .. toctree:: :maxdepth: 2 - contributing + contributor/contributing devref/index gates install/index diff --git a/doc/source/troubleshooting/index.rst b/doc/source/troubleshooting/index.rst index be5783c024..2e12574e90 100644 --- a/doc/source/troubleshooting/index.rst +++ b/doc/source/troubleshooting/index.rst @@ -2,7 +2,8 @@ Troubleshooting =============== -Sometimes things go wrong. These guides will help you solve many common issues with the following: +Sometimes things go wrong. These guides will help you solve many common +issues with the following: .. toctree:: :maxdepth: 2 @@ -18,12 +19,12 @@ Getting help Channels -------- -* Join us on `Slack `_ - #openstack-helm * Join us on `IRC `_: #openstack-helm on freenode +* Join us on `Slack `_ - #openstack-helm Bugs and Feature requests ------------------------- -When discovering a new bug, please report a bug in `Storyboard -`_. +Please, refer to +`Contribution guidelines <../contributor/contributing.html>`_. diff --git a/horizon/values.yaml b/horizon/values.yaml index 31bbe109a4..43351f71dd 100644 --- a/horizon/values.yaml +++ b/horizon/values.yaml @@ -451,7 +451,7 @@ conf: # in a future release, but is available as a temporary backup setting to ensure # compatibility with existing deployments. Further development will not be # done on the legacy experience. Please report any problems with the new - # experience via the Launchpad tracking system. + # experience via the StoryBoard tracking system. # # Toggle LAUNCH_INSTANCE_LEGACY_ENABLED and LAUNCH_INSTANCE_NG_ENABLED to # determine the experience to enable. Set them both to true to enable