From 0b52b49b572a2146d02c3d94e348c6595841b1d5 Mon Sep 17 00:00:00 2001 From: Hangdong Zhang Date: Thu, 20 Jul 2017 15:19:18 +0800 Subject: [PATCH] Update URLs in documentation Update URLs according to OpenStack document migration BTW: Do some optimization as well (http -> https) Change-Id: I9239e2012442f3e459a21f50afd380c8f58a6a98 --- CONTRIBUTING.rst | 4 ++-- HACKING.rst | 4 ++-- README.rst | 14 +++++++------- cinderclient/_i18n.py | 2 +- doc/source/functional_tests.rst | 2 +- doc/source/index.rst | 2 +- doc/source/unit_tests.rst | 4 ++-- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 87335db84..80ea3b533 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,13 +1,13 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in this page: - http://docs.openstack.org/infra/manual/developers.html + https://docs.openstack.org/infra/manual/developers.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: - http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://docs.openstack.org/infra/manual/developers.html#development-workflow Pull requests submitted through GitHub will be ignored. diff --git a/HACKING.rst b/HACKING.rst index 03844f1b4..fed361147 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -2,7 +2,7 @@ Cinder Client 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 Cinder Client Specific Commandments @@ -29,7 +29,7 @@ Release Notes - Cinder Client uses Reno for release notes management. See the `Reno Documentation`_ for more details on its usage. -.. _Reno Documentation: http://docs.openstack.org/developer/reno/ +.. _Reno Documentation: https://docs.openstack.org/reno/latest/ - As a quick example, when adding a new shell command for Awesome Storage Feature, one could perform the following steps to include a release note for the new feature: diff --git a/README.rst b/README.rst index c9fe419b0..17f4aac61 100644 --- a/README.rst +++ b/README.rst @@ -26,15 +26,15 @@ See the `OpenStack CLI Reference`_ for information on how to use the ``cinder`` command-line tool. You may also want to look at the `OpenStack API documentation`_. -.. _OpenStack CLI Reference: http://docs.openstack.org/cli-reference/overview.html -.. _OpenStack API documentation: http://developer.openstack.org/api-ref.html +.. _OpenStack CLI Reference: https://docs.openstack.org/python-openstackclient/latest/cli/ +.. _OpenStack API documentation: https://developer.openstack.org/api-guide/quick-start/ The project is hosted on `Launchpad`_, where bugs can be filed. The code is hosted on `OpenStack`_. Patches must be submitted using `Gerrit`_. .. _OpenStack: https://git.openstack.org/cgit/openstack/python-cinderclient .. _Launchpad: https://launchpad.net/python-cinderclient -.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow +.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow This code is a fork of `Jacobian's python-cloudservers`__. If you need API support for the Rackspace API solely or the BSD license, you should use that repository. @@ -52,12 +52,12 @@ __ https://github.com/jacobian-archive/python-cloudservers * `How to Contribute`_ .. _PyPi: https://pypi.python.org/pypi/python-cinderclient -.. _Online Documentation: http://docs.openstack.org/developer/python-cinderclient +.. _Online Documentation: https://docs.openstack.org/python-cinderclient/latest/ .. _Blueprints: https://blueprints.launchpad.net/python-cinderclient .. _Bugs: https://bugs.launchpad.net/python-cinderclient .. _Source: https://git.openstack.org/cgit/openstack/python-cinderclient -.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html -.. _Specs: http://specs.openstack.org/openstack/cinder-specs/ +.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html +.. _Specs: https://specs.openstack.org/openstack/cinder-specs/ .. contents:: Contents: @@ -366,4 +366,4 @@ Quick-start using keystone:: >>> nt.volumes.list() [...] -See release notes and more at ``_. +See release notes and more at ``_. diff --git a/cinderclient/_i18n.py b/cinderclient/_i18n.py index 1653da74c..96c924655 100644 --- a/cinderclient/_i18n.py +++ b/cinderclient/_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/doc/source/functional_tests.rst b/doc/source/functional_tests.rst index 3c90a4098..6af85bae5 100644 --- a/doc/source/functional_tests.rst +++ b/doc/source/functional_tests.rst @@ -38,7 +38,7 @@ Or all tests in the test_readonly_clitest_readonly_cli.py file:: tox -e functional -- -n cinderclient.tests.functional.test_readonly_cli For more information on these options and how to run tests, please see the -`ostestr documentation `_. +`ostestr documentation `_. Gotchas ------- diff --git a/doc/source/index.rst b/doc/source/index.rst index a87f414bc..4aaf66be3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -47,7 +47,7 @@ Release Notes All python-cinderclient release notes can now be found on the `release notes`_ page. -.. _`release notes`: http://docs.openstack.org/releasenotes/python-cinderclient/ +.. _`release notes`: https://docs.openstack.org/releasenotes/python-cinderclient/ The following are kept for historical purposes. diff --git a/doc/source/unit_tests.rst b/doc/source/unit_tests.rst index 38fb4e2f2..988740d22 100644 --- a/doc/source/unit_tests.rst +++ b/doc/source/unit_tests.rst @@ -39,7 +39,7 @@ Or all tests in the test_volumes.py file:: tox -epy27 -- -n cinderclient.tests.unit.v2.test_volumes For more information on these options and how to run tests, please see the -`ostestr documentation `_. +`ostestr documentation `_. Run tests wrapper script ------------------------ @@ -94,7 +94,7 @@ This will show the following help information:: Because ``run_tests.sh`` is a wrapper around testr, it also accepts the same flags as testr. See the documentation for details about these additional flags: -`ostestr documentation `_. +`ostestr documentation `_. .. _nose options documentation: http://readthedocs.org/docs/nose/en/latest/usage.html#options