Matt Riedemann 7c0ebd310c Add top-level CLI reference page in docs
This creates the top-level cli/ reference in the
docs and moves the designate-manage docs to that
CLI reference. A redirect is added for sending
old links to the new home for the designate-manage.html
page.

We'll build on this to add docs for the new
designate-status upgrade check command.

Change-Id: Ic05bc343131651edc7379976fdc877cfb286e310
2018-10-15 12:18:01 -04:00
2018-06-03 11:32:57 -04:00
2018-07-11 17:44:40 +07:00
2018-06-03 11:32:57 -04:00
2014-07-04 16:40:02 +02:00
2013-06-18 16:13:03 -04:00
2018-07-11 17:44:40 +07:00
2018-08-30 01:25:36 +00:00
2018-06-28 13:36:01 +02:00
2017-03-08 23:22:13 +00:00
2018-07-11 17:44:40 +07:00

Team and repository tags

image

OpenStack Designate

Designate is an OpenStack project, providing DNSaaS.

IRC: #openstack-dns

Installation: https://docs.openstack.org/designate/latest/

Development

Designate follows the OpenStack Gerrit Workflow

Setup

Setup a working environment:

git clone https://git.openstack.org/openstack/designate
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
Description
OpenStack DNS As A Service (Designate)
Readme 56 MiB
Languages
Python 93.7%
Shell 3.4%
PHP 2.6%
HTML 0.2%