From f983a3fef5b3f6598d84db10040c9cc93de1f7e1 Mon Sep 17 00:00:00 2001 From: Tobias Urdin Date: Sat, 9 May 2020 11:19:57 +0200 Subject: [PATCH] [ussuri][goal] Update contributor documentation Story: 2007236 Task: 38552 Change-Id: I6d634914c30dd0c63465f775d1d076407e73eb5e --- doc/source/_extra/.htaccess | 1 + doc/source/conf.py | 4 ++ doc/source/contributor/community.rst | 34 ----------- doc/source/contributor/contributing.rst | 64 ++++++++++++++++++++ doc/source/contributor/how-to-contribute.rst | 20 ------ doc/source/contributor/index.rst | 2 +- 6 files changed, 70 insertions(+), 55 deletions(-) create mode 100644 doc/source/_extra/.htaccess create mode 100644 doc/source/contributor/contributing.rst delete mode 100644 doc/source/contributor/how-to-contribute.rst diff --git a/doc/source/_extra/.htaccess b/doc/source/_extra/.htaccess new file mode 100644 index 0000000..7bb5129 --- /dev/null +++ b/doc/source/_extra/.htaccess @@ -0,0 +1 @@ +redirectmatch 301 ^/puppet-openstack-guide/([^/]+)/contributor/how-to-contribute.html$ /puppet-openstack-guide/$1/contributor/contributing.html diff --git a/doc/source/conf.py b/doc/source/conf.py index 68b3566..70160a1 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -35,6 +35,10 @@ todo_include_todos = True # Add any paths that contain templates here, relative to this directory. 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. source_suffix = '.rst' diff --git a/doc/source/contributor/community.rst b/doc/source/contributor/community.rst index 392eff4..0dcd617 100644 --- a/doc/source/contributor/community.rst +++ b/doc/source/contributor/community.rst @@ -12,38 +12,4 @@ It documents: * The mission statement * 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 -.. _core-reviewers: https://review.opendev.org/#/admin/groups/134,members -.. _guide: https://wiki.openstack.org/wiki/PTL_Guide diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..77a9373 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,64 @@ +============================ +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. + +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 `_. + Prefix the mail subject with ``[puppet]`` + +* Join ``#puppet-openstack`` IRC channel on `freenode `_ + +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 `_. + +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 +`_. diff --git a/doc/source/contributor/how-to-contribute.rst b/doc/source/contributor/how-to-contribute.rst deleted file mode 100644 index 7c9b5bb..0000000 --- a/doc/source/contributor/how-to-contribute.rst +++ /dev/null @@ -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 `_ - -.. _link: http://docs.openstack.org/infra/manual/developers.html - -.. toctree:: - :titlesonly: - :maxdepth: 1 - - coding-style - testing - new-module - backporting - reviews diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index e79c80f..24f7158 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -6,7 +6,7 @@ Puppet Openstack Contributor Guide :includehidden: module-list - how-to-contribute + contributing community talk-to-us ci