Ussuri contributor docs community goal
- Updated CONTRIBUTING.rst per goal guidelines - Created doc/source/contributor/contributing.rst per goal guidelines - Remove some now-redundant docs Change-Id: I997c8eab905e37f46e4cb546ea69e284673eea6b
This commit is contained in:
Jeremy Freudberg
parent
0825bddef6
commit
3a3dbc85a3
@ -1,20 +1,19 @@
|
||||
If you would like to contribute to the development of OpenStack,
|
||||
you must follow the steps in this page:
|
||||
The source repository for this project can be found at:
|
||||
|
||||
https://docs.openstack.org/infra/manual/developers.html
|
||||
https://opendev.org/openstack/sahara
|
||||
|
||||
You can find more Sahara-specific info in our How To Participate guide:
|
||||
Pull requests submitted through GitHub are not monitored.
|
||||
|
||||
https://docs.openstack.org/sahara/latest/contributor/how-to-participate.html
|
||||
To start contributing to OpenStack, follow the steps in the contribution guide
|
||||
to set up and use Gerrit:
|
||||
|
||||
Once those steps have been completed, changes to OpenStack
|
||||
should be submitted for review via the Gerrit tool, following
|
||||
the workflow documented at:
|
||||
https://docs.openstack.org/contributors/code-and-documentation/quick-start.html
|
||||
|
||||
https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
Bugs should be filed on Storyboard:
|
||||
|
||||
Pull requests submitted through GitHub will be ignored.
|
||||
https://storyboard.openstack.org/#!/project/openstack/sahara
|
||||
|
||||
Bugs should be filed on Storyboard, not GitHub:
|
||||
For more specific information about contributing to this repository, see the
|
||||
sahara contributor guide:
|
||||
|
||||
https://storyboard.openstack.org/#!/project/935
|
||||
https://docs.openstack.org/sahara/latest/contributor/contributing.html
|
||||
|
||||
@ -5,3 +5,5 @@ redirectmatch 301 ^/sahara/(?!ocata|pike|queens)([^/]+)/user/vanilla-imagebuilde
|
||||
redirectmatch 301 ^/sahara/(?!ocata|pike|queens)([^/]+)/user/cdh-imagebuilder.html$ /sahara/$1/user/cdh-plugin.html
|
||||
redirectmatch 301 ^/sahara/(?!ocata|pike|queens)([^/]+)/user/guest-requirements.html$ /sahara/$1/user/building-guest-images.html
|
||||
redirectmatch 301 ^/sahara/([^/]+)/user/([^-]+)-plugin.html$ /sahara-plugin-$2/$1/
|
||||
redirectmatch 301 ^/sahara/([^/]+)/contributor/how-to-participate.html$ /sahara/$1/contributor/contributing.html
|
||||
redirectmatch 301 ^/sahara/([^/]+)/contributor/project.html$ /sahara/$1/contributor/contributing.html
|
||||
|
||||
70
doc/source/contributor/contributing.rst
Normal file
70
doc/source/contributor/contributing.rst
Normal file
@ -0,0 +1,70 @@
|
||||
============================
|
||||
So You Want to Contribute...
|
||||
============================
|
||||
|
||||
For general information on contributing to OpenStack, please check out the
|
||||
`contributor guide <https://docs.openstack.org/contributors/>`_ to get started.
|
||||
It covers all the basics that are common to all OpenStack projects: the
|
||||
accounts you need, the basics of interacting with our Gerrit review system, how
|
||||
we communicate as a community, etc.
|
||||
|
||||
Below will cover the more project specific information you need to get started
|
||||
with Sahara.
|
||||
|
||||
Communication
|
||||
~~~~~~~~~~~~~
|
||||
* If you have something to discuss use
|
||||
`OpenStack development mail-list <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss>`_.
|
||||
Prefix the mail subject with ``[sahara]``
|
||||
|
||||
* Join ``#openstack-sahara`` IRC channel on `freenode <http://freenode.net/>`_
|
||||
|
||||
* Attend Sahara team meetings
|
||||
|
||||
* Weekly on Thursdays at 1400 UTC
|
||||
|
||||
* IRC channel: ``#openstack-meeting-3``
|
||||
|
||||
Contacting the Core Team
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
* The core team has coverage in the timezones of Europe and the Americas.
|
||||
|
||||
* Just pop over to IRC; we keep a close eye on it!
|
||||
|
||||
* You can also find the email addresses of the core team `here
|
||||
https://review.opendev.org/#/admin/groups/133,members>`.
|
||||
|
||||
New Feature Planning
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
Sahara uses specs to track feature requests. They provide a high-level summary
|
||||
of proposed changes and track associated commits. Sahara also uses specs for
|
||||
in-depth descriptions and discussions of blueprints. Specs follow a defined
|
||||
format and are submitted as change requests to the openstack/sahara-specs
|
||||
repository.
|
||||
|
||||
Task Tracking
|
||||
~~~~~~~~~~~~~
|
||||
We track our tasks in Storyboard.
|
||||
|
||||
The Sahara project group homepage on Storyboard is
|
||||
https://storyboard.openstack.org/#!/project_group/sahara.
|
||||
|
||||
If you're looking for some smaller, easier work item to pick up and get started
|
||||
on, search for the 'low-hanging-fruit' or 'new-contributor' tag.
|
||||
|
||||
Reporting a Bug
|
||||
~~~~~~~~~~~~~~~
|
||||
You found an issue and want to make sure we are aware of it? You can do so on
|
||||
https://storyboard.openstack.org/#!/project_group/sahara.
|
||||
|
||||
Getting Your Patch Merged
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Typically two +2s are required before merging.
|
||||
|
||||
Project Team Lead Duties
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
If you are the PTL of Sahara then you should follow the `PTL guide
|
||||
<https://docs.openstack.org/project-team-guide/ptl.html>`_. You should also
|
||||
keep track of new versions of the various Hadoop distros/components coming out
|
||||
(this can also be delegated to another contributor, but the PTL needs to track
|
||||
it either way).
|
||||
@ -1,69 +0,0 @@
|
||||
How to Participate
|
||||
==================
|
||||
|
||||
Getting started
|
||||
---------------
|
||||
|
||||
* Make sure that your local git is properly configured by executing
|
||||
``git config --list``. If not, configure ``user.name``, ``user.email``
|
||||
|
||||
* Create account on `Launchpad <https://launchpad.net/>`_
|
||||
(if you don't have one)
|
||||
|
||||
* Subscribe to `OpenStack general mail-list <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack>`_
|
||||
|
||||
* Subscribe to `OpenStack development mail-list <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss>`_
|
||||
|
||||
* Create `OpenStack profile <https://www.openstack.org/profile/>`_
|
||||
|
||||
* Login to `OpenStack Gerrit <https://review.opendev.org/>`_ with your
|
||||
Launchpad id
|
||||
|
||||
* Sign `OpenStack Individual Contributor License Agreement <https://review.opendev.org/#/settings/agreements>`_
|
||||
* Make sure that your email is listed in `identities <https://review.opendev.org/#/settings/web-identities>`_
|
||||
|
||||
* Subscribe to code-reviews. Go to your settings on https://review.opendev.org
|
||||
|
||||
* Go to ``watched projects``
|
||||
* Add ``openstack/sahara``, ``openstack/sahara-extra``,
|
||||
``openstack/python-saharaclient``, and ``openstack/sahara-image-elements``
|
||||
|
||||
|
||||
How to stay in touch with the community
|
||||
---------------------------------------
|
||||
|
||||
* If you have something to discuss use
|
||||
`OpenStack development mail-list <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss>`_.
|
||||
Prefix the mail subject with ``[sahara]``
|
||||
|
||||
* Join ``#openstack-sahara`` IRC channel on `freenode <http://freenode.net/>`_
|
||||
|
||||
* Attend Sahara team meetings
|
||||
|
||||
* Weekly on Thursdays at 1400 UTC
|
||||
|
||||
* IRC channel: ``#openstack-meeting-3``
|
||||
|
||||
* See agenda at https://wiki.openstack.org/wiki/Meetings/SaharaAgenda
|
||||
|
||||
|
||||
How to post your first patch for review
|
||||
---------------------------------------
|
||||
|
||||
* Checkout Sahara code from `its repository <https://opendev.org/openstack/sahara>`_
|
||||
|
||||
* Carefully read https://docs.openstack.org/infra/manual/developers.html#development-workflow
|
||||
|
||||
* Pay special attention to https://docs.openstack.org/infra/manual/developers.html#committing-a-change
|
||||
|
||||
* Apply and commit your changes
|
||||
|
||||
* Make sure that your code passes ``PEP8`` checks and unit-tests.
|
||||
See :doc:`development-guidelines`
|
||||
|
||||
* Post your patch for review
|
||||
|
||||
* Monitor the status of your patch review on https://review.opendev.org/#/
|
||||
|
||||
|
||||
|
||||
@ -12,7 +12,6 @@ Programming HowTos and Tutorials
|
||||
development-environment
|
||||
devstack
|
||||
dashboard-dev-environment-guide
|
||||
how-to-participate
|
||||
how-to-build-oozie
|
||||
adding-database-migrations
|
||||
testing
|
||||
@ -26,6 +25,6 @@ Other Resources
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
project
|
||||
contributing
|
||||
gerrit
|
||||
jenkins
|
||||
|
||||
@ -1,49 +0,0 @@
|
||||
Project hosting
|
||||
===============
|
||||
|
||||
`Storyboard`_ hosts the Sahara project. The Sahara project group homepage on
|
||||
Storyboard is https://storyboard.openstack.org/#!/project_group/74.
|
||||
|
||||
Launchpad credentials
|
||||
---------------------
|
||||
|
||||
Creating a login on Launchpad is important even if you don't use the Launchpad
|
||||
site itself, since Launchpad credentials are used for logging in on several
|
||||
OpenStack-related sites. These sites include:
|
||||
|
||||
* `Wiki`_
|
||||
* Gerrit (see :doc:`gerrit`)
|
||||
* Jenkins (see :doc:`jenkins`)
|
||||
|
||||
Mailing list
|
||||
------------
|
||||
|
||||
The mailing list email is ``openstack-discuss@lists.openstack.org``; use the
|
||||
subject prefix ``[sahara]`` to address the team. To participate in the
|
||||
mailing list subscribe to the list at
|
||||
http://lists.openstack.org/cgi-bin/mailman/listinfo
|
||||
|
||||
Bug tracking
|
||||
------------
|
||||
|
||||
Report Sahara bugs/stories at the various project under the Sahara project
|
||||
group https://storyboard.openstack.org/#!/project_group/74
|
||||
|
||||
Feature requests (Specs)
|
||||
-----------------------------
|
||||
|
||||
Sahara uses specs to track feature requests. They provide a high-level summary
|
||||
of proposed changes and track associated commits. Sahara also uses specs for
|
||||
in-depth descriptions and discussions of blueprints. Specs follow a defined
|
||||
format and are submitted as change requests to the openstack/sahara-specs
|
||||
repository.
|
||||
|
||||
Technical support
|
||||
-----------------
|
||||
|
||||
Sahara uses `Ask OpenStack`_ to track Sahara technical support questions.
|
||||
Questions related to Sahara should be tagged with 'sahara'.
|
||||
|
||||
.. _Storyboard: https://storyboard.openstack.org
|
||||
.. _Wiki: http://wiki.openstack.org/sahara
|
||||
.. _Ask OpenStack: https://ask.openstack.org
|
||||
@ -7,3 +7,5 @@
|
||||
/sahara/rocky/user/guest-requirements.html 301 /sahara/rocky/user/building-guest-images.html
|
||||
/sahara/latest/user/vanilla-plugin.html 301 /sahara-plugin-vanilla/latest/
|
||||
/sahara/stein/user/storm-plugin.html 301 /sahara-plugin-storm/stein/
|
||||
/sahara/latest/contributor/how-to-participate.html 301 /sahara/latest/contributor/contributing.html
|
||||
/sahara/latest/contributor/project.html 301 /sahara/latest/contributor/contributing.html
|
||||
|
||||
Loading…
Reference in New Issue
Block a user