openstack/ceilometer
Code Issues Proposed changes
ceilometer/doc/source/initial_setup.rst
Doug Hellmann 4bcd1c46a0 Add Sphinx wrapper around existing docs 
bug 1018443

This patch sets up a basic Sphinx project to allow us to
build the documentation. It also moves the "dev" docs
into the new doc source directory.

Change-Id: Ie2ad0f2e4ed237f1373c4357d5763fd5218d738a
2012-06-27 11:39:37 -04:00

1.7 KiB
Raw Blame History

Initial reading

If you are not yet familiar with ceilometer's architecture, it would be advisable that you start by reading the blueprint and more specifically the architecture which has been agreed on.

In order to contribute to the ceilometer project, you will also need to:

  1. Have signed openstack's contributor's agreement

    http://wiki.openstack.org/CLA

  2. Be familiar with git and the OpenStack gerrit review process

    http://wiki.openstack.org/GerritWorkflow

Setting up the project

  1. The first thing you will need to do is to clone the ceilometer project on your local machine:

    git clone https://github.com/stackforge/ceilometer.git

  2. Once this is done, you need to setup the review process:

    git remote add gerrit ssh://<username>@review.stackforge.org:29418/stackforge/ceilometer.git

  3. Create a topic branch and switch to it

    git checkout -b TOPIC-BRANCH