Adds more resources section to to developers guide

Information about the bug/features tracker, review system
and continuous integration server Zaqar uses and where to
ask technical questions (IRC, mailing list, ask.openstack.org)

Change-Id: I046bf3185273d97aa2080232e6d5eae077b1d053
This commit is contained in:
Victoria Martínez de la Cruz 2014-08-29 18:32:33 -03:00
parent ab1d471d94
commit f71b7b27c9
4 changed files with 98 additions and 0 deletions

16
doc/source/gerrit.rst Normal file
View File

@ -0,0 +1,16 @@
Code reviews with Gerrit
========================
Zaqar uses the `Gerrit`_ tool to review proposed code changes. The review site
is http://review.openstack.org.
Gerrit is a complete replacement for GitHub pull requests. `All GitHub pull
requests to the Zaqar repository will be ignored`.
See `Gerrit Workflow Quick Reference`_ for information about how to get
started using Gerrit. See `Gerrit, Jenkins and GitHub`_ for more detailed
documentation on how to work with Gerrit.
.. _Gerrit: http://code.google.com/p/gerrit
.. _Gerrit, Jenkins and GitHub: http://wiki.openstack.org/GerritJenkinsGit
.. _Gerrit Workflow Quick Reference: http://wiki.openstack.org/GerritWorkflow

View File

@ -97,6 +97,16 @@ Running and writing tests
running_tests
test_suite
Other resources
===============
.. toctree::
:maxdepth: 3
launchpad
gerrit
jenkins
Modules Reference
=================

18
doc/source/jenkins.rst Normal file
View File

@ -0,0 +1,18 @@
Continuous integration with Jenkins
===================================
Zaqar uses a `Jenkins`_ server to automate development tasks. The Jenkins
front-end is at http://jenkins.openstack.org. You must have an
account on `Launchpad`_ to be able to access the OpenStack Jenkins site.
Jenkins performs tasks such as running static code analysis, running unit
tests, and running functional tests. For more details on the jobs being run by
Jenkins, see the code reviews on http://review.openstack.org. Tests are run
automatically and comments are put on the reviews automatically with the
results.
You can also get a view of the jobs that are currently running from the Zuul
status dashboard, http://status.openstack.org/zuul/.
.. _Jenkins: http://jenkins-ci.org
.. _Launchpad: http://launchpad.net

54
doc/source/launchpad.rst Normal file
View File

@ -0,0 +1,54 @@
Project hosting with Launchpad
==============================
`Launchpad`_ hosts the Zaqar project. The Zaqar project homepage on Launchpad is
http://launchpad.net/zaqar.
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 developers mailing list address is ``openstack-dev@lists.openstack.org``.
This is a common mailing list across all OpenStack projects.
To participate in the mailing list:
#. Subscribe at http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
The mailing list archives are at http://lists.openstack.org/pipermail/openstack-dev.
Bug tracking
------------
Report Zaqar bugs at https://bugs.launchpad.net/zaqar
Feature requests (Blueprints)
-----------------------------
Zaqar uses Launchpad Blueprints to track feature requests. Blueprints are at
https://blueprints.launchpad.net/zaqar.
Technical support (Answers)
---------------------------
Zaqar uses Launchpad Answers to track Zaqar technical support questions. The Zaqar
Answers page is at https://answers.launchpad.net/zaqar.
Note that `Ask OpenStack`_ (which are not hosted on Launchpad) can also
be used for technical support requests.
You can also reach us in #openstack-zaqar at irc.freenode.org.
.. _Launchpad: http://launchpad.net
.. _Wiki: http://wiki.openstack.org
.. _Zaqar Team: https://launchpad.net/~zaqar
.. _Ask OpenStack: http://ask.openstack.org/