designate/README.md
Kiall Mac Innes 12251d7a99 Update README.md doc build instructions
This updates the sphinx-build command example in README.md
to match the output path of `python setup.py build_sphinx`.

Change-Id: I7940f2a7f9f3ca0436620058684c0eb4b4f3427a
2015-01-13 16:41:28 -08:00

1.5 KiB

Introduction

Designate is an OpenStack inspired DNSaaS.

Docs: http://docs.openstack.org/developer/designate and some below for now. Bugs / Blueprints: http://launchpad.net/designate

IRC: #openstack-dns

Installation: http://docs.openstack.org/developer/designate/getting-started.html

Development

Designate follows the OpenStack Gerrit Workflow

Setup

Setup a working environment:

git clone git@github.com:openstack/designate.git
cd designate
virtualenv .venv
. .venv/bin/activate
pip install -r requirements.txt -r test-requirements.txt
python setup.py develop

Building the documentation

To build the documentation from the restructred text source, do the following:

cd doc
pip install -r requirements.txt
sphinx-build  source/ build/html/

now point your browser at html/index.html (the official documentation is published to docs.openstack.org by the maintainers.

Contributing

Install the git-review package to make life easier

pip install git-review

Branch, work, & submit:

# cut a new branch, tracking master
git checkout --track -b bug/id origin/master
# work work work
git add stuff
git commit
# rebase/squash to a single commit before submitting
git rebase -i
# submit
git-review

Testing

Execute a single test using py27 (test is CentralServiceTest.test_count_domains)

tox -e py27 -- designate/tests/test_central/test_service.py:CentralServiceTest.test_count_domains