blob: 7e17fde3043f044ffac3ed4aac41160261eeeb10 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
===================
OpenStack Designate
===================
Designate is an OpenStack project, providing DNSaaS.
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:
.. code-block:: shell
git clone https://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 Docs
-------------
To build the documentation from the restructured text source, do the following:
.. code-block:: shell
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
.. code-block:: shell
pip install git-review
Branch, work, & submit:
.. code-block:: shell
# 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)
.. code-block:: shell
tox -e py27 -- designate.tests.test_central.test_service.CentralServiceTest.test_count_zones_policy_check
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/designate
* Source: http://git.openstack.org/cgit/openstack/designate
* Bugs: http://bugs.launchpad.net/designate
.. _OpenStack Gerrit Workflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _docs.openstack.org: http://docs.openstack.org/developer/designate
|
