From 52cdbd271ed9fbaa0f08a4f74f0a1c44552698fa Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 5 Apr 2022 18:02:39 +0100 Subject: [PATCH] docs: Update docs to reflect deprecation status Change-Id: I56b862305b31916cef143494050e5e08b1ac70b1 Signed-off-by: Stephen Finucane --- README.rst | 4 ++-- doc/source/cli/nova.rst | 11 +++++------ doc/source/contributor/contributing.rst | 12 +++++++++--- doc/source/index.rst | 10 +++++----- doc/source/user/shell.rst | 6 ++++++ 5 files changed, 27 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index fe139a7b4..1bc3bdcc2 100644 --- a/README.rst +++ b/README.rst @@ -16,8 +16,8 @@ Python bindings to the OpenStack Compute API :alt: Latest Version This is a client for the OpenStack Compute API. It provides a Python API (the -``novaclient`` module) and a command-line script (``nova``). Each implements -100% of the OpenStack Compute API. +``novaclient`` module) and a deprecated command-line script (``nova``). The +Python API implements 100% of the OpenStack Compute API. * License: Apache License, Version 2.0 * `PyPi`_ - package installation diff --git a/doc/source/cli/nova.rst b/doc/source/cli/nova.rst index 54ec99910..03145381a 100644 --- a/doc/source/cli/nova.rst +++ b/doc/source/cli/nova.rst @@ -11,12 +11,11 @@ For help on a specific :command:`nova` command, enter: $ nova help COMMAND -.. note:: Over time, command line functionality will be phased out - of the ``nova`` CLI and into the ``openstack`` CLI. Using - the ``openstack`` client where possible is preferred but - there is not full parity yet for all of the ``nova`` commands. - For information on using the ``openstack`` CLI, see - :python-openstackclient-doc:`OpenStackClient <>`. +.. deprecated:: 17.8.0 + + The ``nova`` CLI has been deprecated in favour of the unified + ``openstack`` CLI. For information on using the ``openstack`` CLI, see + :python-openstackclient-doc:`OpenStackClient <>`. .. _nova_command_usage: diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 38eac4ec9..10365558c 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -11,6 +11,12 @@ communicate as a community, etc. Below will cover the more project specific information you need to get started with python-novaclient. +.. important:: + + The ``nova`` CLI has been deprecated in favour of the unified ``openstack`` + CLI. Changes to the Python bindings are still welcome, however, no further + changes should be made to the shell. + Communication ~~~~~~~~~~~~~ @@ -19,8 +25,8 @@ Please refer `how-to-get-involved `_. +The easiest way to reach the core team is via IRC, using the ``openstack-nova`` +OFTC IRC channel. New Feature Planning ~~~~~~~~~~~~~~~~~~~~ @@ -48,5 +54,5 @@ Getting Your Patch Merged ~~~~~~~~~~~~~~~~~~~~~~~~~ All changes proposed to the python-novaclient requires two ``Code-Review +2`` -votes from python-novaclient core reviewers before one of the core reviewers +votes from ``python-novaclient`` core reviewers before one of the core reviewers can approve patch by giving ``Workflow +1`` vote.. diff --git a/doc/source/index.rst b/doc/source/index.rst index 5c0887956..60791b8e7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,12 +3,12 @@ =========================================== This is a client for OpenStack Nova API. There's a :doc:`Python API -` (the :mod:`novaclient` module), and a :doc:`command-line -script ` (installed as :program:`nova`). Each implements the -entire OpenStack Nova API. +` (the :mod:`novaclient` module), and a deprecated +:doc:`command-line script ` (installed as :program:`nova`). +Each implements the entire OpenStack Nova API. -You'll need credentials for an OpenStack cloud that implements the Compute API, -such as TryStack, HP, or Rackspace, in order to use the nova client. +You'll need credentials for an OpenStack cloud that implements the Compute API +in order to use the nova client. .. seealso:: diff --git a/doc/source/user/shell.rst b/doc/source/user/shell.rst index 465b0fb4d..de96637a7 100644 --- a/doc/source/user/shell.rst +++ b/doc/source/user/shell.rst @@ -15,6 +15,12 @@ information. You can do this with the `--os-username`, `--os-password`, options, but it's easier to just set them as environment variables by setting some environment variables: +.. deprecated:: 17.8.0 + + The ``nova`` CLI has been deprecated in favour of the unified + ``openstack`` CLI. For information on using the ``openstack`` CLI, see + :python-openstackclient-doc:`OpenStackClient <>`. + .. envvar:: OS_USERNAME Your OpenStack Keystone user name.