docs: Update docs to reflect deprecation status

Change-Id: I56b862305b31916cef143494050e5e08b1ac70b1
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

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
+``novaclient`` module) and a deprecated command-line script (``nova``). The
-100% of the OpenStack Compute API.
+Python API implements 100% of the OpenStack Compute API.
 
 * License: Apache License, Version 2.0
 * `PyPi`_ - package installation

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
+.. deprecated:: 17.8.0
-          of the ``nova`` CLI and into the ``openstack`` CLI. Using
+
-          the ``openstack`` client where possible is preferred but
+    The ``nova`` CLI has been deprecated in favour of the unified
-          there is not full parity yet for all of the ``nova`` commands.
+    ``openstack`` CLI. For information on using the ``openstack`` CLI, see
-          For information on using the ``openstack`` CLI, see
+    :python-openstackclient-doc:`OpenStackClient <>`.
-          :python-openstackclient-doc:`OpenStackClient <>`.
 
 .. _nova_command_usage:
 

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 <https://docs.openstack.org/nova/latest/contri
 Contacting the Core Team
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-The overall structure of the Nova team including python-novaclient is
+The easiest way to reach the core team is via IRC, using the ``openstack-nova``
-documented on `the wiki <https://wiki.openstack.org/wiki/Nova#People>`_.
+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..

doc/source/index.rst

@@ -3,12 +3,12 @@
 ===========================================
 
 This is a client for OpenStack Nova API. There's a :doc:`Python API
-<reference/index>` (the :mod:`novaclient` module), and a :doc:`command-line
+<reference/index>` (the :mod:`novaclient` module), and a deprecated
-script </user/shell>` (installed as :program:`nova`). Each implements the
+:doc:`command-line script </user/shell>` (installed as :program:`nova`).
-entire OpenStack Nova API.
+Each implements the entire OpenStack Nova API.
 
-You'll need credentials for an OpenStack cloud that implements the Compute 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.
+in order to use the nova client.
 
 .. seealso::
 

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.