From 082159cc5402b3020459aa23516fe24ec83fe4ce Mon Sep 17 00:00:00 2001 From: chenxing Date: Fri, 14 Jul 2017 07:27:16 +0000 Subject: [PATCH] Update the documentation link for doc migration Change-Id: I0b4e59c9e2ad0375cdb6aae5369a7b43978c3d69 --- HACKING.rst | 4 ++-- api-ref/source/share-networks.inc | 3 +-- api-ref/source/versions.inc | 2 +- doc/README.rst | 2 +- doc/source/devref/adding_release_notes.rst | 2 +- doc/source/devref/development.environment.rst | 2 +- doc/source/devref/documenting_your_work.rst | 2 +- doc/source/devref/driver_requirements.rst | 6 +++--- doc/source/devref/guru_meditation_report.rst | 2 +- doc/source/devref/tempest_tests.rst | 2 +- manila/i18n.py | 2 +- setup.cfg | 2 +- test-requirements.txt | 2 +- 13 files changed, 16 insertions(+), 17 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index 61a459cc93..769150e6bb 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -2,7 +2,7 @@ Manila 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 @@ -42,7 +42,7 @@ must be used because the message is going to appear in an exception that may be presented to the user. For more details about translations, see -http://docs.openstack.org/developer/oslo.i18n/guidelines.html +https://docs.openstack.org/oslo.i18n/latest/user/guidelines.html Creating Unit Tests ------------------- diff --git a/api-ref/source/share-networks.inc b/api-ref/source/share-networks.inc index 919f61673d..ed2ae8cf5a 100644 --- a/api-ref/source/share-networks.inc +++ b/api-ref/source/share-networks.inc @@ -19,8 +19,7 @@ neutron network and subnetwork: For more information about supported plug-ins for share networks, -see `Manila Network Plugins `_. +see `Manila Network Plugins `_. A share network has these attributes: diff --git a/api-ref/source/versions.inc b/api-ref/source/versions.inc index a4850774d6..0d2f51a2ee 100644 --- a/api-ref/source/versions.inc +++ b/api-ref/source/versions.inc @@ -19,7 +19,7 @@ Systems API: ``X-OpenStack-Manila-API-Version`` header Read more about microversion guidelines that the service adheres to `here -`_ +`_ List All Major Versions diff --git a/doc/README.rst b/doc/README.rst index 4096941ec1..57729a15c1 100644 --- a/doc/README.rst +++ b/doc/README.rst @@ -6,7 +6,7 @@ Files under this directory tree are used for generating the documentation for the manila source code. Developer documentation is built to: -http://docs.openstack.org/developer/manila/ +https://docs.openstack.org/manila/latest/ Tools ===== diff --git a/doc/source/devref/adding_release_notes.rst b/doc/source/devref/adding_release_notes.rst index 61791da437..abe2008849 100644 --- a/doc/source/devref/adding_release_notes.rst +++ b/doc/source/devref/adding_release_notes.rst @@ -56,7 +56,7 @@ What does not need a release note? How do I add a release note? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -We use `Reno `_ to create and manage +We use `Reno `_ to create and manage release notes. The new subcommand combines a random suffix with a “slug” value to make the new file with a unique name that is easy to identify again later. To create a release note for your change, use: diff --git a/doc/source/devref/development.environment.rst b/doc/source/devref/development.environment.rst index 91c25ce459..d0371735b0 100644 --- a/doc/source/devref/development.environment.rst +++ b/doc/source/devref/development.environment.rst @@ -33,7 +33,7 @@ complete OpenStack development environments). You can check out `Setting up a development environment with devstack`_ for instructions on how to enable manila on devstack. -.. _Setting up a development environment with devstack: http://docs.openstack.org/developer/manila/devref/development_environment_devstack.html +.. _Setting up a development environment with devstack: https://docs.openstack.org/manila/latest/devref/development-environment-devstack.html Virtual environments -------------------- diff --git a/doc/source/devref/documenting_your_work.rst b/doc/source/devref/documenting_your_work.rst index 191794e570..d464e1fc87 100644 --- a/doc/source/devref/documenting_your_work.rst +++ b/doc/source/devref/documenting_your_work.rst @@ -100,7 +100,7 @@ Manila Developer Reference - Feel free to use it as a sandbox for other documentation that does not live in manila's code-tree. - **Link**: `Manila developer reference - `_ + `_ OpenStack Security Guide diff --git a/doc/source/devref/driver_requirements.rst b/doc/source/devref/driver_requirements.rst index f0b4098ee8..db52432038 100644 --- a/doc/source/devref/driver_requirements.rst +++ b/doc/source/devref/driver_requirements.rst @@ -102,7 +102,7 @@ function correctly in manila, such as: - replication_type: string specifying the type of replication supported by the driver. Can be one of ('readable', 'writable' or 'dr'). -.. note:: for more information please see http://docs.openstack.org/developer/manila/devref/capabilities_and_extra_specs.html +.. note:: for more information please see https://docs.openstack.org/manila/latest/devref/capabilities_and_extra_specs.html Continuous Integration systems ------------------------------ @@ -136,7 +136,7 @@ openstack-manuals, containing instructions on how to properly install and configure. The intended audience for this manual is cloud operators and administrators. Also, driver maintainers must update the manila share features support mapping documentation found at -http://docs.openstack.org/developer/manila/devref/share_back_ends_feature_support_mapping.html +https://docs.openstack.org/manila/latest/devref/share_back_ends_feature_support_mapping.html Manila optional requirements and features since Mitaka @@ -215,4 +215,4 @@ report the ``replication_type`` they support as a capability and implement necessary methods. More details can be found at: -http://docs.openstack.org/developer/manila/devref/share_replication.html +https://docs.openstack.org/manila/latest/devref/share_replication.html diff --git a/doc/source/devref/guru_meditation_report.rst b/doc/source/devref/guru_meditation_report.rst index 26a27c6746..9af227159c 100644 --- a/doc/source/devref/guru_meditation_report.rst +++ b/doc/source/devref/guru_meditation_report.rst @@ -116,4 +116,4 @@ Extending the GMR As mentioned above, additional sections can be added to the GMR for a particular executable. For more information, see the inline documentation about oslo.reports: -`oslo.reports `_ +`oslo.reports `_ diff --git a/doc/source/devref/tempest_tests.rst b/doc/source/devref/tempest_tests.rst index 298cdd4dc4..73551828e9 100644 --- a/doc/source/devref/tempest_tests.rst +++ b/doc/source/devref/tempest_tests.rst @@ -11,7 +11,7 @@ information can be found in its `docs`_. In simple words: if you have installed manila project on the same machine as tempest, then tempest will find it. -.. _docs: http://docs.openstack.org/developer/tempest/plugin.html#using-plugins +.. _docs: https://docs.openstack.org/tempest/latest/plugin.html#using-plugins Configuration of manila-related tests in tempest.conf ----------------------------------------------------- diff --git a/manila/i18n.py b/manila/i18n.py index 8f7cb68205..70b0c9be3f 100644 --- a/manila/i18n.py +++ b/manila/i18n.py @@ -14,7 +14,7 @@ """oslo.i18n integration module. -See http://docs.openstack.org/developer/oslo.i18n/usage.html . +See https://docs.openstack.org/oslo.i18n/latest/user/usage.html . """ diff --git a/setup.cfg b/setup.cfg index f442906758..769bcd8fda 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/manila/ +home-page = https://docs.openstack.org/manila/latest/ classifier = Environment :: OpenStack Intended Audience :: Information Technology diff --git a/test-requirements.txt b/test-requirements.txt index 3f3d739cc1..5dc7f0d71e 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -17,7 +17,7 @@ openstackdocstheme>=1.11.0 # Apache-2.0 # Do not remove 'PyMySQL' and 'psycopg2' dependencies. They are used # by oslo_db lib for running MySQL and PostgreSQL DB migration tests. -# See http://docs.openstack.org/developer/oslo.db/contributing.html#how-to-run-unit-tests +# See https://docs.openstack.org/oslo.db/latest/contributor/index.html#how-to-run-unit-tests PyMySQL>=0.7.6 # MIT License psycopg2>=2.5 # LGPL/ZPL