From 841625f59caf705856c5f24d4546123737f81e13 Mon Sep 17 00:00:00 2001 From: chenxing Date: Thu, 13 Jul 2017 14:12:30 +0000 Subject: [PATCH] Update the documention link for doc migration Change-Id: I2cbf25da77d44c20660f99f389647963e575377b --- CONTRIBUTING.rst | 2 +- README.rst | 2 +- doc/source/index.rst | 3 +-- doc/source/tempest-plugin.rst | 17 +++++++---------- .../json-api-examples/v1.1/README.rst | 6 +++--- setup.cfg | 2 +- 6 files changed, 14 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f632fcaf..e8eff209 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -5,7 +5,7 @@ you must follow the steps in this page: You can find more Sahara-specific info in our How To Participate guide: - http://docs.openstack.org/developer/sahara/devref/how_to_participate.html + https://docs.openstack.org/sahara/latest/devref/how_to_participate.html Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following diff --git a/README.rst b/README.rst index f7487f24..70059600 100644 --- a/README.rst +++ b/README.rst @@ -31,7 +31,7 @@ In sahara_tests folder we have next tools: * `Specs`_ * `Release notes`_ -.. _Sahara-scenario documentation: http://docs.openstack.org/developer/sahara-tests/ +.. _Sahara-scenario documentation: https://docs.openstack.org/sahara-tests/latest/scenario.html .. _PyPi: https://pypi.python.org/pypi/sahara-tests .. _Launchpad project: https://launchpad.net/sahara-tests .. _Blueprints: https://blueprints.launchpad.net/sahara-tests diff --git a/doc/source/index.rst b/doc/source/index.rst index c5049fe5..033d049c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -2,8 +2,7 @@ Welcome to sahara-tests's documentation! ======================================== Tests for the -`Sahara project -`_. +`Sahara project `_. It provides Sahara scenario tests framework and tempest tests. diff --git a/doc/source/tempest-plugin.rst b/doc/source/tempest-plugin.rst index c38d6cbb..3a27817a 100644 --- a/doc/source/tempest-plugin.rst +++ b/doc/source/tempest-plugin.rst @@ -9,8 +9,8 @@ your Devstack or using Rally. Run Tempest tests on Devstack ----------------------------- -See how to configure Tempest -`here `_. +See how to configure Tempest at +`Tempest Configuration Guide `_. Tempest automatically discovers installed plugins. That's why you just need to install the Python packages that contains the Sahara Tempest plugin in the @@ -35,8 +35,7 @@ tests by using ``ostestr`` command, for instance: .. The command ``tempest run`` is another way to run tests. See the additional -information about using this `command `_. +information about using this `command `_. For example, the following command will run all the Tempest tests. @@ -57,9 +56,9 @@ the following command will run all the cli-tests: Useful links: -* `Running Tempest tests with testr `_. -* `Using Tempest plugins `_. -* `Tempest Quickstart `_. +* `Running Tempest tests with testr `_. +* `Using Tempest plugins `_. +* `Tempest Quickstart `_. Run Tempest tests using Rally ----------------------------- @@ -68,9 +67,7 @@ First of all, be sure that Rally is installed and working. There should be a Rally deployment with correct working Sahara service in it. Full information can be found on this -`link -`_. +`link `_. Using this information, you can install ``rally verify`` tool and plugin for testing Sahara. After this you are free to run Sahara Tempest tests. Here are diff --git a/sahara_tests/scenario/defaults/edp-examples/json-api-examples/v1.1/README.rst b/sahara_tests/scenario/defaults/edp-examples/json-api-examples/v1.1/README.rst index 9930d7dd..c6474fa4 100644 --- a/sahara_tests/scenario/defaults/edp-examples/json-api-examples/v1.1/README.rst +++ b/sahara_tests/scenario/defaults/edp-examples/json-api-examples/v1.1/README.rst @@ -65,7 +65,7 @@ when creating data sources, storing binaries, and executing jobs. Use of a `swift proxy`_ can improve security by reducing the need to distribute and store credentials. -.. _swift proxy: http://docs.openstack.org/developer/sahara/userdoc/advanced.configuration.guide.html +.. _swift proxy: https://docs.openstack.org/sahara/latest/userdoc/advanced.configuration.guide.html Swift containers ---------------- @@ -76,7 +76,7 @@ though the data must be uploaded to the non-suffixed container. This suffix informs Hadoop that ``sahara`` is the provider for this data source. See the `hadoop swift`_ documentation for more information. -.. _hadoop swift: http://docs.openstack.org/developer/sahara/userdoc/hadoop-swift.html +.. _hadoop swift: https://docs.openstack.org/sahara/latest/userdoc/hadoop-swift.html REST API usage -------------- @@ -89,7 +89,7 @@ by Keystone for your tenant and user in header 'X-Auth-Token'. For new sahara REST users, reference to the `Sahara EDP API Documentation`_ will be useful throughout these exercises. -.. _Sahara EDP API Documentation: http://developer.openstack.org/api-ref-data-processing-v1.1.html +.. _Sahara EDP API Documentation: https://developer.openstack.org/api-ref/data-processing/index.html Example 1: Pig, using swift diff --git a/setup.cfg b/setup.cfg index 7fd6bf69..9937b6cc 100644 --- a/setup.cfg +++ b/setup.cfg @@ -14,7 +14,7 @@ classifiers = Operating System :: POSIX :: Linux author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://docs.openstack.org/developer/sahara-tests/ +home-page = https://docs.openstack.org/sahara-tests/latest/ [global] setup-hooks = pbr.hooks.setup_hook