Merge "[docs] Rearranges index.rst to build nicer with the theme"
This commit is contained in:
commit
27f7114411
|
@ -0,0 +1,23 @@
|
|||
====================
|
||||
Administration guide
|
||||
====================
|
||||
|
||||
In this section, you will find documentation relevant for administering
|
||||
and operating Designate.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
tlds
|
||||
pools
|
||||
pool-scheduler
|
||||
multiple-pools
|
||||
blacklists
|
||||
quotas
|
||||
designate-manage
|
||||
notifications
|
||||
production-guidelines
|
||||
troubleshooting
|
||||
|
|
@ -15,14 +15,14 @@
|
|||
|
||||
.. _devstack:
|
||||
|
||||
========
|
||||
DevStack
|
||||
========
|
||||
================================
|
||||
How to install DNS with DevStack
|
||||
================================
|
||||
|
||||
The Designate team maintains a fork of devstack with Designate integration.
|
||||
|
||||
Instructions
|
||||
++++++++++++
|
||||
~~~~~~~~~~~~
|
||||
|
||||
.. note::
|
||||
|
|
@ -2,6 +2,11 @@
|
|||
Getting Involved
|
||||
================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
devstack
|
||||
|
||||
#openstack-dns
|
||||
--------------
|
||||
There is an active IRC channel at irc://freenode.net/#openstack-dns, where many of the designate contributors can be found, as
|
|
@ -0,0 +1,41 @@
|
|||
=======================
|
||||
Developer documentation
|
||||
=======================
|
||||
|
||||
In this section, you will find documentation relevant to developing
|
||||
Designate.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
getting-involved
|
||||
support-matrix
|
||||
backends
|
||||
Designate Tempest Plugin <https://docs.openstack.org/developer/designate-tempest-plugin>
|
||||
architecture
|
||||
gmr
|
||||
metrics
|
||||
sourcedoc
|
||||
ubuntu-dev
|
||||
|
||||
Other modules
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
python-designateclient <https://docs.openstack.org/developer/python-designateclient/>
|
||||
designate-dashboard <https://docs.openstack.org/developer/designate-dashboard/>
|
||||
designate-tempest-plugin <https://docs.openstack.org/developer/designate-tempest-plugin/>
|
||||
designate-specs <https://docs.openstack.org/developer/designate-specs/>
|
||||
designate-msdnsagent <https://docs.openstack.org/developer/designate-msdnsagent/>
|
||||
|
||||
Other resources
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
related
|
|
@ -7,96 +7,22 @@ API with integrated Keystone authentication. It can be configured to
|
|||
auto-generate records based on Nova and Neutron actions. Designate supports
|
||||
a variety of DNS servers including Bind9 and PowerDNS.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
For information on how to install Designate, see the
|
||||
`Install Guide <https://docs.openstack.org/project-install-guide/dns/ocata/>`_.
|
||||
|
||||
Install Guide <https://docs.openstack.org/project-install-guide/dns/ocata/>
|
||||
API Reference <https://developer.openstack.org/api-ref/dns/>
|
||||
Openstack CLI <https://docs.openstack.org/developer/python-designateclient/shell-v2.html>
|
||||
getting-involved
|
||||
devstack
|
||||
support-matrix
|
||||
backends
|
||||
tempest <https://docs.openstack.org/developer/designate-tempest-plugin>
|
||||
For information on the Designate API, see the
|
||||
`API Reference <https://developer.openstack.org/api-ref/dns/>`_.
|
||||
|
||||
This documentation is generated by the Sphinx toolkit and lives in the `source tree`_.
|
||||
|
||||
Developer Documentation
|
||||
=======================
|
||||
Contents
|
||||
~~~~~~~~
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
architecture
|
||||
integrations
|
||||
ubuntu-dev
|
||||
gmr
|
||||
sourcedoc
|
||||
metrics
|
||||
developer-docs/index
|
||||
user-guide/index
|
||||
admin-guide/index
|
||||
upgrades/index
|
||||
|
||||
User Guide
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
howtos/manage-ptr-records
|
||||
howtos/secondary-zones
|
||||
rest
|
||||
|
||||
Administration Guide
|
||||
====================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
pools
|
||||
pool-scheduler
|
||||
troubleshooting
|
||||
howtos/multiple-pools
|
||||
howtos/blacklists
|
||||
howtos/tlds
|
||||
howtos/quotas
|
||||
designate-manage
|
||||
notifications
|
||||
production-guidelines
|
||||
|
||||
Upgrades
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
upgrade/kilo
|
||||
upgrade/mitaka
|
||||
upgrade/newton
|
||||
upgrade/ocata
|
||||
|
||||
Other Modules
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
python-designateclient <https://docs.openstack.org/developer/python-designateclient/>
|
||||
designate-dashboard <https://docs.openstack.org/developer/designate-dashboard/>
|
||||
designate-tempest-plugin <https://docs.openstack.org/developer/designate-tempest-plugin/>
|
||||
designate-specs <https://docs.openstack.org/developer/designate-specs/>
|
||||
designate-msdnsagent <https://docs.openstack.org/developer/designate-msdnsagent/>
|
||||
|
||||
Other Resources
|
||||
===============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
related
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
.. _source tree: https://git.openstack.org/cgit/openstack/designate
|
||||
This documentation is generated by the Sphinx toolkit and lives in the
|
||||
`source tree <https://git.openstack.org/cgit/openstack/designate>`_.
|
||||
|
|
|
@ -0,0 +1,15 @@
|
|||
========
|
||||
Upgrades
|
||||
========
|
||||
|
||||
In this section, you will find documentation relevant for upgrading Designate.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
kilo
|
||||
mitaka
|
||||
newton
|
||||
ocata
|
|
@ -0,0 +1,15 @@
|
|||
==========
|
||||
User guide
|
||||
==========
|
||||
|
||||
In this section, you will find documentation relevant for using
|
||||
Designate.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
rest
|
||||
manage-ptr-records
|
||||
secondary-zones
|
Loading…
Reference in New Issue