openstack/python-octaviaclient
Code Issues Proposed changes

Clarify the client code is not python bindings

Browse Source 
This patch adds notes clarifying that users should use openstacksdk
for Octavia python bindings and not the client code.
It also corrects the README URL to the docs to point to the client
documentation instead of the main Octavia docs.

Change-Id: I877e08085813b436ff7149604e6a9f6b271fe6f1
This commit is contained in:
Michael Johnson 2022-01-27 19:05:08 +00:00
parent ba61561515
commit b764c14467
2 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@ -21,7 +21,7 @@ For more information about the OpenStack Client see:
https://docs.openstack.org/python-openstackclient/latest/
* Free software: Apache license
* Documentation: https://docs.openstack.org/octavia/latest/
* Documentation: https://docs.openstack.org/python-octaviaclient/latest/
* Source: https://opendev.org/openstack/python-octaviaclient
* Release notes: https://docs.openstack.org/releasenotes/python-octaviaclient/
* Bugs: https://storyboard.openstack.org/#!/project/911
@ -32,6 +32,10 @@ Getting Started
.. note:: This is an OpenStack Client plugin. The ``python-openstackclient``
project should be installed to use this plugin.
.. note:: This project is only intended to be used for the OpenStack Client
CLI. The `openstacksdk <https://opendev.org/openstack/openstacksdk>`_
should be used for python bindings.
Octavia client can be installed from PyPI using pip
.. code-block:: bash

4
doc/source/index.rst
View File

@ -11,6 +11,10 @@ Python Octavia Client
The Python Octavia Client (python-octaviaclient) is a command-line client
for the OpenStack Load Balancing service.
.. note:: This project is only intended to be used for the OpenStack Client
CLI. The `openstacksdk <https://opendev.org/openstack/openstacksdk>`_
should be used for python bindings.
Getting Started
---------------