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 <slamet.hendry@gmail.com> Reviewed-by: James E. Blair <corvus@inaugust.com> Approved: Clark Boylan <clark.boylan@gmail.com> Reviewed-by: Clark Boylan <clark.boylan@gmail.com> Tested-by: Jenkins
This commit is contained in:
parent
3d136e613f
commit
52abfa977f
@ -23,22 +23,24 @@ What StackForge is not:
|
|||||||
first step in that process as it exposes the project to the OpenStack
|
first step in that process as it exposes the project to the OpenStack
|
||||||
way of doing things).
|
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
|
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
|
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
|
them to review.openstack.org at this point, or you can wait a little
|
||||||
longer and add your project to GerritBot first.
|
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
|
Configure StackForge Project to use GerritBot
|
||||||
=============================================
|
=============================================
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user