From 63d4b3396888b2b208c86a6514620e078321e4e7 Mon Sep 17 00:00:00 2001 From: Nguyen Hai Date: Tue, 20 Mar 2018 18:07:27 +0900 Subject: [PATCH] Minor changes in docs - Update the outdated links - Delete redundant files Change-Id: I7d43fcd1ebef8ed851b6e67f00f4ed0446c335f2 --- CONTRIBUTING.rst | 4 +- README.rst | 6 +- doc/source/cli/index.rst | 87 ++++++++++++++++++++++++- doc/source/cli/osc/v2/load-balancer.rst | 86 ------------------------ doc/source/readme.rst | 4 ++ doc/source/reference/decoder.rst | 20 ------ doc/source/reference/index.rst | 19 +++++- 7 files changed, 111 insertions(+), 115 deletions(-) delete mode 100644 doc/source/cli/osc/v2/load-balancer.rst delete mode 100644 doc/source/reference/decoder.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 06bf1dd..86c17d6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -12,6 +12,6 @@ submitted for review via the Gerrit tool: Pull requests submitted through GitHub will be ignored. -Bugs should be filed on Launchpad, not GitHub: +Bugs should be filed on OpenStack Storyboard, not GitHub: - https://bugs.launchpad.net/octavia + https://storyboard.openstack.org/#!/project/911 diff --git a/README.rst b/README.rst index 8036e3f..260d7c5 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ Team and repository tags ======================== -.. image:: https://governance.openstack.org/badges/python-octaviaclient.svg - :target: https://governance.openstack.org/reference/tags/index.html +.. image:: https://governance.openstack.org/tc/badges/python-octaviaclient.svg + :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on @@ -26,7 +26,7 @@ https://docs.openstack.org/python-openstackclient/latest/ * Documentation: https://docs.openstack.org/octavia/latest/ * Source: http://git.openstack.org/cgit/openstack/python-octaviaclient * Release notes: https://docs.openstack.org/releasenotes/python-octaviaclient/ -* Bugs: http://bugs.launchpad.net/octavia +* Bugs: https://storyboard.openstack.org/#!/project/911 Getting Started =============== diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 66db992..d7ba416 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -1 +1,86 @@ -.. include:: osc/v2/load-balancer.rst +Using Octavia CLI extensions to OpenStack Client +================================================ + +List of released CLI commands available in openstack client. These commands +can be referenced by doing ``openstack help loadbalancer``. + +============ +loadbalancer +============ + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer create + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer delete + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer list + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer set + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer show + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer stats show + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer failover + +======== +listener +======== + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer listener * + +==== +pool +==== + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer pool * + +====== +member +====== + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer member * + +============= +healthmonitor +============= + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer healthmonitor * + +======== +l7policy +======== + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer l7policy * + +====== +l7rule +====== + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer l7rule * + +===== +quota +===== + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer quota * + +======= +amphora +======= + +.. autoprogram-cliff:: openstack.load_balancer.v2 + :command: loadbalancer amphora * diff --git a/doc/source/cli/osc/v2/load-balancer.rst b/doc/source/cli/osc/v2/load-balancer.rst deleted file mode 100644 index d7ba416..0000000 --- a/doc/source/cli/osc/v2/load-balancer.rst +++ /dev/null @@ -1,86 +0,0 @@ -Using Octavia CLI extensions to OpenStack Client -================================================ - -List of released CLI commands available in openstack client. These commands -can be referenced by doing ``openstack help loadbalancer``. - -============ -loadbalancer -============ - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer create - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer delete - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer list - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer set - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer show - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer stats show - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer failover - -======== -listener -======== - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer listener * - -==== -pool -==== - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer pool * - -====== -member -====== - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer member * - -============= -healthmonitor -============= - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer healthmonitor * - -======== -l7policy -======== - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer l7policy * - -====== -l7rule -====== - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer l7rule * - -===== -quota -===== - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer quota * - -======= -amphora -======= - -.. autoprogram-cliff:: openstack.load_balancer.v2 - :command: loadbalancer amphora * diff --git a/doc/source/readme.rst b/doc/source/readme.rst index a6210d3..0d67c08 100644 --- a/doc/source/readme.rst +++ b/doc/source/readme.rst @@ -1 +1,5 @@ +================ +Project Overview +================ + .. include:: ../../README.rst diff --git a/doc/source/reference/decoder.rst b/doc/source/reference/decoder.rst deleted file mode 100644 index d03f156..0000000 --- a/doc/source/reference/decoder.rst +++ /dev/null @@ -1,20 +0,0 @@ -Mapping Guide -============= - -The following is a mapping between legacy Neutron CLIs and -the Octavia plugin into OSC. Think of it as a magic decoder ring if you were -using the legacy CLIs and want to transition to OpenStack CLI. -Command options are only shown when necessary. - -LBaaS v2 CLI ------------- - -.. csv-table:: - :header: "Neutron CLI", "OSC Equivalent", "Description" - :widths: 30, 30, 40 - :file: data/lbaas.csv - -.. note:: - As commands get introduced they will populate the table. - If no OSC Equivalent commands are listed, the command has not been - implemented yet. diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 4aec59d..d9e4ead 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -1,7 +1,20 @@ Python Octavia Client Reference =============================== -.. toctree:: - :maxdepth: 2 +The following is a mapping between legacy Neutron CLIs and +the Octavia plugin into OSC. Think of it as a magic decoder ring if you were +using the legacy CLIs and want to transition to OpenStack CLI. +Command options are only shown when necessary. - decoder +Mapping Guide - LBaaS v2 CLI +---------------------------- + +.. csv-table:: + :header: "Neutron CLI", "OSC Equivalent", "Description" + :widths: 30, 30, 40 + :file: data/lbaas.csv + +.. note:: + As commands get introduced they will populate the table. + If no OSC Equivalent commands are listed, the command has not been + implemented yet.