openstack
/
contributor-guide
Code Issues Proposed changes

Merge "Adding 'Allows you to...' Subsections"

This commit is contained in:
Zuul 2018-04-12 08:31:57 +00:00 committed by Gerrit Code Review
parent a75350fd57 c6f5593b1f
commit 41301711a7
4 changed files with 47 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/common/accounts.rst
View File

@ -7,9 +7,7 @@ Account Setup
Setup Your OpenStack Foundation Account
=======================================
What is the OpenStack Foundation Account?
-----------------------------------------
Allows you to:
An OpenStack Foundation account allows you to:
* Vote in elections.
* Run for elected positions in the OpenStack project.
@ -41,8 +39,8 @@ Sign Up
#. Submit your application.
Setup Your Bug Tracker Account
==============================
Setup Your Task Tracker Account
===============================
.. note::
The OpenStack community is currently in the process of moving from the bug
@ -50,6 +48,13 @@ Setup Your Bug Tracker Account
on-boarding documentation, give special attention if the project is using
Launchpad or StoryBoard.
A Task Tracker account allows you to:
* Report bugs
* Create stories for new features (Process varies per project)
* Track progress on bugs and new features
StoryBoard
----------

17
doc/source/common/git.rst
View File

@ -6,14 +6,21 @@ Setup and Learn GIT
This section assumes you have completed :doc:`accounts` guide.
Git
GIT
===
What is it?
-----------
What is Git?
------------
Git is a free and open source distributed version control system that the
OpenStack community uses to manage changes to source code.
OpenStack community uses to manage changes to source code and documentation.
Git allows you to:
* Push and test `code, docs, infrastructure changes, and CI configurations <http://git.openstack.org/cgit>`_
* Push `Specifications <http://specs.openstack.org>`_
* Push `Use cases for features <http://specs.openstack.org/openstack/openstack-user-stories/>`_
Installation
------------
@ -84,7 +91,7 @@ and email address. This is how your contributions will be identified::
Use the same email address that was used during the account setup.
Learning Git
============
------------
You can use `Git Immersion <http://gitimmersion.com/lab_02.html>`_ to work
through tutorials for learning git.

14
doc/source/common/irc.rst
View File

@ -4,6 +4,20 @@
Setup IRC
#########
IRC
===
What is IRC?
------------
The OpenStack community uses IRC as its primary chat service.
IRC allows you to:
* Communicate with project teams, technical committee, SIGs,
and other Working Groups.
* Participate in regular meetings with the above groups.
Linux & Windows
===============

18
doc/source/common/setup-gerrit.rst
View File

@ -9,17 +9,18 @@ Setting Up Your Gerrit Account
What is Gerrit?
===============
This is the review system the OpenStack community uses. Here are just some of
the things we use Gerrit for reviewing:
This is the review system the OpenStack community uses.
* `Code <http://git.openstack.org/cgit>`_
Gerrit allows you to review:
* `Code, docs, infrastructure changes, and CI configurations <http://git.openstack.org/cgit>`_
* `Specifications <http://specs.openstack.org>`_
* `Translations <http://git.openstack.org/cgit/openstack/i18n/tree/>`_
* `Use cases for features
<http://specs.openstack.org/openstack/openstack-user-stories/>`_
* `Use cases for features <http://specs.openstack.org/openstack/openstack-user-stories/>`_
Sign Up
=======
#. Visit `OpenStack's Gerrit page <https://review.openstack.org>`_ and click
the **sign in** link.
#. You will be prompted to select a username. You can enter the same one you
@ -38,10 +39,11 @@ Sign Up
Individual Contributor License Agreement
----------------------------------------
========================================
What is it?
^^^^^^^^^^^
-----------
An agreement to clarify intellectual property rights granted with
contributions from a person or entity. `Preview the full agreement
<https://review.openstack.org/static/cla.html>`_.
@ -63,6 +65,7 @@ Individual Contributors
Contributors From a Company or Organization
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you are contributing on behalf of a company or organization.
#. In Gerrit's `settings <https://review.openstack.org/#/settings/agreements>`_
@ -87,6 +90,7 @@ If you are contributing on behalf of a company or organization.
Contributors From the U.S. Government
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#. Someone of authority needs to sign the `U.S. Government Contributor License
Agreement <https://wiki.openstack.org/wiki/GovernmentCLA>`_. Contact the
`OpenStack Foundation <mailto:communitymngr@openstack.org>`_ to initiate