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
This commit is contained in:
Matt Riedemann 2018-10-15 12:16:05 -04:00
parent ce5f70a50e
commit 7c0ebd310c
6 changed files with 16 additions and 2 deletions

View File

@ -0,0 +1 @@
redirectmatch 301 ^/designate/([^/]+)/admin/designate-manage.html$ /designate/$1/cli/designate-manage.html

View File

@ -18,7 +18,6 @@ Contents:
multiple-pools
blacklists
quotas
designate-manage
policy
config
notifications

View File

@ -1,4 +1,4 @@
.. _designate-manage:
.. _designate-manage:
====================
Designate Manage CLI

10
doc/source/cli/index.rst Normal file
View File

@ -0,0 +1,10 @@
Command-Line Interface Reference
================================
Information on the commands available through Designate's Command Line
Interface (CLI) can be found in this section.
.. toctree::
:maxdepth: 1
designate-manage

View File

@ -149,6 +149,9 @@ html_theme_options = {}
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any paths that contain "extra" files, such as .htaccess.
html_extra_path = ['_extra']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

View File

@ -18,6 +18,7 @@ Contents
user/index
admin/index
configuration/index
cli/index
For information on the Designate API, see the
`API Reference <https://developer.openstack.org/api-ref/dns/>`_.