diff --git a/HACKING.rst b/HACKING.rst index b8b3ff96c..7230971af 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -2,7 +2,7 @@ Neutron Style Commandments ================================ - Step 1: Read the OpenStack Style Commandments - http://docs.openstack.org/developer/hacking/ + https://docs.openstack.org/hacking/latest/ - Step 2: Read on diff --git a/README.rst b/README.rst index 0433add84..6cccade14 100644 --- a/README.rst +++ b/README.rst @@ -32,7 +32,7 @@ provides a Python API (the ``neutronclient`` module) and a command-line tool * `Developer's Guide`_ .. _PyPi: https://pypi.python.org/pypi/python-neutronclient -.. _Online Documentation: http://docs.openstack.org/developer/python-neutronclient +.. _Online Documentation: https://docs.openstack.org/python-neutronclient/latest/ .. _Launchpad project: https://launchpad.net/python-neutronclient .. _Blueprints: https://blueprints.launchpad.net/python-neutronclient .. _Bugs: https://bugs.launchpad.net/python-neutronclient diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index f53a83acb..0a7d54d9f 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -26,7 +26,7 @@ Using CLI There are two CLIs which support the Networking API: `OpenStackClient (OSC) -`__ +`__ and :doc:`neutron CLI ` (deprecated). OpenStackClient diff --git a/doc/source/cli/neutron.rst b/doc/source/cli/neutron.rst index bc104ce94..7ca652771 100644 --- a/doc/source/cli/neutron.rst +++ b/doc/source/cli/neutron.rst @@ -76,7 +76,7 @@ Run **neutron help** to get a full list of all possible commands, and run Using with os-client-config ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -`os-client-config `_ +`os-client-config `_ provides more convenient way to manage a collection of client configurations and you can easily switch multiple OpenStack-based configurations. @@ -114,7 +114,7 @@ Then, you need to specify a configuration name defined in the above clouds.yaml. export OS_CLOUD=devstack For more detail information, see the -`os-client-config `_ +`os-client-config `_ documentation. Using with keystone token diff --git a/doc/source/contributor/transition_to_osc.rst b/doc/source/contributor/transition_to_osc.rst index 2f0e52476..098d72734 100644 --- a/doc/source/contributor/transition_to_osc.rst +++ b/doc/source/contributor/transition_to_osc.rst @@ -47,7 +47,7 @@ It will be available along side the networking support provided by the OpenStack Python SDK. Users of the neutron client's command extensions will need to transition to the -`OSC plugin system `_ +`OSC plugin system `_ before the ``neutron`` CLI is removed. Such users will maintain their OSC plugin commands within their own project and will be responsible for deprecating and removing their ``neutron`` CLI extension. @@ -59,7 +59,7 @@ Transition Steps patch set: https://review.openstack.org/#/c/138745/ 2. **Done:** OSC switches its networking support for the - `network `_ + `network `_ command object to use the OpenStack Python SDK instead of the neutron client's Python library. See the following patch set: https://review.openstack.org/#/c/253348/ @@ -73,11 +73,11 @@ Transition Steps See the following blueprint: https://blueprints.launchpad.net/python-openstackclient/+spec/network-command-sdk-support 5. **Done:** OSC switches its networking support for the - `ip floating `_, - `ip floating pool `_, - `ip fixed `_, - `security group `_, and - `security group rule `_ + `ip floating `_, + `ip floating pool `_, + `ip fixed `_, + `security group `_, and + `security group rule `_ command objects to use the OpenStack Python SDK instead of the nova client's Python library when neutron is enabled. When nova network is enabled, then the nova client's Python library will continue to @@ -112,8 +112,8 @@ Transition Steps equivalent to the ``neutron`` CLI and it contains sufficient functional and unit test coverage. - * `Neutron Stadium `_ - projects, Neutron documentation and `DevStack `_ + * `Neutron Stadium `_ + projects, Neutron documentation and `DevStack `_ use ``openstack`` CLI instead of ``neutron`` CLI. * Most users of the neutron client's command extensions have transitioned @@ -235,7 +235,7 @@ Developer References to determine if an ``openstack`` command exists. * See `OSC command spec list `_ to determine if an ``openstack`` command spec exists. -* See `OSC plugin command list `_ +* See `OSC plugin command list `_ to determine if an ``openstack`` plugin command exists. * See `OSC command structure `_ to determine the current ``openstack`` command objects, plugin objects and actions. diff --git a/doc/source/index.rst b/doc/source/index.rst index 9b7a0efc9..64ad45ab4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -29,7 +29,7 @@ This is a client for OpenStack Networking API. It provides There are two CLIs which support the Networking API: :doc:`neutron CLI ` and -`OpenStack Client (OSC) `__. +`OpenStack Client (OSC) `__. OpenStack Client provides the basic network commands and python-neutronclient provides extensions (aka OSC plugins) for advanced networking services. diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst index 8ab601cfd..ee4761053 100644 --- a/doc/source/reference/index.rst +++ b/doc/source/reference/index.rst @@ -29,7 +29,7 @@ Basic Usage First create a client instance using a keystoneauth Session. For more information on this keystoneauth API, see `Using Sessions`_. -.. _Using Sessions: http://docs.openstack.org/developer/keystoneauth/using-sessions.html +.. _Using Sessions: https://docs.openstack.org/keystoneauth/latest/using-sessions.html .. code-block:: python diff --git a/setup.cfg b/setup.cfg index a15e929c0..b61f2934c 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ description-file = README.rst author = OpenStack Networking Project author-email = openstack-dev@lists.openstack.org -home-page = http://docs.openstack.org/developer/python-neutronclient +home-page = https://docs.openstack.org/python-neutronclient/latest/ classifier = Environment :: OpenStack Intended Audience :: Developers