rearrange existing documentation according to the new standard layout
Change-Id: I797d2445b16c8348cdbafbb4f859251c772e1e14 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
3c323d5eab
commit
84040e07ed
@ -19,5 +19,6 @@ Contents:
|
|||||||
designate-manage
|
designate-manage
|
||||||
notifications
|
notifications
|
||||||
production-guidelines
|
production-guidelines
|
||||||
|
upgrades/index
|
||||||
troubleshooting
|
troubleshooting
|
||||||
|
|
@ -1,3 +1,5 @@
|
|||||||
|
.. _notifications:
|
||||||
|
|
||||||
Notifications
|
Notifications
|
||||||
=============
|
=============
|
||||||
|
|
@ -36,7 +36,7 @@ the migration.
|
|||||||
To make the config syntax simpler we have a new YAML based config file that is
|
To make the config syntax simpler we have a new YAML based config file that is
|
||||||
used to load information into the database.
|
used to load information into the database.
|
||||||
|
|
||||||
.. literalinclude:: ../../../etc/designate/pools.yaml.sample
|
.. literalinclude:: ../../../../etc/designate/pools.yaml.sample
|
||||||
:language: yaml
|
:language: yaml
|
||||||
|
|
||||||
We have a command that will allow you to take your current running config, and
|
We have a command that will allow you to take your current running config, and
|
@ -67,7 +67,7 @@ The current implemented tasks in producer include emitting dns.zone.exists event
|
|||||||
|
|
||||||
Designate Sink
|
Designate Sink
|
||||||
-----------------------
|
-----------------------
|
||||||
designate-sink is an optional service which listens for event :doc: ../notifications, such as compute.instance.create.end, handlers are available for Nova and Neutron. Notification events can then be used to trigger record creation & deletion.
|
designate-sink is an optional service which listens for event :ref:`notifications`, such as compute.instance.create.end, handlers are available for Nova and Neutron. Notification events can then be used to trigger record creation & deletion.
|
||||||
|
|
||||||
The current sink implementations generate simple forward lookup A records, using a format specified in handler-nova configuration. Any field in the event notification can be used to generate a record.
|
The current sink implementations generate simple forward lookup A records, using a format specified in handler-nova configuration. Any field in the event notification can be used to generate a record.
|
||||||
|
|
@ -22,4 +22,4 @@ Contents:
|
|||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
:glob:
|
:glob:
|
||||||
|
|
||||||
backends/*
|
*
|
@ -12,13 +12,14 @@ Contents:
|
|||||||
|
|
||||||
getting-involved
|
getting-involved
|
||||||
support-matrix
|
support-matrix
|
||||||
backends
|
backends/index
|
||||||
Designate Tempest Plugin <https://docs.openstack.org/developer/designate-tempest-plugin>
|
Designate Tempest Plugin <https://docs.openstack.org/developer/designate-tempest-plugin>
|
||||||
architecture
|
architecture
|
||||||
gmr
|
gmr
|
||||||
metrics
|
metrics
|
||||||
sourcedoc
|
sourcedoc/index
|
||||||
ubuntu-dev
|
ubuntu-dev
|
||||||
|
integrations
|
||||||
|
|
||||||
Other modules
|
Other modules
|
||||||
~~~~~~~~~~~~~
|
~~~~~~~~~~~~~
|
15
doc/source/contributor/sourcedoc/index.rst
Normal file
15
doc/source/contributor/sourcedoc/index.rst
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
Source Code Documentation
|
||||||
|
-------------------------
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
api
|
||||||
|
backend
|
||||||
|
central
|
||||||
|
mdns
|
||||||
|
objects
|
||||||
|
quota
|
||||||
|
sink
|
||||||
|
storage
|
||||||
|
|
@ -1,15 +0,0 @@
|
|||||||
Source Code Documentation
|
|
||||||
-------------------------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 3
|
|
||||||
|
|
||||||
../sourcedoc/api
|
|
||||||
../sourcedoc/backend
|
|
||||||
../sourcedoc/central
|
|
||||||
../sourcedoc/mdns
|
|
||||||
../sourcedoc/objects
|
|
||||||
../sourcedoc/quota
|
|
||||||
../sourcedoc/sink
|
|
||||||
../sourcedoc/storage
|
|
||||||
|
|
@ -19,10 +19,9 @@ Contents
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
developer-docs/index
|
contributor/index
|
||||||
user-guide/index
|
user/index
|
||||||
admin-guide/index
|
admin/index
|
||||||
upgrades/index
|
|
||||||
|
|
||||||
This documentation is generated by the Sphinx toolkit and lives in the
|
This documentation is generated by the Sphinx toolkit and lives in the
|
||||||
`source tree <https://git.openstack.org/cgit/openstack/designate>`_.
|
`source tree <https://git.openstack.org/cgit/openstack/designate>`_.
|
||||||
|
Loading…
Reference in New Issue
Block a user