From f71b7b27c98838c7a580491ba6f365c4c2e35e2d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Victoria=20Mart=C3=ADnez=20de=20la=20Cruz?= Date: Fri, 29 Aug 2014 18:32:33 -0300 Subject: [PATCH] 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 --- doc/source/gerrit.rst | 16 ++++++++++++ doc/source/index.rst | 10 ++++++++ doc/source/jenkins.rst | 18 ++++++++++++++ doc/source/launchpad.rst | 54 ++++++++++++++++++++++++++++++++++++++++ 4 files changed, 98 insertions(+) create mode 100644 doc/source/gerrit.rst create mode 100644 doc/source/jenkins.rst create mode 100644 doc/source/launchpad.rst diff --git a/doc/source/gerrit.rst b/doc/source/gerrit.rst new file mode 100644 index 000000000..04b3ad2ee --- /dev/null +++ b/doc/source/gerrit.rst @@ -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 \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 5aedf8d5c..a31b6ff28 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -97,6 +97,16 @@ Running and writing tests running_tests test_suite +Other resources +=============== + +.. toctree:: + :maxdepth: 3 + + launchpad + gerrit + jenkins + Modules Reference ================= diff --git a/doc/source/jenkins.rst b/doc/source/jenkins.rst new file mode 100644 index 000000000..cb26dba1b --- /dev/null +++ b/doc/source/jenkins.rst @@ -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 \ No newline at end of file diff --git a/doc/source/launchpad.rst b/doc/source/launchpad.rst new file mode 100644 index 000000000..623391e91 --- /dev/null +++ b/doc/source/launchpad.rst @@ -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/ \ No newline at end of file