From 52abfa977fedef2d1284ef6e2be8d2846d68510a Mon Sep 17 00:00:00 2001 From: Jeremy Stanley Date: Sun, 26 May 2013 13:45:09 +0000 Subject: [PATCH] Clarify StackForge document audience and workflow. * doc/source/stackforge.rst: Adjust the project onboarding sequence to suggest requesting an initial group member last, since this seems to be the simpler and less error-prone order. Also add a brief subsection to the introduction describing the intended audience and linking to prerequisite documentation for those who need some additional education on OpenStack code review process and convention. Change-Id: I4a7cc6e56505a462c5596abe587c560bfa722f00 Reviewed-on: https://review.openstack.org/30564 Reviewed-by: slamet hendry Reviewed-by: James E. Blair Approved: Clark Boylan Reviewed-by: Clark Boylan Tested-by: Jenkins --- doc/source/stackforge.rst | 44 +++++++++++++++++++++++++++------------ 1 file changed, 31 insertions(+), 13 deletions(-) diff --git a/doc/source/stackforge.rst b/doc/source/stackforge.rst index 3c9f295b10..b105656be5 100644 --- a/doc/source/stackforge.rst +++ b/doc/source/stackforge.rst @@ -23,22 +23,24 @@ What StackForge is not: first step in that process as it exposes the project to the OpenStack way of doing things). +Audience +******** + +The focus of StackForge is to provide a place for OpenStack contributors +to maintain related unofficial projects using the same tools and +procedures as they employ when working on official OpenStack projects, +to make it easier for other OpenStack developers to contribute effort to +those projects and in some cases to ease a project's path to incubation +and official integration. As such, the target audience for this document +is current OpenStack developers who are assumed to already be familiar +with how changes are uploaded and reviewed within OpenStack projects. As +an introduction to OpenStack contribution, it is recommend to first read +https://wiki.openstack.org/wiki/How_To_Contribute and in particular the +https://wiki.openstack.org/wiki/Gerrit_Workflow article linked from it. + Add a Project to StackForge *************************** -Request a Core Group in Gerrit -============================== - -StackForge uses Gerrit for group management. The first step in -creating a StackForge project is to request a group in Gerrit called -``your-project-name-core``. Members of this team will have permissions -to approve code changes to your project, and to add other Gerrit users -to the group. - -You can request Gerrit groups by opening a bug at -https://bugs.launchpad.net/openstack-ci/+filebug (make sure to mention -the Gerrit name or E-mail address of at least one initial member). - Create a new StackForge Project with Puppet =========================================== @@ -165,6 +167,22 @@ add a project to StackForge. You can commit these changes and submit them to review.openstack.org at this point, or you can wait a little longer and add your project to GerritBot first. +Request an Initial Gerrit Core Group Member +=========================================== + +StackForge uses Gerrit for group management. After the change to create +your StackForge project has merged, request an initial member for the +Gerrit group configured in your ACL (probably something like +``your-project-name-core``). Members of this team will have permissions +to approve code changes to your project as defined in your ACL, and to +add other Gerrit users to the group. + +You can request an initial Gerrit group member by opening a bug at +https://bugs.launchpad.net/openstack-ci/+filebug (make sure to mention +the Gerrit full name or E-mail address of your initial member). See +https://wiki.openstack.org/wiki/Project_Group_Management for details on +project group management. + Configure StackForge Project to use GerritBot =============================================