4bcd1c46a0
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
47 lines
1.7 KiB
ReStructuredText
47 lines
1.7 KiB
ReStructuredText
..
|
|
Copyright 2012 Nicolas Barcet for Canonical
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
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.
|
|
|
|
.. _architecture: http://wiki.openstack.org/EfficientMetering/ArchitectureProposalV1
|
|
|
|
.. _blueprint: http://wiki.openstack.org/EfficientMetering
|
|
|
|
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
|
|
|