Browse Source

Update the documentation link for doc migration

Change-Id: Ia07630b2626781d89b1957a96706e22a9e28674f
changes/66/485566/2
Hangdong Zhang 4 years ago
committed by Akihiro Motoki
parent
commit
7345d6ae4e
  1. 2
      HACKING.rst
  2. 2
      README.rst
  3. 2
      doc/source/cli/index.rst
  4. 4
      doc/source/cli/neutron.rst
  5. 20
      doc/source/contributor/transition_to_osc.rst
  6. 2
      doc/source/index.rst
  7. 2
      doc/source/reference/index.rst
  8. 2
      setup.cfg

2
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

2
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

2
doc/source/cli/index.rst

@ -26,7 +26,7 @@ Using CLI
There are two CLIs which support the Networking API:
`OpenStackClient (OSC)
<https://docs.openstack.org/developer/python-openstackclient/>`__
<https://docs.openstack.org/python-openstackclient/latest/>`__
and :doc:`neutron CLI <neutron>` (deprecated).
OpenStackClient

4
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 <http://docs.openstack.org/developer/os-client-config/>`_
`os-client-config <https://docs.openstack.org/os-client-config/latest/>`_
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 <http://docs.openstack.org/developer/os-client-config/>`_
`os-client-config <https://docs.openstack.org/os-client-config/latest/>`_
documentation.
Using with keystone token

20
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 <http://docs.openstack.org/developer/python-openstackclient/plugins.html>`_
`OSC plugin system <https://docs.openstack.org/python-openstackclient/latest/contributor/plugins.html>`_
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 <http://docs.openstack.org/developer/python-openstackclient/command-objects/network.html>`_
`network <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/network.html>`_
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 <http://docs.openstack.org/developer/python-openstackclient/command-objects/ip-floating.html>`_,
`ip floating pool <http://docs.openstack.org/developer/python-openstackclient/command-objects/ip-floating-pool.html>`_,
`ip fixed <http://docs.openstack.org/developer/python-openstackclient/command-objects/ip-fixed.html>`_,
`security group <http://docs.openstack.org/developer/python-openstackclient/command-objects/security-group.html>`_, and
`security group rule <http://docs.openstack.org/developer/python-openstackclient/command-objects/security-group-rule.html>`_
`ip floating <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/ip-floating.html>`_,
`ip floating pool <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/ip-floating-pool.html>`_,
`ip fixed <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/ip-fixed.html>`_,
`security group <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/security-group.html>`_, and
`security group rule <https://docs.openstack.org/python-openstackclient/latest/cli/command-objects/security-group-rule.html>`_
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 <http://docs.openstack.org/developer/neutron/stadium/sub_projects.html>`_
projects, Neutron documentation and `DevStack <http://docs.openstack.org/developer/devstack/>`_
* `Neutron Stadium <https://docs.openstack.org/neutron/latest/contributor/stadium/>`_
projects, Neutron documentation and `DevStack <https://docs.openstack.org/devstack/latest/>`_
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 <https://github.com/openstack/python-openstackclient/tree/master/doc/source/specs/command-objects>`_
to determine if an ``openstack`` command spec exists.
* See `OSC plugin command list <http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html>`_
* See `OSC plugin command list <https://docs.openstack.org/python-openstackclient/latest/cli/plugin-commands.html>`_
to determine if an ``openstack`` plugin command exists.
* See `OSC command structure <https://github.com/openstack/python-openstackclient/blob/master/doc/source/commands.rst>`_
to determine the current ``openstack`` command objects, plugin objects and actions.

2
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 <cli/neutron>` and
`OpenStack Client (OSC) <https://docs.openstack.org/developer/python-openstackclient/>`__.
`OpenStack Client (OSC) <https://docs.openstack.org/python-openstackclient/latest/>`__.
OpenStack Client provides the basic network commands and
python-neutronclient provides extensions (aka OSC plugins)
for advanced networking services.

2
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

2
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

Loading…
Cancel
Save