The general guide to contributing to OpenStack.
Go to file
Matthew Oliver ce715d1f31 Add organization-guide stub
This patch adds an initial stub version of the new organization
guide. The purpose of this guide is to be something an employee
charged with contributing to OpenStack can take to their employer.
Describing things they may need to take into consideration to
help make the engagement fruitful and rewarding for everyone
involved.

At the moment I've just named it the organization guide. The
could be a better name. This document is a work in progress.

This came out of discussions the First Contact SIG had at the
Vancouver Forum[1]. Originially this discussion started a few months
before[2]. Fungi's post to the mailinglist sums it up much better
then I can[3].

[1] https://etherpad.openstack.org/p/Reqs-for-Organisations-Contributing-to-OpenStack
[2] https://etherpad.openstack.org/p/Contributing_Organization_Guide
[3] http://lists.openstack.org/pipermail/openstack-sigs/2018-June/000410.html

Change-Id: I9a48879959786f7f3883eec861cd5ca62ec90dcf
2018-11-06 11:57:16 +11:00
doc/source Add organization-guide stub 2018-11-06 11:57:16 +11:00
.gitignore Initial commit of the Contributor Portal 2017-10-16 15:43:49 -07:00
.gitreview Added .gitreview 2017-10-10 20:34:48 +00:00
LICENSE Initial commit of the Contributor Portal 2017-10-16 15:43:49 -07:00
README.rst First attempt of contributing to contrib-guide 2017-12-12 03:22:34 +11:00
bindep.txt Add minimal bindep file 2017-10-24 19:41:41 +02:00
requirements.txt Add test-requirements.txt 2017-11-17 20:31:18 +01:00
setup.cfg Initial commit of the Contributor Portal 2017-10-16 15:43:49 -07:00
setup.py Initial commit of the Contributor Portal 2017-10-16 15:43:49 -07:00
test-requirements.txt Update tox.ini, enable doc8 2018-03-02 20:40:51 +01:00
tox.ini Fix pep8 warnings for build directory 2018-05-11 14:16:08 -05:00

README.rst

The OpenStack Contributor Guide

The Contributor Guide for the OpenStack project.

To build the guide, execute the following command:

$ tox -e docs

After running tox -e docs, the guide will be available for viewing in HTML format in the doc/build/ directory.