From 90a8302231db5f10e70c0bdcd008417332252b70 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Thu, 20 Jul 2017 04:13:32 +0000 Subject: [PATCH] Update the documentation link for doc migration Change-Id: I7db258cc50373c5011b8f99b6f8971a08ca336f3 --- HACKING.rst | 2 +- README.rst | 2 +- api-ref/source/v2/intro.inc | 2 +- doc/source/contributor/contributing.rst | 6 +++--- doc/source/contributor/review-guidelines.rst | 8 ++++---- neutron_lib/_i18n.py | 2 +- releasenotes/source/README.rst | 2 +- setup.cfg | 2 +- 8 files changed, 13 insertions(+), 13 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index cbf104189..d51217054 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -2,7 +2,7 @@ neutron-lib 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 Neutron Library Specific Commandments diff --git a/README.rst b/README.rst index dd14b92ba..6ed7ca895 100644 --- a/README.rst +++ b/README.rst @@ -14,7 +14,7 @@ neutron-lib Neutron shared routines and utilities * Free software: Apache license -* Documentation: http://docs.openstack.org/developer/neutron-lib +* Documentation: https://docs.openstack.org/neutron-lib/latest/ * Source: http://git.openstack.org/cgit/openstack/neutron-lib * Bugs: http://bugs.launchpad.net/neutron diff --git a/api-ref/source/v2/intro.inc b/api-ref/source/v2/intro.inc index 0fec7ca2f..e26e699cf 100644 --- a/api-ref/source/v2/intro.inc +++ b/api-ref/source/v2/intro.inc @@ -29,7 +29,7 @@ Authentication and authorization ================================ The Networking API v2.0 uses the `OpenStack Identity service -`_ as the default authentication +`_ as the default authentication service. When Keystone is enabled, users that submit requests to the OpenStack Networking service must provide an authentication token in **X-Auth-Token** request header. You obtain the token by authenticating to the Keystone diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst index ef6b614d5..1401d9104 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -65,7 +65,7 @@ Phase 1: Rehome require adding additional tests if neutron was lacking in coverage. #. Submit and shepherd your patch through its neutron-lib review. Include a - `release note `_ that describes the code's + `release note `_ that describes the code's old neutron location and new neutron-lib location. Also note that in some cases it makes sense to prototype a change in a consumer project to better understand the impacts of the change, which can be done using the ``Depends-On:`` approach described in the @@ -88,7 +88,7 @@ you can skip this step. Develop and shepherd the enhancements to the private rehomed code applicable at this time. Private APIs made public as part of this phase will also need -`release notes `_ indicating the new public +`release notes `_ indicating the new public functionality. Examples: @@ -130,7 +130,7 @@ source. Ideally we can identify the main impacted subprojects by `grepping the OpenStack code `_. - Prepare a neutron core patch to remove and update the rehomed code from its source. - This can be done without a `debtcollector `_ + This can be done without a `debtcollector `_ notice by following the steps here. In the patch's commit message include the ``NeutronLibImpact`` so that we can easily `query `_ for such changes. Mark the patch as a work in progress with a -1 workflow vote. diff --git a/doc/source/contributor/review-guidelines.rst b/doc/source/contributor/review-guidelines.rst index ab3548a24..aeeccb897 100644 --- a/doc/source/contributor/review-guidelines.rst +++ b/doc/source/contributor/review-guidelines.rst @@ -37,7 +37,7 @@ When reviewing neutron-lib changes, please be aware: * Public APIs should be documented using `reST style docstrings `_ that include an overview as well as parameter and return documentation. - The format of docstrings can be found in the `OpenStack developer hacking docs `_. + The format of docstrings can be found in the `OpenStack developer hacking docs `_. Note that public API documentation is a bonus, not a requirement. * Once public classes and methods are pushed to PyPI as part of a neutron-lib @@ -59,7 +59,7 @@ When reviewing neutron-lib changes, please be aware: for a long time, so be careful. * Removing the code from neutron can be done without a temporary `debtcollector - `_ notice by following + `_ notice by following the steps described in the 'Consume' phase of the `contributing doc <./contributing.html>`_. @@ -68,12 +68,12 @@ When reviewing neutron-lib changes, please be aware: - eventlet -* With respect to `Oslo config options `_: +* With respect to `Oslo config options `_: - Config options should only be included in neutron-lib when the respective functionality that uses the options lives in neutron-lib. In this case the options will need to be exposed as entry points for - `config generation `_. + `config generation `_. - Common functionality in neutron-lib that accesses config values should assume the caller has registered them and document such in the docstring for the respective functionality in neutron-lib. diff --git a/neutron_lib/_i18n.py b/neutron_lib/_i18n.py index d01ac3cde..fa8cc2a47 100644 --- a/neutron_lib/_i18n.py +++ b/neutron_lib/_i18n.py @@ -14,7 +14,7 @@ # # INTERNAL INTERFACE: PLEASE NOTE THE LEADING _ ON THIS FILE. THIS IS # NOT A LIBRARY INTERFACE. IF YOU WISH TO USE OSLO_I18N, please refer -# to http://docs.openstack.org/developer/oslo.i18n/usage.html +# to https://docs.openstack.org/oslo.i18n/latest/user/usage.html import oslo_i18n diff --git a/releasenotes/source/README.rst b/releasenotes/source/README.rst index a9de1e8b5..99b646ecc 100644 --- a/releasenotes/source/README.rst +++ b/releasenotes/source/README.rst @@ -7,4 +7,4 @@ Background on the process, tooling, and methodology is documented in a `mailing list post by Doug Hellmann `_. For information on how to create release notes, please consult the -`Release Notes documentation `_. +`Release Notes documentation `_. diff --git a/setup.cfg b/setup.cfg index 5bb1287e0..eaf1f9822 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://docs.openstack.org/developer/neutron-lib/ +home-page = https://docs.openstack.org/neutron-lib/latest/ classifier = Environment :: OpenStack Intended Audience :: Information Technology