opendev/system-config
Code Issues Proposed changes

Some third-party.rst cleanup

Browse Source 
The third-party.rst file has encountered a few changes over the
last months. This patch cleans up some grammar, updates the
lines of expected communication should an account be disabled
and generally tries to bring some uniformity to the file.

No significant changes in meaning are intended, just cosmetic
edits.

Change-Id: I0c59d93721df35e7ea90c870cad230fb2a38010d
This commit is contained in:
Anita Kuno 2014-09-08 15:56:26 -04:00
parent 35470fd757
commit f904e6569f
1 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/source/third_party.rst
View File

@ -20,7 +20,9 @@ on the review in Gerrit.
You can view a list of current 3rd party testing accounts and the relevant You can view a list of current 3rd party testing accounts and the relevant
contact information for each account in the `Gerrit group for 3rd party contact information for each account in the `Gerrit group for 3rd party
testing <https://review.openstack.org/#/admin/groups/270,members>`_ (you must testing <https://review.openstack.org/#/admin/groups/270,members>`_ (you must
be signed in to Gerrit to view this page). be signed in to Gerrit to view this page). All accounts must have a wikipage
entry `on this page <https://wiki.openstack.org/wiki/ThirdPartySystems>`_.
Details are below under Requirements.
Requirements Requirements
------------ ------------
@ -85,7 +87,7 @@ For example:
$ ssh -p 29418 USERNAME@review.openstack.org gerrit stream-events $ ssh -p 29418 USERNAME@review.openstack.org gerrit stream-events
Will give a stream with an output like this (line breaks and Will give a stream with an output like this (line breaks and
indentation added in this document for readability, the read JSON will indentation added in this document for readability, the real JSON will
be all one line per event): be all one line per event):
.. code-block:: javascript .. code-block:: javascript
@ -241,13 +243,13 @@ uploaded and will report the results to Gerrit automatically.
Testing your CI setup Testing your CI setup
--------------------- ---------------------
You can use ``openstack-dev/sandbox`` project to test your external CI You can use the ``openstack-dev/sandbox`` project to test your external CI
infrastructure with OpenStack Gerrit system. By using sandbox project you infrastructure with OpenStack's Gerrit. By using the sandbox project you
can test your CI system without affecting regular OpenStack reviews. can test your CI system without affecting regular OpenStack reviews.
Once you confirm your CI system works as you expected, change your Once you confirm your CI system works as you expect, change your
configuration of gerrit trigger plugin or zuul to subscribe gerrit events configuration of the gerrit trigger plugin or zuul to subscribe to gerrit
from your target project. events from your target project.
Permissions on your Third Party System Permissions on your Third Party System
-------------------------------------- --------------------------------------
@ -265,9 +267,13 @@ accounts at its discretion. This documentation endeavours to outline specific
circumstances that may lead to an account being disabled. There have been circumstances that may lead to an account being disabled. There have been
times when third-party ci systems behave in ways we didn't envision times when third-party ci systems behave in ways we didn't envision
and therefore were unable to document prior to the event. If your and therefore were unable to document prior to the event. If your
third-party ci system has been disabled, check your email - we third-party ci system has been disabled, check the archives of the
probably tried to contact you, and join us in the #openstack-infra irc `third-party-announce
channel on freenode to discuss your situation. <http://lists.openstack.org/cgi-bin/mailman/listinfo/third-party-announce>`_
mailing list to which you hopefully are subscribed. The email that notifies
this list that your account has been disabled will include instructions for
getting your system re-enabled. You are also welcome to join us in the
#openstack-infra irc channel on freenode to discuss your situation.
In order to get your Third Pary CI account to have voting permissions on In order to get your Third Pary CI account to have voting permissions on
repos in gerrit in addition to ``openstack-dev/sandbox`` you have a greater repos in gerrit in addition to ``openstack-dev/sandbox`` you have a greater