[ussuri][goal] Update contributor documentation

Story: 2007236
Task: 38552
Change-Id: I6d634914c30dd0c63465f775d1d076407e73eb5e
This commit is contained in:
Tobias Urdin
2020-05-09 11:19:57 +02:00
parent a305eeda71
commit f983a3fef5
6 changed files with 70 additions and 55 deletions

View File

@@ -0,0 +1 @@
redirectmatch 301 ^/puppet-openstack-guide/([^/]+)/contributor/how-to-contribute.html$ /puppet-openstack-guide/$1/contributor/contributing.html

View File

@@ -35,6 +35,10 @@ todo_include_todos = True
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
# Add any paths that contain "extra" files, such as .htaccess or
# robots.txt.
html_extra_path = ['_extra']
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'

View File

@@ -12,38 +12,4 @@ It documents:
* The mission statement * The mission statement
* The repositories that are managed by the group * The repositories that are managed by the group
PTL duty
========
While the official OpenStack PTL duty `guide`_ is general, the Puppet
OpenStack PTL is usually in charge of:
* community management by keeping abreast of upcoming meetings
(summits, OPS meetups) where it would be interesting for our
community to be represented.
* weekly meeting organization.
* OpenStack Cross-Project liaison.
Core-reviewers team
===================
Puppet OpenStack has a `core-reviewers`_ list, that can merge any code in our
repositories.
We also have sub-groups for puppet-keystone and puppet-neutron (more in the
future) modules with people who can merge code in these repositories.
It allows people who are experts in one OpenStack component and involved in
the Puppet module, to become core, and improve our review quality.
Release team
============
Puppet OpenStack releases are done with the help of the OpenStack Release Team.
.. _documented: http://governance.openstack.org/reference/projects/puppet-openstack.html .. _documented: http://governance.openstack.org/reference/projects/puppet-openstack.html
.. _core-reviewers: https://review.opendev.org/#/admin/groups/134,members
.. _guide: https://wiki.openstack.org/wiki/PTL_Guide

View File

@@ -0,0 +1,64 @@
============================
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 Puppet OpenStack team manages a lot of OpenStack related Puppet modules for
consumation by deployers, below topics covers Puppet OpenStack specific contribution
standards.
.. toctree::
:titlesonly:
:maxdepth: 1
coding-style
testing
new-module
backporting
reviews
Communication
~~~~~~~~~~~~~
* If you have something to discuss use
`OpenStack discuss mail-list <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss>`_.
Prefix the mail subject with ``[puppet]``
* Join ``#puppet-openstack`` IRC channel on `freenode <http://freenode.net/>`_
Contacting the Core Team
~~~~~~~~~~~~~~~~~~~~~~~~
* The core team has coverage in multiple timezones.
* Just pop over to IRC; we keep a close eye on it!
* You can also find the email addresses of the core team `here <https://review.opendev.org/#/admin/groups/134,members>`_.
Some modules have sub-groups with more cores that help maintain specific modules.
New Feature Planning
~~~~~~~~~~~~~~~~~~~~
Puppet OpenStack uses specs to track major feature requests but does not
require it for smaller changes. Specs follow a defined format and are
submitted as change requests to the openstack/puppet-openstack-specs
repository.
Reporting a Bug
~~~~~~~~~~~~~~~
We currently use Launchpad to track bugs per Puppet module, because of
limited resources we do no longer perform triage, please let us know on
IRC or to core members to raise our attention.
Getting Your Patch Merged
~~~~~~~~~~~~~~~~~~~~~~~~~
Typically two +2s are required before merging.
Project Team Lead Duties
~~~~~~~~~~~~~~~~~~~~~~~~
If you are the PTL of Puppet OpenStack then you should follow the `PTL guide
<https://docs.openstack.org/project-team-guide/ptl.html>`_.

View File

@@ -1,20 +0,0 @@
=================
How to contribute
=================
Do you want know how to submit changes to OpenStack? See this link_.
If you want to know about the efforts we are doing in Puppet OpenStack
we have a `Trello board <https://trello.com/b/4X3zxWRZ/on-going-effort>`_
.. _link: http://docs.openstack.org/infra/manual/developers.html
.. toctree::
:titlesonly:
:maxdepth: 1
coding-style
testing
new-module
backporting
reviews

View File

@@ -6,7 +6,7 @@ Puppet Openstack Contributor Guide
:includehidden: :includehidden:
module-list module-list
how-to-contribute contributing
community community
talk-to-us talk-to-us
ci ci