From 116b62411e8041f863a35319a2222b0959565629 Mon Sep 17 00:00:00 2001 From: Alexandra Settle Date: Wed, 15 Mar 2017 17:21:52 +0000 Subject: [PATCH] [docs] Rearranges index.rst to build nicer with the theme Change-Id: I80908be1effc160e6b823dd343d315455bc1f352 --- .../{howtos => admin-guide}/blacklists.rst | 0 .../{ => admin-guide}/designate-manage.rst | 0 doc/source/admin-guide/index.rst | 23 +++++ .../multiple-pools.rst | 0 .../{ => admin-guide}/notifications.rst | 0 .../{ => admin-guide}/pool-scheduler.rst | 0 doc/source/{ => admin-guide}/pools.rst | 0 .../production-guidelines.rst | 0 doc/source/{howtos => admin-guide}/quotas.rst | 0 doc/source/{howtos => admin-guide}/tlds.rst | 0 .../{ => admin-guide}/troubleshooting.rst | 0 .../{ => developer-docs}/architecture.rst | 0 doc/source/{ => developer-docs}/backends.rst | 0 .../{ => developer-docs}/backends/agent.rst | 0 .../{ => developer-docs}/backends/bind9.rst | 0 .../backends/djbdns_agent.rst | 0 .../backends/gdnsd_agent.rst | 0 .../backends/infoblox.rst | 0 .../backends/knot2_agent.rst | 0 .../backends/msdns_agent.rst | 0 .../{ => developer-docs}/backends/pdns4.rst | 0 .../backends/powerdns.rst | 0 .../backends/sample_yaml_snippets/agent.yaml | 0 .../backends/sample_yaml_snippets/bind.yaml | 0 .../backends/sample_yaml_snippets/pdns4.yaml | 0 .../sample_yaml_snippets/powerdns.yaml | 0 doc/source/{ => developer-docs}/devstack.rst | 8 +- .../{ => developer-docs}/getting-involved.rst | 5 + doc/source/{ => developer-docs}/gmr.rst | 0 doc/source/developer-docs/index.rst | 41 ++++++++ .../{ => developer-docs}/integrations.rst | 0 doc/source/{ => developer-docs}/metrics.rst | 0 doc/source/{ => developer-docs}/related.rst | 0 doc/source/{ => developer-docs}/sourcedoc.rst | 0 .../{ => developer-docs}/support-matrix.ini | 0 .../{ => developer-docs}/support-matrix.rst | 0 .../{ => developer-docs}/ubuntu-dev.rst | 0 doc/source/index.rst | 98 +++---------------- doc/source/upgrades/index.rst | 15 +++ doc/source/{upgrade => upgrades}/kilo.rst | 0 doc/source/{upgrade => upgrades}/mitaka.rst | 0 doc/source/{upgrade => upgrades}/newton.rst | 0 doc/source/{upgrade => upgrades}/ocata.rst | 0 doc/source/user-guide/index.rst | 15 +++ .../manage-ptr-records.rst | 0 doc/source/{ => user-guide}/rest.rst | 0 .../{ => user-guide}/rest/admin/quotas.rst | 0 .../{ => user-guide}/rest/v1/diagnostics.rst | 0 .../{ => user-guide}/rest/v1/domains.rst | 0 .../{ => user-guide}/rest/v1/quotas.rst | 0 .../{ => user-guide}/rest/v1/records.rst | 0 .../{ => user-guide}/rest/v1/reports.rst | 0 .../{ => user-guide}/rest/v1/servers.rst | 0 doc/source/{ => user-guide}/rest/v1/sync.rst | 0 .../secondary-zones.rst | 0 55 files changed, 115 insertions(+), 90 deletions(-) rename doc/source/{howtos => admin-guide}/blacklists.rst (100%) rename doc/source/{ => admin-guide}/designate-manage.rst (100%) create mode 100644 doc/source/admin-guide/index.rst rename doc/source/{howtos => admin-guide}/multiple-pools.rst (100%) rename doc/source/{ => admin-guide}/notifications.rst (100%) rename doc/source/{ => admin-guide}/pool-scheduler.rst (100%) rename doc/source/{ => admin-guide}/pools.rst (100%) rename doc/source/{ => admin-guide}/production-guidelines.rst (100%) rename doc/source/{howtos => admin-guide}/quotas.rst (100%) rename doc/source/{howtos => admin-guide}/tlds.rst (100%) rename doc/source/{ => admin-guide}/troubleshooting.rst (100%) rename doc/source/{ => developer-docs}/architecture.rst (100%) rename doc/source/{ => developer-docs}/backends.rst (100%) rename doc/source/{ => developer-docs}/backends/agent.rst (100%) rename doc/source/{ => developer-docs}/backends/bind9.rst (100%) rename doc/source/{ => developer-docs}/backends/djbdns_agent.rst (100%) rename doc/source/{ => developer-docs}/backends/gdnsd_agent.rst (100%) rename doc/source/{ => developer-docs}/backends/infoblox.rst (100%) rename doc/source/{ => developer-docs}/backends/knot2_agent.rst (100%) rename doc/source/{ => developer-docs}/backends/msdns_agent.rst (100%) rename doc/source/{ => developer-docs}/backends/pdns4.rst (100%) rename doc/source/{ => developer-docs}/backends/powerdns.rst (100%) rename doc/source/{ => developer-docs}/backends/sample_yaml_snippets/agent.yaml (100%) rename doc/source/{ => developer-docs}/backends/sample_yaml_snippets/bind.yaml (100%) rename doc/source/{ => developer-docs}/backends/sample_yaml_snippets/pdns4.yaml (100%) rename doc/source/{ => developer-docs}/backends/sample_yaml_snippets/powerdns.yaml (100%) rename doc/source/{ => developer-docs}/devstack.rst (97%) rename doc/source/{ => developer-docs}/getting-involved.rst (99%) rename doc/source/{ => developer-docs}/gmr.rst (100%) create mode 100644 doc/source/developer-docs/index.rst rename doc/source/{ => developer-docs}/integrations.rst (100%) rename doc/source/{ => developer-docs}/metrics.rst (100%) rename doc/source/{ => developer-docs}/related.rst (100%) rename doc/source/{ => developer-docs}/sourcedoc.rst (100%) rename doc/source/{ => developer-docs}/support-matrix.ini (100%) rename doc/source/{ => developer-docs}/support-matrix.rst (100%) rename doc/source/{ => developer-docs}/ubuntu-dev.rst (100%) create mode 100644 doc/source/upgrades/index.rst rename doc/source/{upgrade => upgrades}/kilo.rst (100%) rename doc/source/{upgrade => upgrades}/mitaka.rst (100%) rename doc/source/{upgrade => upgrades}/newton.rst (100%) rename doc/source/{upgrade => upgrades}/ocata.rst (100%) create mode 100644 doc/source/user-guide/index.rst rename doc/source/{howtos => user-guide}/manage-ptr-records.rst (100%) rename doc/source/{ => user-guide}/rest.rst (100%) rename doc/source/{ => user-guide}/rest/admin/quotas.rst (100%) rename doc/source/{ => user-guide}/rest/v1/diagnostics.rst (100%) rename doc/source/{ => user-guide}/rest/v1/domains.rst (100%) rename doc/source/{ => user-guide}/rest/v1/quotas.rst (100%) rename doc/source/{ => user-guide}/rest/v1/records.rst (100%) rename doc/source/{ => user-guide}/rest/v1/reports.rst (100%) rename doc/source/{ => user-guide}/rest/v1/servers.rst (100%) rename doc/source/{ => user-guide}/rest/v1/sync.rst (100%) rename doc/source/{howtos => user-guide}/secondary-zones.rst (100%) diff --git a/doc/source/howtos/blacklists.rst b/doc/source/admin-guide/blacklists.rst similarity index 100% rename from doc/source/howtos/blacklists.rst rename to doc/source/admin-guide/blacklists.rst diff --git a/doc/source/designate-manage.rst b/doc/source/admin-guide/designate-manage.rst similarity index 100% rename from doc/source/designate-manage.rst rename to doc/source/admin-guide/designate-manage.rst diff --git a/doc/source/admin-guide/index.rst b/doc/source/admin-guide/index.rst new file mode 100644 index 000000000..347c37bfc --- /dev/null +++ b/doc/source/admin-guide/index.rst @@ -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 + \ No newline at end of file diff --git a/doc/source/howtos/multiple-pools.rst b/doc/source/admin-guide/multiple-pools.rst similarity index 100% rename from doc/source/howtos/multiple-pools.rst rename to doc/source/admin-guide/multiple-pools.rst diff --git a/doc/source/notifications.rst b/doc/source/admin-guide/notifications.rst similarity index 100% rename from doc/source/notifications.rst rename to doc/source/admin-guide/notifications.rst diff --git a/doc/source/pool-scheduler.rst b/doc/source/admin-guide/pool-scheduler.rst similarity index 100% rename from doc/source/pool-scheduler.rst rename to doc/source/admin-guide/pool-scheduler.rst diff --git a/doc/source/pools.rst b/doc/source/admin-guide/pools.rst similarity index 100% rename from doc/source/pools.rst rename to doc/source/admin-guide/pools.rst diff --git a/doc/source/production-guidelines.rst b/doc/source/admin-guide/production-guidelines.rst similarity index 100% rename from doc/source/production-guidelines.rst rename to doc/source/admin-guide/production-guidelines.rst diff --git a/doc/source/howtos/quotas.rst b/doc/source/admin-guide/quotas.rst similarity index 100% rename from doc/source/howtos/quotas.rst rename to doc/source/admin-guide/quotas.rst diff --git a/doc/source/howtos/tlds.rst b/doc/source/admin-guide/tlds.rst similarity index 100% rename from doc/source/howtos/tlds.rst rename to doc/source/admin-guide/tlds.rst diff --git a/doc/source/troubleshooting.rst b/doc/source/admin-guide/troubleshooting.rst similarity index 100% rename from doc/source/troubleshooting.rst rename to doc/source/admin-guide/troubleshooting.rst diff --git a/doc/source/architecture.rst b/doc/source/developer-docs/architecture.rst similarity index 100% rename from doc/source/architecture.rst rename to doc/source/developer-docs/architecture.rst diff --git a/doc/source/backends.rst b/doc/source/developer-docs/backends.rst similarity index 100% rename from doc/source/backends.rst rename to doc/source/developer-docs/backends.rst diff --git a/doc/source/backends/agent.rst b/doc/source/developer-docs/backends/agent.rst similarity index 100% rename from doc/source/backends/agent.rst rename to doc/source/developer-docs/backends/agent.rst diff --git a/doc/source/backends/bind9.rst b/doc/source/developer-docs/backends/bind9.rst similarity index 100% rename from doc/source/backends/bind9.rst rename to doc/source/developer-docs/backends/bind9.rst diff --git a/doc/source/backends/djbdns_agent.rst b/doc/source/developer-docs/backends/djbdns_agent.rst similarity index 100% rename from doc/source/backends/djbdns_agent.rst rename to doc/source/developer-docs/backends/djbdns_agent.rst diff --git a/doc/source/backends/gdnsd_agent.rst b/doc/source/developer-docs/backends/gdnsd_agent.rst similarity index 100% rename from doc/source/backends/gdnsd_agent.rst rename to doc/source/developer-docs/backends/gdnsd_agent.rst diff --git a/doc/source/backends/infoblox.rst b/doc/source/developer-docs/backends/infoblox.rst similarity index 100% rename from doc/source/backends/infoblox.rst rename to doc/source/developer-docs/backends/infoblox.rst diff --git a/doc/source/backends/knot2_agent.rst b/doc/source/developer-docs/backends/knot2_agent.rst similarity index 100% rename from doc/source/backends/knot2_agent.rst rename to doc/source/developer-docs/backends/knot2_agent.rst diff --git a/doc/source/backends/msdns_agent.rst b/doc/source/developer-docs/backends/msdns_agent.rst similarity index 100% rename from doc/source/backends/msdns_agent.rst rename to doc/source/developer-docs/backends/msdns_agent.rst diff --git a/doc/source/backends/pdns4.rst b/doc/source/developer-docs/backends/pdns4.rst similarity index 100% rename from doc/source/backends/pdns4.rst rename to doc/source/developer-docs/backends/pdns4.rst diff --git a/doc/source/backends/powerdns.rst b/doc/source/developer-docs/backends/powerdns.rst similarity index 100% rename from doc/source/backends/powerdns.rst rename to doc/source/developer-docs/backends/powerdns.rst diff --git a/doc/source/backends/sample_yaml_snippets/agent.yaml b/doc/source/developer-docs/backends/sample_yaml_snippets/agent.yaml similarity index 100% rename from doc/source/backends/sample_yaml_snippets/agent.yaml rename to doc/source/developer-docs/backends/sample_yaml_snippets/agent.yaml diff --git a/doc/source/backends/sample_yaml_snippets/bind.yaml b/doc/source/developer-docs/backends/sample_yaml_snippets/bind.yaml similarity index 100% rename from doc/source/backends/sample_yaml_snippets/bind.yaml rename to doc/source/developer-docs/backends/sample_yaml_snippets/bind.yaml diff --git a/doc/source/backends/sample_yaml_snippets/pdns4.yaml b/doc/source/developer-docs/backends/sample_yaml_snippets/pdns4.yaml similarity index 100% rename from doc/source/backends/sample_yaml_snippets/pdns4.yaml rename to doc/source/developer-docs/backends/sample_yaml_snippets/pdns4.yaml diff --git a/doc/source/backends/sample_yaml_snippets/powerdns.yaml b/doc/source/developer-docs/backends/sample_yaml_snippets/powerdns.yaml similarity index 100% rename from doc/source/backends/sample_yaml_snippets/powerdns.yaml rename to doc/source/developer-docs/backends/sample_yaml_snippets/powerdns.yaml diff --git a/doc/source/devstack.rst b/doc/source/developer-docs/devstack.rst similarity index 97% rename from doc/source/devstack.rst rename to doc/source/developer-docs/devstack.rst index d137c5eb9..2ed3e2dad 100644 --- a/doc/source/devstack.rst +++ b/doc/source/developer-docs/devstack.rst @@ -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:: diff --git a/doc/source/getting-involved.rst b/doc/source/developer-docs/getting-involved.rst similarity index 99% rename from doc/source/getting-involved.rst rename to doc/source/developer-docs/getting-involved.rst index f40af55c1..41395afc0 100644 --- a/doc/source/getting-involved.rst +++ b/doc/source/developer-docs/getting-involved.rst @@ -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 diff --git a/doc/source/gmr.rst b/doc/source/developer-docs/gmr.rst similarity index 100% rename from doc/source/gmr.rst rename to doc/source/developer-docs/gmr.rst diff --git a/doc/source/developer-docs/index.rst b/doc/source/developer-docs/index.rst new file mode 100644 index 000000000..baf85b782 --- /dev/null +++ b/doc/source/developer-docs/index.rst @@ -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 + architecture + gmr + metrics + sourcedoc + ubuntu-dev + +Other modules +~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + python-designateclient + designate-dashboard + designate-tempest-plugin + designate-specs + designate-msdnsagent + +Other resources +~~~~~~~~~~~~~~~ + +.. toctree:: + :maxdepth: 1 + + related diff --git a/doc/source/integrations.rst b/doc/source/developer-docs/integrations.rst similarity index 100% rename from doc/source/integrations.rst rename to doc/source/developer-docs/integrations.rst diff --git a/doc/source/metrics.rst b/doc/source/developer-docs/metrics.rst similarity index 100% rename from doc/source/metrics.rst rename to doc/source/developer-docs/metrics.rst diff --git a/doc/source/related.rst b/doc/source/developer-docs/related.rst similarity index 100% rename from doc/source/related.rst rename to doc/source/developer-docs/related.rst diff --git a/doc/source/sourcedoc.rst b/doc/source/developer-docs/sourcedoc.rst similarity index 100% rename from doc/source/sourcedoc.rst rename to doc/source/developer-docs/sourcedoc.rst diff --git a/doc/source/support-matrix.ini b/doc/source/developer-docs/support-matrix.ini similarity index 100% rename from doc/source/support-matrix.ini rename to doc/source/developer-docs/support-matrix.ini diff --git a/doc/source/support-matrix.rst b/doc/source/developer-docs/support-matrix.rst similarity index 100% rename from doc/source/support-matrix.rst rename to doc/source/developer-docs/support-matrix.rst diff --git a/doc/source/ubuntu-dev.rst b/doc/source/developer-docs/ubuntu-dev.rst similarity index 100% rename from doc/source/ubuntu-dev.rst rename to doc/source/developer-docs/ubuntu-dev.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 7ecb1ee40..a33dd1d23 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 `_. - Install Guide - API Reference - Openstack CLI - getting-involved - devstack - support-matrix - backends - tempest +For information on the Designate API, see the +`API Reference `_. -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 - designate-dashboard - designate-tempest-plugin - designate-specs - 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 `_. diff --git a/doc/source/upgrades/index.rst b/doc/source/upgrades/index.rst new file mode 100644 index 000000000..a4322e979 --- /dev/null +++ b/doc/source/upgrades/index.rst @@ -0,0 +1,15 @@ +======== +Upgrades +======== + +In this section, you will find documentation relevant for upgrading Designate. + +Contents: + +.. toctree:: + :maxdepth: 2 + + kilo + mitaka + newton + ocata \ No newline at end of file diff --git a/doc/source/upgrade/kilo.rst b/doc/source/upgrades/kilo.rst similarity index 100% rename from doc/source/upgrade/kilo.rst rename to doc/source/upgrades/kilo.rst diff --git a/doc/source/upgrade/mitaka.rst b/doc/source/upgrades/mitaka.rst similarity index 100% rename from doc/source/upgrade/mitaka.rst rename to doc/source/upgrades/mitaka.rst diff --git a/doc/source/upgrade/newton.rst b/doc/source/upgrades/newton.rst similarity index 100% rename from doc/source/upgrade/newton.rst rename to doc/source/upgrades/newton.rst diff --git a/doc/source/upgrade/ocata.rst b/doc/source/upgrades/ocata.rst similarity index 100% rename from doc/source/upgrade/ocata.rst rename to doc/source/upgrades/ocata.rst diff --git a/doc/source/user-guide/index.rst b/doc/source/user-guide/index.rst new file mode 100644 index 000000000..5b9b7e105 --- /dev/null +++ b/doc/source/user-guide/index.rst @@ -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 \ No newline at end of file diff --git a/doc/source/howtos/manage-ptr-records.rst b/doc/source/user-guide/manage-ptr-records.rst similarity index 100% rename from doc/source/howtos/manage-ptr-records.rst rename to doc/source/user-guide/manage-ptr-records.rst diff --git a/doc/source/rest.rst b/doc/source/user-guide/rest.rst similarity index 100% rename from doc/source/rest.rst rename to doc/source/user-guide/rest.rst diff --git a/doc/source/rest/admin/quotas.rst b/doc/source/user-guide/rest/admin/quotas.rst similarity index 100% rename from doc/source/rest/admin/quotas.rst rename to doc/source/user-guide/rest/admin/quotas.rst diff --git a/doc/source/rest/v1/diagnostics.rst b/doc/source/user-guide/rest/v1/diagnostics.rst similarity index 100% rename from doc/source/rest/v1/diagnostics.rst rename to doc/source/user-guide/rest/v1/diagnostics.rst diff --git a/doc/source/rest/v1/domains.rst b/doc/source/user-guide/rest/v1/domains.rst similarity index 100% rename from doc/source/rest/v1/domains.rst rename to doc/source/user-guide/rest/v1/domains.rst diff --git a/doc/source/rest/v1/quotas.rst b/doc/source/user-guide/rest/v1/quotas.rst similarity index 100% rename from doc/source/rest/v1/quotas.rst rename to doc/source/user-guide/rest/v1/quotas.rst diff --git a/doc/source/rest/v1/records.rst b/doc/source/user-guide/rest/v1/records.rst similarity index 100% rename from doc/source/rest/v1/records.rst rename to doc/source/user-guide/rest/v1/records.rst diff --git a/doc/source/rest/v1/reports.rst b/doc/source/user-guide/rest/v1/reports.rst similarity index 100% rename from doc/source/rest/v1/reports.rst rename to doc/source/user-guide/rest/v1/reports.rst diff --git a/doc/source/rest/v1/servers.rst b/doc/source/user-guide/rest/v1/servers.rst similarity index 100% rename from doc/source/rest/v1/servers.rst rename to doc/source/user-guide/rest/v1/servers.rst diff --git a/doc/source/rest/v1/sync.rst b/doc/source/user-guide/rest/v1/sync.rst similarity index 100% rename from doc/source/rest/v1/sync.rst rename to doc/source/user-guide/rest/v1/sync.rst diff --git a/doc/source/howtos/secondary-zones.rst b/doc/source/user-guide/secondary-zones.rst similarity index 100% rename from doc/source/howtos/secondary-zones.rst rename to doc/source/user-guide/secondary-zones.rst