From ad7efeca19a12390f827a3e2243ece64ff74eb0c Mon Sep 17 00:00:00 2001 From: Hangdong Zhang Date: Tue, 18 Jul 2017 09:52:06 +0800 Subject: [PATCH] Update and optimize documentation links 1. Update URLs according to document migration 2. Update the dead links 3. Optimize (e.g. http -> https) Change-Id: I171ce5fcd437747fed07884d80db833cf3db2358 --- CONTRIBUTING.rst | 4 ++-- HACKING.rst | 2 +- README.rst | 4 ++-- aodh/i18n.py | 2 +- doc/source/contributor/contributing.rst | 2 +- doc/source/contributor/install/development.rst | 7 +++---- doc/source/contributor/releasenotes/index.rst | 2 +- doc/source/contributor/testing.rst | 4 ++-- doc/source/glossary.rst | 2 +- doc/source/install/index.rst | 2 +- doc/source/install/next-steps.rst | 2 +- rally-jobs/README.rst | 4 ++-- rally-jobs/plugins/plugin_sample.py | 2 +- 13 files changed, 19 insertions(+), 20 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ba4c83f63..055d4fee8 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 documented at: - http://docs.openstack.org/infra/manual/developers.html#development-workflow + https://docs.openstack.org/infra/manual/developers.html#development-workflow 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 cc6634006..310239e14 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -2,7 +2,7 @@ Aodh 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 Aodh Specific Commandments diff --git a/README.rst b/README.rst index 3ec6acc4b..5aa8d9ac6 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ aodh ==== Release notes can be read online at: - https://docs.openstack.org/developer/aodh/releasenotes/index.html + https://docs.openstack.org/aodh/latest/contributor/releasenotes/index.html Documentation for the project can be found at: - https://docs.openstack.org/developer/aodh/ + https://docs.openstack.org/aodh/latest/ The project home is at: https://launchpad.net/aodh diff --git a/aodh/i18n.py b/aodh/i18n.py index 655aa06ca..63584e094 100644 --- a/aodh/i18n.py +++ b/aodh/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/contributor/contributing.rst b/doc/source/contributor/contributing.rst index 5f4c343d4..bf435f36e 100644 --- a/doc/source/contributor/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -26,7 +26,7 @@ contributing to Aodh, please follow the workflow found here_. Project Hosting Details ======================= -:Bug tracker: http://launchpad.net/aodh +:Bug tracker: https://launchpad.net/aodh :Mailing list: http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev (prefix subjects with ``[Aodh]`` for faster responses) :Code Hosting: https://git.openstack.org/cgit/openstack/aodh/ :Code Review: https://review.openstack.org/#/q/status:open+project:openstack/aodh,n,z diff --git a/doc/source/contributor/install/development.rst b/doc/source/contributor/install/development.rst index 63adb752e..d8c170ac8 100644 --- a/doc/source/contributor/install/development.rst +++ b/doc/source/contributor/install/development.rst @@ -32,9 +32,8 @@ Configuring devstack ``local.conf`` replaces the former configuration file called ``localrc``. If you used localrc before, remove it to switch to using the new file. - For further information see the `localrc description page - `_ or `devstack configuration - `_. + For further information see the `devstack configuration + `_. 3. The aodh services are not enabled by default, so they must be enabled in ``local.conf`` before running ``stack.sh``. @@ -47,4 +46,4 @@ Configuring devstack # Enable the aodh alarming services enable_plugin aodh https://git.openstack.org/openstack/aodh master -.. _devstack: http://docs.openstack.org/developer/devstack +.. _devstack: https://docs.openstack.org/devstack/latest/ diff --git a/doc/source/contributor/releasenotes/index.rst b/doc/source/contributor/releasenotes/index.rst index 2e8a77b32..161309c40 100644 --- a/doc/source/contributor/releasenotes/index.rst +++ b/doc/source/contributor/releasenotes/index.rst @@ -26,4 +26,4 @@ Since Mitaka development cycle, we start to host release notes on: `Aodh Release Notes`_ .. _Liberty: https://wiki.openstack.org/wiki/ReleaseNotes/Liberty#OpenStack_Telemetry_.28Ceilometer.29 -.. _Aodh Release Notes: http://docs.openstack.org/releasenotes/aodh/ +.. _Aodh Release Notes: https://docs.openstack.org/releasenotes/aodh/ diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index 0f5673f48..1abb2da7f 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -67,10 +67,10 @@ run through tox_. ``aodh/tests/functional/gabbi/gabbits``. If you are adding to or adjusting the API you should consider adding tests here. -.. _gabbi: https://gabbi.readthedocs.org/ +.. _gabbi: https://gabbi.readthedocs.io/en/latest/ .. seealso:: * tox_ -.. _tox: http://tox.testrun.org/latest/ +.. _tox: https://tox.readthedocs.io/en/latest/ diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index d635531dd..e73e40d10 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -57,4 +57,4 @@ An OpenStack user. .. [#] http://en.wikipedia.org/wiki/Ceilometer -.. _Zaqar Developer Documentation: http://docs.openstack.org/developer/zaqar/ +.. _Zaqar Developer Documentation: https://docs.openstack.org/zaqar/latest/ diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 8f0ca4b23..6283655a0 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -12,4 +12,4 @@ Telemetry Alarming service .. verify.rst This chapter assumes a working setup of OpenStack following the -`OpenStack Installation Tutorials and Guides `_. +`OpenStack Installation Tutorials and Guides `_. diff --git a/doc/source/install/next-steps.rst b/doc/source/install/next-steps.rst index 5f25e6079..3f6553032 100644 --- a/doc/source/install/next-steps.rst +++ b/doc/source/install/next-steps.rst @@ -6,4 +6,4 @@ Next steps Your OpenStack environment now includes the aodh service. To add additional services, see the -`OpenStack Installation Tutorials and Guides `_ +`OpenStack Installation Tutorials and Guides `_ diff --git a/rally-jobs/README.rst b/rally-jobs/README.rst index 9dc7d319d..615fbd67a 100644 --- a/rally-jobs/README.rst +++ b/rally-jobs/README.rst @@ -22,8 +22,8 @@ Useful links * More about Rally: https://rally.readthedocs.org/en/latest/ -* How to add rally-gates: https://rally.readthedocs.org/en/latest/gates.html +* How to add rally-gates: https://rally.readthedocs.io/en/latest/quick_start/gates.html -* About plugins: https://rally.readthedocs.org/en/latest/plugins.html +* About plugins: https://rally.readthedocs.io/en/latest/plugins/index.html * Plugin samples: https://github.com/openstack/rally/tree/master/samples/plugins diff --git a/rally-jobs/plugins/plugin_sample.py b/rally-jobs/plugins/plugin_sample.py index fc41f9d46..753300b69 100644 --- a/rally-jobs/plugins/plugin_sample.py +++ b/rally-jobs/plugins/plugin_sample.py @@ -15,7 +15,7 @@ For more Aodh related benchmarks take a look here: github.com/openstack/rally/blob/master/rally/benchmark/scenarios/aodh/ -About plugins: https://rally.readthedocs.org/en/latest/plugins.html +About plugins: https://rally.readthedocs.io/en/latest/plugins/index.html Rally concepts https://wiki.openstack.org/wiki/Rally/Concepts """