Adds 'Allows you to...' sections

Adds explainations of what guide users can do as a result
of completing the section.

Story: 2001900

Task: 14385
Task: 14386
Task: 14387
Task: 14389
Task: 14391
Task: 14392
Task: 14393

Change-Id: I1b993b545ef69078ff95a469365e6df4dea43b0f
This commit is contained in:
Kendall Nelson 2018-05-10 15:41:40 -07:00
parent b1820a4fdb
commit 2b25ff548a
9 changed files with 52 additions and 5 deletions

View File

@ -4,6 +4,12 @@ Using Elastic Recheck
.. note:: This section assumes you have completed :doc:`/common/zuul-status` .. note:: This section assumes you have completed :doc:`/common/zuul-status`
Allows you to:
* Enhance the automatic testing the community does on every patch submitted
to gerrit
* Report recurring bugs so that you don't need to manually 'recheck'
What to do if a test job fails What to do if a test job fails
============================== ==============================

View File

@ -9,6 +9,12 @@ forget about the unwritten rules of constructing your changes.
This section will guide you through how to create patches that people will want This section will guide you through how to create patches that people will want
to review. to review.
Allows you to:
* Know how to structure a patch that makes it easier to maintain throughout
the review process
* Know how to structure a patch that is easier for community members to review
The Right Size The Right Size
============== ==============

View File

@ -6,6 +6,12 @@ Using Gerrit
This section assumes you have completed :doc:`../common/setup-gerrit` guide. This section assumes you have completed :doc:`../common/setup-gerrit` guide.
Gerrit allows you:
* Get reviews on your changes proposed to OpenStack repositories
* Request reviews from specific community members
* Make quick changes to your patches in the webui
Pushing A Change Pushing A Change
================ ================

View File

@ -2,6 +2,12 @@
Communication Communication
############# #############
This sections allows you to:
* Ask questions and get prompt responses from the community
* Build up your persona in the community as a contributing member
* Stay up to date on the active discussions in the community
IRC IRC
=== ===
While working with OpenStack, IRC is the best way to get help or support While working with OpenStack, IRC is the best way to get help or support
@ -45,8 +51,8 @@ that are on IRC. All emails on these lists are archived and available on the
The same page describes how to subscribe to a list and describes some popular The same page describes how to subscribe to a list and describes some popular
lists. lists.
Ask OpenStack ask.openstack.org
============= =================
`Ask OpenStack <https://ask.openstack.org/>`__ is a question and answer site `Ask OpenStack <https://ask.openstack.org/>`__ is a question and answer site
for OpenStack users and developers. It provides answer to almost every for OpenStack users and developers. It provides answer to almost every

View File

@ -9,6 +9,11 @@ The OpenStack Foundation organizes multiple events per year to bring together
the community as well as companies and individuals interested in the technology the community as well as companies and individuals interested in the technology
and to embrace and encourage open collaboration. and to embrace and encourage open collaboration.
This section allows you to:
* Understand the differences between the different in-person OpenStack events
* Know which events are valuable to you
OpenStack/Open Infrastructure Summit OpenStack/Open Infrastructure Summit
------------------------------------ ------------------------------------

View File

@ -7,6 +7,12 @@ The OpenStack community has a few different groups and roles for `governance
Each operates in a different sector of the community but being aware of each of Each operates in a different sector of the community but being aware of each of
them is useful. them is useful.
This section allows you to:
* Understand the governance model of OpenStack
* Know how to participate in groups that interest you and influence the future
of OpenStack
Committees Committees
========== ==========

View File

@ -2,15 +2,16 @@
Contribute as a Translator Contribute as a Translator
########################## ##########################
Abstract
========
If English is not your native language, you may wish to contribute as If English is not your native language, you may wish to contribute as
a translator. All services and documents that are visible a translator. All services and documents that are visible
to the user are translated by the I18n team. It does not matter which to the user are translated by the I18n team. It does not matter which
language you speak. We already have a lot of language teams who are very language you speak. We already have a lot of language teams who are very
active. Our claim is more diversity, to support us in our work at I18n. active. Our claim is more diversity, to support us in our work at I18n.
This section allows you to:
* Help translate OpenStack, making it more available for users worldwide
Translation Platform Translation Platform
==================== ====================

View File

@ -11,6 +11,11 @@ Launchpad blueprints and bugs.
This section assumes you have completed :doc:`accounts` guide. This section assumes you have completed :doc:`accounts` guide.
This section allows you to:
* Understand the different tools OpenStack uses for task management
* Know how to report bugs and propose features
What Task Trackers does OpenStack use? What Task Trackers does OpenStack use?
====================================== ======================================

View File

@ -6,6 +6,12 @@ Checking Status in Zuul
This section assumes you have completed :doc:`/code-and-documentation/using-gerrit`. This section assumes you have completed :doc:`/code-and-documentation/using-gerrit`.
This section allows you to:
* Monitor your patches as they get tested by Zuul
* Understand the underlying infrastructure and gating processes that
OpenStack uses
What is Zuul What is Zuul
============ ============