openstack/designate
Code Issues Proposed changes
7472f515a6
designate/doc/source/cli/index.rst

18 lines
486 B
ReStructuredText
Raw Normal View History

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:16:05 -04:00
Command-Line Interface Reference
================================
Add link to openstack client commands in cli doc section Make it a bit easier for users to find what commands are available. Change-Id: I0f194556ee5eb8a6068250d6af4c9cd570c1fdeb
2020-09-02 14:53:33 +10:00
Users can interact with designate using the Openstack client via the
commands provided by the `designate plugin`_
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:16:05 -04:00
Information on the commands available through Designate's Command Line
Interface (CLI) can be found in this section.
Add link to openstack client commands in cli doc section Make it a bit easier for users to find what commands are available. Change-Id: I0f194556ee5eb8a6068250d6af4c9cd570c1fdeb
2020-09-02 14:53:33 +10:00
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:16:05 -04:00
.. toctree::
:maxdepth: 1
designate-manage
Add designate-status command for upgrade checks This checks for duplicate entries in the service_statuses table which will be an error after change I307a8f7dd8b8a83effa447a846db3288efa32dba. Related-Bug: 1768824 Story: 2003657 Task: 26127 Change-Id: Ie0350b034f0eb03749138aadd0951d30073214c0 Co-authored-by: Doug Hellmann <doug@doughellmann.com>
2018-09-19 20:34:26 +00:00
designate-status
Add link to openstack client commands in cli doc section Make it a bit easier for users to find what commands are available. Change-Id: I0f194556ee5eb8a6068250d6af4c9cd570c1fdeb
2020-09-02 14:53:33 +10:00
.. _designate plugin: https://docs.openstack.org/python-openstackclient/latest/cli/plugin-commands/designate.html
Copy Permalink