Browse Source

Minor changes in docs

- Update the outdated links
- Delete redundant files

Change-Id: I7d43fcd1ebef8ed851b6e67f00f4ed0446c335f2
changes/67/554467/4
Nguyen Hai 3 years ago
parent
commit
63d4b33968
7 changed files with 111 additions and 115 deletions
  1. +2
    -2
      CONTRIBUTING.rst
  2. +3
    -3
      README.rst
  3. +86
    -1
      doc/source/cli/index.rst
  4. +0
    -86
      doc/source/cli/osc/v2/load-balancer.rst
  5. +4
    -0
      doc/source/readme.rst
  6. +0
    -20
      doc/source/reference/decoder.rst
  7. +16
    -3
      doc/source/reference/index.rst

+ 2
- 2
CONTRIBUTING.rst View File

@ -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

+ 3
- 3
README.rst View File

@ -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
===============


+ 86
- 1
doc/source/cli/index.rst View File

@ -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 *

+ 0
- 86
doc/source/cli/osc/v2/load-balancer.rst View File

@ -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 *

+ 4
- 0
doc/source/readme.rst View File

@ -1 +1,5 @@
================
Project Overview
================
.. include:: ../../README.rst

+ 0
- 20
doc/source/reference/decoder.rst View File

@ -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.

+ 16
- 3
doc/source/reference/index.rst View File

@ -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.

Loading…
Cancel
Save