Update the documentation link for doc migration
Change-Id: I7db258cc50373c5011b8f99b6f8971a08ca336f3
This commit is contained in:
parent
7581af448a
commit
90a8302231
@ -2,7 +2,7 @@ neutron-lib Style Commandments
|
|||||||
==============================
|
==============================
|
||||||
|
|
||||||
- Step 1: Read the OpenStack 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
|
- Step 2: Read on
|
||||||
|
|
||||||
Neutron Library Specific Commandments
|
Neutron Library Specific Commandments
|
||||||
|
@ -14,7 +14,7 @@ neutron-lib
|
|||||||
Neutron shared routines and utilities
|
Neutron shared routines and utilities
|
||||||
|
|
||||||
* Free software: Apache license
|
* 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
|
* Source: http://git.openstack.org/cgit/openstack/neutron-lib
|
||||||
* Bugs: http://bugs.launchpad.net/neutron
|
* Bugs: http://bugs.launchpad.net/neutron
|
||||||
|
|
||||||
|
@ -29,7 +29,7 @@ Authentication and authorization
|
|||||||
================================
|
================================
|
||||||
|
|
||||||
The Networking API v2.0 uses the `OpenStack Identity service
|
The Networking API v2.0 uses the `OpenStack Identity service
|
||||||
<http://docs.openstack.org/developer/keystone/>`_ as the default authentication
|
<https://docs.openstack.org/keystone/latest/>`_ as the default authentication
|
||||||
service. When Keystone is enabled, users that submit requests to the OpenStack
|
service. When Keystone is enabled, users that submit requests to the OpenStack
|
||||||
Networking service must provide an authentication token in **X-Auth-Token**
|
Networking service must provide an authentication token in **X-Auth-Token**
|
||||||
request header. You obtain the token by authenticating to the Keystone
|
request header. You obtain the token by authenticating to the Keystone
|
||||||
|
@ -65,7 +65,7 @@ Phase 1: Rehome
|
|||||||
require adding additional tests if neutron was lacking in coverage.
|
require adding additional tests if neutron was lacking in coverage.
|
||||||
|
|
||||||
#. Submit and shepherd your patch through its neutron-lib review. Include a
|
#. Submit and shepherd your patch through its neutron-lib review. Include a
|
||||||
`release note <http://docs.openstack.org/developer/reno/>`_ that describes the code's
|
`release note <https://docs.openstack.org/reno/latest/>`_ that describes the code's
|
||||||
old neutron location and new neutron-lib location. Also note that in some cases it makes
|
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
|
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
|
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.
|
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
|
Private APIs made public as part of this phase will also need
|
||||||
`release notes <http://docs.openstack.org/developer/reno/>`_ indicating the new public
|
`release notes <https://docs.openstack.org/reno/latest/>`_ indicating the new public
|
||||||
functionality.
|
functionality.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
@ -130,7 +130,7 @@ source.
|
|||||||
Ideally we can identify the main impacted subprojects by
|
Ideally we can identify the main impacted subprojects by
|
||||||
`grepping the OpenStack code <http://codesearch.openstack.org/>`_.
|
`grepping the OpenStack code <http://codesearch.openstack.org/>`_.
|
||||||
- Prepare a neutron core patch to remove and update the rehomed code from its source.
|
- Prepare a neutron core patch to remove and update the rehomed code from its source.
|
||||||
This can be done without a `debtcollector <http://docs.openstack.org/developer/debtcollector>`_
|
This can be done without a `debtcollector <https://docs.openstack.org/debtcollector/latest/>`_
|
||||||
notice by following the steps here. In the patch's commit message include the ``NeutronLibImpact``
|
notice by following the steps here. In the patch's commit message include the ``NeutronLibImpact``
|
||||||
so that we can easily `query <https://review.openstack.org/#/q/status:open+message:%22NeutronLibImpact%22>`_
|
so that we can easily `query <https://review.openstack.org/#/q/status:open+message:%22NeutronLibImpact%22>`_
|
||||||
for such changes. Mark the patch as a work in progress with a -1 workflow vote.
|
for such changes. Mark the patch as a work in progress with a -1 workflow vote.
|
||||||
|
@ -37,7 +37,7 @@ When reviewing neutron-lib changes, please be aware:
|
|||||||
|
|
||||||
* Public APIs should be documented using `reST style docstrings <https://www.python.org/dev/peps/pep-0287/>`_
|
* Public APIs should be documented using `reST style docstrings <https://www.python.org/dev/peps/pep-0287/>`_
|
||||||
that include an overview as well as parameter and return documentation.
|
that include an overview as well as parameter and return documentation.
|
||||||
The format of docstrings can be found in the `OpenStack developer hacking docs <http://docs.openstack.org/developer/hacking/#docstrings>`_.
|
The format of docstrings can be found in the `OpenStack developer hacking docs <https://docs.openstack.org/hacking/latest/user/hacking.html#docstrings>`_.
|
||||||
Note that public API documentation is a bonus, not a requirement.
|
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
|
* 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.
|
for a long time, so be careful.
|
||||||
|
|
||||||
* Removing the code from neutron can be done without a temporary `debtcollector
|
* Removing the code from neutron can be done without a temporary `debtcollector
|
||||||
<http://docs.openstack.org/developer/debtcollector>`_ notice by following
|
<https://docs.openstack.org/debtcollector/latest/>`_ notice by following
|
||||||
the steps described in the 'Consume' phase of the
|
the steps described in the 'Consume' phase of the
|
||||||
`contributing doc <./contributing.html>`_.
|
`contributing doc <./contributing.html>`_.
|
||||||
|
|
||||||
@ -68,12 +68,12 @@ When reviewing neutron-lib changes, please be aware:
|
|||||||
|
|
||||||
- eventlet
|
- eventlet
|
||||||
|
|
||||||
* With respect to `Oslo config options <http://docs.openstack.org/developer/oslo.config/>`_:
|
* With respect to `Oslo config options <https://docs.openstack.org/oslo.config/latest/>`_:
|
||||||
|
|
||||||
- Config options should only be included in neutron-lib when the respective
|
- 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
|
functionality that uses the options lives in neutron-lib. In this case the
|
||||||
options will need to be exposed as entry points for
|
options will need to be exposed as entry points for
|
||||||
`config generation <http://docs.openstack.org/developer/oslo.config/generator.html>`_.
|
`config generation <https://docs.openstack.org/oslo.config/latest/cli/generator.html>`_.
|
||||||
- Common functionality in neutron-lib that accesses config values should
|
- Common functionality in neutron-lib that accesses config values should
|
||||||
assume the caller has registered them and document such in the docstring for
|
assume the caller has registered them and document such in the docstring for
|
||||||
the respective functionality in neutron-lib.
|
the respective functionality in neutron-lib.
|
||||||
|
@ -14,7 +14,7 @@
|
|||||||
#
|
#
|
||||||
# INTERNAL INTERFACE: PLEASE NOTE THE LEADING _ ON THIS FILE. THIS IS
|
# INTERNAL INTERFACE: PLEASE NOTE THE LEADING _ ON THIS FILE. THIS IS
|
||||||
# NOT A LIBRARY INTERFACE. IF YOU WISH TO USE OSLO_I18N, please refer
|
# 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
|
import oslo_i18n
|
||||||
|
|
||||||
|
@ -7,4 +7,4 @@ Background on the process, tooling, and methodology is documented
|
|||||||
in a `mailing list post by Doug Hellmann <http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html>`_.
|
in a `mailing list post by Doug Hellmann <http://lists.openstack.org/pipermail/openstack-dev/2015-November/078301.html>`_.
|
||||||
|
|
||||||
For information on how to create release notes, please consult the
|
For information on how to create release notes, please consult the
|
||||||
`Release Notes documentation <http://docs.openstack.org/developer/reno/>`_.
|
`Release Notes documentation <https://docs.openstack.org/reno/latest/>`_.
|
||||||
|
@ -5,7 +5,7 @@ description-file =
|
|||||||
README.rst
|
README.rst
|
||||||
author = OpenStack
|
author = OpenStack
|
||||||
author-email = openstack-dev@lists.openstack.org
|
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 =
|
classifier =
|
||||||
Environment :: OpenStack
|
Environment :: OpenStack
|
||||||
Intended Audience :: Information Technology
|
Intended Audience :: Information Technology
|
||||||
|
Loading…
Reference in New Issue
Block a user