diff --git a/doc/README.rst b/doc/README.rst index 9c698bcbe0e..a647a6f6413 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 Cinder source code. Developer documentation is built to: -http://docs.openstack.org/developer/cinder/ +https://docs.openstack.org/cinder/latest/ Tools ===== diff --git a/doc/source/contributor/development.environment.rst b/doc/source/contributor/development.environment.rst index c0338dc74ad..224148a33ec 100644 --- a/doc/source/contributor/development.environment.rst +++ b/doc/source/contributor/development.environment.rst @@ -23,7 +23,7 @@ environment that can be used in developing cinder on Ubuntu, Fedora or Mac OS X. These instructions assume you're already familiar with git. Refer to GettingTheCode_ for additional information. -.. _GettingTheCode: http://wiki.openstack.org/GettingTheCode +.. _GettingTheCode: https://wiki.openstack.org/wiki/Getting_The_Code Following these instructions will allow you to run the cinder unit tests. Running cinder is currently only supported on Linux, although you can run the @@ -148,4 +148,4 @@ Once your work is complete you may wish to contribute it to the project. Cinder uses the Gerrit code review system. For information on how to submit your branch to Gerrit, see GerritWorkflow_. -.. _GerritWorkflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow +.. _GerritWorkflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow diff --git a/doc/source/contributor/gerrit.rst b/doc/source/contributor/gerrit.rst index cc150011917..c04cc025b08 100644 --- a/doc/source/contributor/gerrit.rst +++ b/doc/source/contributor/gerrit.rst @@ -2,7 +2,7 @@ Code Reviews with Gerrit ======================== Cinder uses the `Gerrit`_ tool to review proposed code changes. The review site -is http://review.openstack.org. +is https://review.openstack.org Gerrit is a complete replacement for Github pull requests. `All Github pull requests to the Cinder repository will be ignored`. @@ -11,6 +11,6 @@ See `Gerrit Workflow Quick Reference`_ for information about how to get started using Gerrit. See `Development Workflow`_ for more detailed documentation on how to work with Gerrit. -.. _Gerrit: http://code.google.com/p/gerrit -.. _Development Workflow: http://docs.openstack.org/infra/manual/developers.html#development-workflow -.. _Gerrit Workflow Quick Reference: http://docs.openstack.org/infra/manual/developers.html#development-workflow +.. _Gerrit: https://bugs.chromium.org/p/gerrit/ +.. _Development Workflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow +.. _Gerrit Workflow Quick Reference: https://docs.openstack.org/infra/manual/developers.html#development-workflow diff --git a/doc/source/contributor/gmr.rst b/doc/source/contributor/gmr.rst index 381eae0515a..434ed1b0409 100644 --- a/doc/source/contributor/gmr.rst +++ b/doc/source/contributor/gmr.rst @@ -109,4 +109,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/contributor/i18n.rst b/doc/source/contributor/i18n.rst index d23ec0400c1..c4efba62f76 100644 --- a/doc/source/contributor/i18n.rst +++ b/doc/source/contributor/i18n.rst @@ -2,10 +2,10 @@ Internationalization ==================== For internationalization guidelines, see the -`oslo.i18n documentation `_. +`oslo.i18n documentation `_. The information below can be used to get started. -Cinder uses `gettext `_ so that +Cinder uses `gettext `_ so that user-facing strings such as log messages appear in the appropriate language in different locales. diff --git a/doc/source/contributor/launchpad.rst b/doc/source/contributor/launchpad.rst index 3090591617f..c3e40400e79 100644 --- a/doc/source/contributor/launchpad.rst +++ b/doc/source/contributor/launchpad.rst @@ -45,8 +45,8 @@ Cinder no longer uses Launchpad Answers to track Cinder technical support questi Note that `Ask OpenStack`_ (which is not hosted on Launchpad) can be used for technical support requests. -.. _Launchpad: http://launchpad.net -.. _Wiki: http://wiki.openstack.org +.. _Launchpad: https://launchpad.net +.. _Wiki: https://wiki.openstack.org/wiki/Main_Page .. _Cinder Team: https://launchpad.net/~cinder .. _OpenStack Team: https://launchpad.net/~openstack -.. _Ask OpenStack: http://ask.openstack.org +.. _Ask OpenStack: https://ask.openstack.org diff --git a/doc/source/contributor/releasenotes.rst b/doc/source/contributor/releasenotes.rst index b74b2a37316..81e65e00039 100644 --- a/doc/source/contributor/releasenotes.rst +++ b/doc/source/contributor/releasenotes.rst @@ -43,7 +43,7 @@ If the following applies to the patch, a release note is required: * REST API changes -Cinder uses `reno `_ to +Cinder uses `reno `_ to generate release notes. Please read the docs for details. In summary, use .. code-block:: bash diff --git a/doc/source/contributor/rolling.upgrades.rst b/doc/source/contributor/rolling.upgrades.rst index 7d64b8ee2d1..dc432714bcb 100644 --- a/doc/source/contributor/rolling.upgrades.rst +++ b/doc/source/contributor/rolling.upgrades.rst @@ -246,7 +246,7 @@ RPC payload changes (oslo.versionedobjects) ------------------------------------------- `oslo.versionedobjects -`_ is a library that +`_ is a library that helps us to maintain compatibility of the payload sent over RPC. As during the process of upgrades it is possible that a newer version of the service will send an object to an older one, it may happen that newer object is incompatible diff --git a/doc/source/contributor/testing.rst b/doc/source/contributor/testing.rst index 71509bd82ad..f7355f03472 100644 --- a/doc/source/contributor/testing.rst +++ b/doc/source/contributor/testing.rst @@ -81,7 +81,7 @@ execution. To ensure the Cinder tests are picked up when running tempest, run:: tox -e all-plugin More information about tempest can be found in the `Tempest Documentation -`_. +`_. Database Setup ~~~~~~~~~~~~~~~ @@ -106,7 +106,7 @@ You may also use regular expressions to run any matching tests:: tox -epy27 -- -r test_volume 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 9c73fb68b4d..1323ffc26f0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -30,8 +30,8 @@ This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional draft and project documentation on Cinder and other components of OpenStack can be found on the `OpenStack wiki`_. Cloud administrators, refer to `docs.openstack.org`_. -.. _`OpenStack wiki`: http://wiki.openstack.org -.. _`docs.openstack.org`: http://docs.openstack.org +.. _`OpenStack wiki`: https://wiki.openstack.org/wiki/Main_Page +.. _`docs.openstack.org`: https://docs.openstack.org Installing Cinder @@ -86,7 +86,7 @@ found here: API Extensions ============== -Go to http://api.openstack.org for information about Cinder API extensions. +Go to https://developer.openstack.org/api-ref/block-storage/ for information about Cinder API extensions. Configuration Reference =======================