Browse Source

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
changes/00/484600/2
Hangdong Zhang 5 years ago
parent
commit
ad7efeca19
  1. 4
      CONTRIBUTING.rst
  2. 2
      HACKING.rst
  3. 4
      README.rst
  4. 2
      aodh/i18n.py
  5. 2
      doc/source/contributor/contributing.rst
  6. 7
      doc/source/contributor/install/development.rst
  7. 2
      doc/source/contributor/releasenotes/index.rst
  8. 4
      doc/source/contributor/testing.rst
  9. 2
      doc/source/glossary.rst
  10. 2
      doc/source/install/index.rst
  11. 2
      doc/source/install/next-steps.rst
  12. 4
      rally-jobs/README.rst
  13. 2
      rally-jobs/plugins/plugin_sample.py

4
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.

2
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

4
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

2
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
"""

2
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

7
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
<http://devstack.org/localrc.html>`_ or `devstack configuration
<http://devstack.org/configuration.html>`_.
For further information see the `devstack configuration
<https://docs.openstack.org/devstack/latest/configuration.html>`_.
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/

2
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/

4
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/

2
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/

2
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 <http://docs.openstack.org/#install-guides>`_.
`OpenStack Installation Tutorials and Guides <https://docs.openstack.org/#install-guides>`_.

2
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 <http://docs.openstack.org/#install-guides>`_
`OpenStack Installation Tutorials and Guides <https://docs.openstack.org/#install-guides>`_

4
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

2
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
"""

Loading…
Cancel
Save