From e9020a87a399c69796b94278acafd08a066550b4 Mon Sep 17 00:00:00 2001 From: Hangdong Zhang Date: Tue, 18 Jul 2017 14:37:03 +0800 Subject: 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: Ib66107d24a5171676a73cde7ead487bef259a5d5 --- CONTRIBUTING.rst | 6 +++--- HACKING.rst | 2 +- README.rst | 14 +++++++------- doc/source/api.rst | 2 +- doc/source/how_to_participate.rst | 8 ++++---- doc/source/index.rst | 6 +++--- doc/source/shell.rst | 4 ++-- saharaclient/_i18n.py | 2 +- 8 files changed, 22 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index a04c76b..ef64b61 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -2,17 +2,17 @@ If you would like to contribute to the development of OpenStack, you must follow the steps in the "If you're a developer" section of this page: - http://wiki.openstack.org/HowToContribute + https://wiki.openstack.org/wiki/How_To_Contribute You can find more Sahara-specific info in our How To Participate guide: - http://docs.openstack.org/developer/python-saharaclient/devref/how_to_participate.html + https://docs.openstack.org/python-saharaclient/latest/how_to_participate.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://wiki.openstack.org/GerritWorkflow + 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 6568acd..ee9c69e 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -2,7 +2,7 @@ Sahara 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 Sahara Specific Commandments diff --git a/README.rst b/README.rst index 2c373d4..b981264 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ Team and repository tags ======================== -.. image:: http://governance.openstack.org/badges/python-saharaclient.svg - :target: http://governance.openstack.org/reference/tags/index.html +.. image:: https://governance.openstack.org/tc/badges/python-saharaclient.svg + :target: https://governance.openstack.org/tc/reference/tags/index.html .. Change things from this point on @@ -25,9 +25,9 @@ Python bindings and CLI in `Docs`_. Development takes place via the usual OpenStack processes as outlined in the `developer guide -`_. +`_. -.. _Docs: http://docs.openstack.org/developer/python-saharaclient/ +.. _Docs: https://docs.openstack.org/python-saharaclient/latest/ * License: Apache License, Version 2.0 * `PyPi`_ - package installation @@ -40,11 +40,11 @@ in the `developer guide * `How to Contribute`_ .. _PyPi: https://pypi.python.org/pypi/python-saharaclient -.. _Online Documentation: http://docs.openstack.org/developer/python-saharaclient +.. _Online Documentation: https://docs.openstack.org/python-saharaclient/latest/ .. _Launchpad project: https://launchpad.net/python-saharaclient .. _Blueprints: https://blueprints.launchpad.net/python-saharaclient .. _Bugs: https://bugs.launchpad.net/python-saharaclient .. _Source: https://git.openstack.org/cgit/openstack/python-saharaclient -.. _How to Contribute: http://docs.openstack.org/infra/manual/developers.html -.. _Specs: http://specs.openstack.org/openstack/sahara-specs/ +.. _How to Contribute: https://docs.openstack.org/infra/manual/developers.html +.. _Specs: https://specs.openstack.org/openstack/sahara-specs/ diff --git a/doc/source/api.rst b/doc/source/api.rst index f49e663..0705df2 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -49,7 +49,7 @@ Session object should be used for this purpose. For example: For more information about Keystone Sessions, see `Using Sessions`_. -.. _Using Sessions: http://docs.openstack.org/developer/python-keystoneclient/using-sessions.html +.. _Using Sessions: https://docs.openstack.org/python-keystoneclient/latest/using-sessions.html Sahara endpoint discovery ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/how_to_participate.rst b/doc/source/how_to_participate.rst index 14c1ee0..0ee69f6 100644 --- a/doc/source/how_to_participate.rst +++ b/doc/source/how_to_participate.rst @@ -25,7 +25,7 @@ Getting started * Sign `OpenStack Individual Contributor License Agreement `_ * Make sure that your email is listed in `identities `_ -* Subscribe to code-reviews. Go to your settings on http://review.openstack.org +* Subscribe to code-reviews. Go to your settings on https://review.openstack.org * Go to ``watched projects`` * Add ``openstack/sahara``, ``openstack/sahara-dashboard``, @@ -40,7 +40,7 @@ How to stay in touch with the community? `OpenStack development mail-list `_. Prefix mail subject with ``[Sahara]`` -* Join ``#openstack-sahara`` IRC channel on `freenode `_ +* Join ``#openstack-sahara`` IRC channel on `freenode `_ * Join public weekly meetings on *Thursdays at 18:00 UTC* on ``#openstack-meeting-alt`` IRC channel @@ -53,9 +53,9 @@ How to send your first patch on review? * Checkout Sahara code from `Github `_ -* Carefully read https://wiki.openstack.org/wiki/Gerrit_Workflow +* Carefully read https://docs.openstack.org/infra/manual/developers.html#development-workflow - * Pay special attention to https://wiki.openstack.org/wiki/Gerrit_Workflow#Committing_Changes + * Pay special attention to https://docs.openstack.org/infra/manual/developers.html#committing-a-change * Apply and commit your changes diff --git a/doc/source/index.rst b/doc/source/index.rst index 50a3d08..7c5f55d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,7 +13,7 @@ You may want to read the `OpenStack Sahara Docs`__ -- the overview, at least -- to get an idea of the concepts. By understanding the concepts this library should make more sense. - __ http://docs.openstack.org/developer/sahara/ + __ https://docs.openstack.org/sahara/latest/ Contents: @@ -35,8 +35,8 @@ using `gerrit`_. .. _review.o.o: https://review.openstack.org .. _github: https://github.com/openstack/python-saharaclient -.. _git.o.o: http://git.openstack.org/cgit/openstack/python-saharaclient +.. _git.o.o: https://git.openstack.org/cgit/openstack/python-saharaclient .. _launchpad: https://launchpad.net/sahara .. _launchpad_client: https://launchpad.net/python-saharaclient -.. _gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow +.. _gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow diff --git a/doc/source/shell.rst b/doc/source/shell.rst index 6c6249e..e97ea2e 100644 --- a/doc/source/shell.rst +++ b/doc/source/shell.rst @@ -24,13 +24,13 @@ For more information about commands and their parameters you can refer to :doc:`the Sahara CLI commands `. For more information about abilities and features of OpenStackClient CLI you -can refer to `OpenStackClient documentation `_ +can refer to `OpenStackClient documentation `_ Configuration ------------- The CLI is configured via environment variables and command-line options which -are described in http://docs.openstack.org/developer/python-openstackclient/authentication.html. +are described in https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html. Authentication using username/password is most commonly used and can be provided with environment variables: diff --git a/saharaclient/_i18n.py b/saharaclient/_i18n.py index ac80de5..635d806 100644 --- a/saharaclient/_i18n.py +++ b/saharaclient/_i18n.py @@ -11,7 +11,7 @@ # under the License. """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 """ import oslo_i18n -- cgit v1.2.1