From b764c144674c65d79eae76cbf920cb0f54aaff6e Mon Sep 17 00:00:00 2001 From: Michael Johnson Date: Thu, 27 Jan 2022 19:05:08 +0000 Subject: [PATCH] Clarify the client code is not python bindings 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 --- README.rst | 6 +++++- doc/source/index.rst | 4 ++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index adad8cb..1229c91 100644 --- a/README.rst +++ b/README.rst @@ -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 `_ + should be used for python bindings. + Octavia client can be installed from PyPI using pip .. code-block:: bash diff --git a/doc/source/index.rst b/doc/source/index.rst index c4caea7..56943f3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 `_ + should be used for python bindings. + Getting Started ---------------