openstack/contributor-guide
Code Issues Proposed changes

Merge "Adds 'Allows you to...' sections"

Browse Source
This commit is contained in:
Zuul 2018-05-17 17:20:51 +00:00 committed by Gerrit Code Review
commit 06781ebdcf
9 changed files with 52 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/code-and-documentation/elastic-recheck.rst
View File

@ -4,6 +4,12 @@ Using Elastic Recheck
.. 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
==============================

6
doc/source/code-and-documentation/patch-best-practices.rst
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
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
==============

6
doc/source/code-and-documentation/using-gerrit.rst
View File

@ -6,6 +6,12 @@ Using Gerrit
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
================

10
doc/source/common/communication.rst
View File

@ -2,6 +2,12 @@
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
===
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
lists.
Ask OpenStack
=============
ask.openstack.org
=================
`Ask OpenStack <https://ask.openstack.org/>`__ is a question and answer site
for OpenStack users and developers. It provides answer to almost every

5
doc/source/common/events.rst
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
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
------------------------------------

6
doc/source/common/governance.rst
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
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
==========

7
doc/source/common/i18n.rst
View File

@ -2,15 +2,16 @@
Contribute as a Translator
##########################
Abstract
========
If English is not your native language, you may wish to contribute as
a translator. All services and documents that are visible
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
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
====================

5
doc/source/common/task-tracking.rst
View File

@ -11,6 +11,11 @@ Launchpad blueprints and bugs.
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?
======================================

6
doc/source/common/zuul-status.rst
View File

@ -6,6 +6,12 @@ Checking Status in Zuul
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
============