5c0f28bd88
This patch is in response to prior discussion in the weekly IRC team meeting. The patch does not actually add any documentation (apart from the bits on testing and dev env setup). It does propose topics in the index.rst for documents that need to added for the existing components. These will be added by the team as follow-up patches. For any patch that adds a new feature or modifies an existing feature it will be required to submit a devref rst document as a part of that patch. This document should be posted in the doc/source/devref/ location. There isn's a specific format for the document, but it is expected that the document adequately explains the design of the feature that is being implemented such that its easy for the rest of the team to review, maintain, and enhance the implementation. Change-Id: Ifc32c330d754f623c403fb0c9a5f5c639cce41db
56 lines
2.1 KiB
ReStructuredText
56 lines
2.1 KiB
ReStructuredText
..
|
|
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.
|
|
|
|
|
|
Convention for heading levels in GBP devref:
|
|
======= Heading 0 (reserved for the title in a document)
|
|
------- Heading 1
|
|
~~~~~~~ Heading 2
|
|
+++++++ Heading 3
|
|
''''''' Heading 4
|
|
(Avoid deeper levels because they do not render well.)
|
|
|
|
|
|
Setting Up a Development Environment
|
|
====================================
|
|
|
|
This page describes how to setup a working Python development
|
|
environment that can be used in developing GBP on Ubuntu, Fedora or
|
|
Mac OS X. These instructions assume you're already familiar with
|
|
Git and Gerrit, which is a code repository mirror and code review toolset
|
|
, however if you aren't please see `this Git tutorial`_ for an introduction
|
|
to using Git and `this guide`_ for a tutorial on using Gerrit and Git for
|
|
code contribution to OpenStack projects.
|
|
|
|
.. _this Git tutorial: http://git-scm.com/book/en/Getting-Started
|
|
.. _this guide: http://docs.openstack.org/infra/manual/developers.html#development-workflow
|
|
|
|
Following these instructions will allow you to run the GBP unit
|
|
tests. If you want to be able to run GBP in a full OpenStack environment,
|
|
you can use the excellent `DevStack`_ project to do so. There is a wiki page
|
|
that describes `setting up GBP using DevStack`_.
|
|
|
|
.. _DevStack: https://git.openstack.org/cgit/openstack-dev/devstack
|
|
.. _setting up GBP using Devstack: https://wiki.openstack.org/wiki/GroupBasedPolicy/InstallDevstack
|
|
|
|
Getting the code
|
|
----------------
|
|
|
|
Grab the code::
|
|
|
|
git clone git://git.openstack.org/openstack/group-based-policy.git
|
|
cd group-based-policy
|
|
|
|
|
|
.. include:: ../../../TESTING.rst
|