openstack/designate
Code Issues Proposed changes
OpenStack DNS As A Service (Designate)
2,806 Commits 10 Branches 59 Tags 56 MiB
Python 93.7%
Shell 3.4%
PHP 2.6%
HTML 0.2%
4735d2301f
Go to file
Kiall Mac Innes 4735d2301f Fix all doc warnings and enforce clean docs 
* Fixes all doc warnings and errors
* Updates tox.ini to run sphinx with "fail on warnings"
  enabled.

Change-Id: I188733aa5a9de072c52da7269af22c5c1361ec29
2016-04-14 20:34:44 +01:00
contrib Vagrant: Suppport local devstack / tempest clones 2016-04-12 21:48:02 +01:00
designate Merge "Update bandit.yaml + fix failing test" 2016-04-14 15:35:34 +00:00
devstack Add Tempest Plugin to DevStack Plugin 2016-04-10 12:05:06 +00:00
doc Fix all doc warnings and enforce clean docs 2016-04-14 20:34:44 +01:00
etc/designate Add support for getting Service Status 2016-04-12 16:32:17 +02:00
functionaltests Do not allow GET /resource.json 2016-03-14 18:58:44 +00:00
rally-jobs Grammar mistakes have been corrected 2015-08-22 21:32:18 +05:30
releasenotes Moved doc file and releasenote from service_status 2016-04-14 20:34:44 +01:00
tools Add delayed NOTIFY 2016-02-17 15:24:00 +00:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:26:01 +00:00
.gitignore Add Reno for release notes tracking 2015-11-23 18:00:36 +00:00
.gitreview Update .gitreview for repository move 2014-06-28 16:52:03 +01:00
.testr.conf Add functional tox env 2015-07-14 15:36:08 +01:00
babel.cfg Setup for translation 2014-07-04 16:40:02 +02:00
designate.sublime-project Add __pycache__ to ST2 Ignore 2015-07-09 20:19:53 +01:00
ipa-requirements.txt add support for FreeIPA backend - phase 5 - requirements 2014-05-07 17:16:12 -06:00
LICENSE Add LICENSE file. 2013-06-18 16:13:03 -04:00
openstack-common.conf Switch to oslo.reports 2015-11-05 10:55:29 +01:00
README.rst Update README to RST 2016-02-23 15:16:18 +00:00
requirements.txt Updated from global requirements 2016-04-14 02:32:12 +00:00
setup.cfg Add support for getting Service Status 2016-04-12 16:32:17 +02:00
setup.py Updated from global requirements 2015-09-17 12:11:31 +00:00
test-requirements.txt Updated from global requirements 2016-04-11 18:26:26 +00:00
tests-py3.txt Fix the python34 check job 2016-01-21 17:37:19 +01:00
tox.ini Fix all doc warnings and enforce clean docs 2016-04-14 20:34:44 +01:00

README.rst

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:

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:

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.CentralServiceTest.test_count_zones_policy_check