From 82785553ddf1a847b1ce94e53d9f96461f7cac71 Mon Sep 17 00:00:00 2001 From: Samriddhi Jain Date: Tue, 25 Jul 2017 01:36:35 -1000 Subject: [PATCH] Updated URLs in docs With the docs migration and re-arrangement, some docs have been shifted to new places, however the referenced links are still old. Some of them give 404 error or just point to the home page. This patch fixes those URLs. Change-Id: Ie6b18ab3d4aa346dac8436dd426277fee4f07fcd --- api-ref/source/v3/index.rst | 2 +- doc/source/admin/federated-identity.rst | 5 ++--- .../advanced-topics/configure_tokenless_x509.rst | 5 ++--- doc/source/advanced-topics/event_notifications.rst | 4 ++-- doc/source/cli/keystone-manage.rst | 2 +- doc/source/configuration.rst | 6 +++--- doc/source/contributor/http-api.rst | 2 +- doc/source/contributor/release-notes.rst | 2 +- doc/source/contributor/services.rst | 2 +- doc/source/contributor/set-up-keystone.rst | 2 +- doc/source/contributor/testing-keystone.rst | 10 +++++----- doc/source/index.rst | 6 +++--- doc/source/install/keystone-openrc.rst | 2 +- keystone/common/sql/upgrades.py | 6 ++++-- setup.cfg | 2 +- 15 files changed, 29 insertions(+), 29 deletions(-) diff --git a/api-ref/source/v3/index.rst b/api-ref/source/v3/index.rst index 96693805cf..913189241f 100644 --- a/api-ref/source/v3/index.rst +++ b/api-ref/source/v3/index.rst @@ -23,7 +23,7 @@ contains the same headers and HTTP status code as the corresponding GET API. For information about Identity API protection, see `Identity API protection with role-based access control (RBAC) -`_ +`_ in the OpenStack Cloud Administrator Guide. ========================= diff --git a/doc/source/admin/federated-identity.rst b/doc/source/admin/federated-identity.rst index 173a92ace4..bedd30d650 100644 --- a/doc/source/admin/federated-identity.rst +++ b/doc/source/admin/federated-identity.rst @@ -38,8 +38,7 @@ To enable federation: by the community. #. Configure Apache to use a federation capable module. - We recommend Shibboleth, see `the Shibboleth documentation `_ - for more information. + We recommend Shibboleth, see :doc:`the Shibboleth documentation<../advanced-topics/federation/shibboleth>` for more information. .. note:: @@ -319,7 +318,7 @@ A rule hierarchy is as follows: only be set in a remote rule. For more information on mapping rules, see `Mapping Rules -`_. +`_. Mapping creation ---------------- diff --git a/doc/source/advanced-topics/configure_tokenless_x509.rst b/doc/source/advanced-topics/configure_tokenless_x509.rst index 5a369e58a5..8404ea275c 100644 --- a/doc/source/advanced-topics/configure_tokenless_x509.rst +++ b/doc/source/advanced-topics/configure_tokenless_x509.rst @@ -35,10 +35,9 @@ Prerequisites Keystone must be running in a web container with https enabled; tests have been done with Apache/2.4.7 running on Ubuntu 14.04 . Please refer to -`running-keystone-in-httpd`_ and `apache-certificate-and-key-installation`_ -as references for this setup. +:doc:`Install and Configure Keystone <../install/index>` and +`apache-certificate-and-key-installation`_ as references for this setup. -.. _`running-keystone-in-httpd`: https://docs.openstack.org/developer/keystone/apache-httpd.html .. _`apache-certificate-and-key-installation`: https://www.digitalocean.com/community/tutorials/how-to-create-a-ssl-certificate-on-apache-for-ubuntu-14-04 -------------------- diff --git a/doc/source/advanced-topics/event_notifications.rst b/doc/source/advanced-topics/event_notifications.rst index aac49c7649..f45f235891 100644 --- a/doc/source/advanced-topics/event_notifications.rst +++ b/doc/source/advanced-topics/event_notifications.rst @@ -66,7 +66,7 @@ capabilities for compliance with security, operational, and business processes and supports normalized and categorized event data for federation and aggregation. -.. _PyCADF: https://docs.openstack.org/developer/pycadf +.. _PyCADF: https://docs.openstack.org/pycadf/latest .. _CADF: http://www.dmtf.org/standards/cadf CADF notifications include additional context data around the ``resource``, @@ -565,4 +565,4 @@ By default, messages for the following authentication events are suppressed since they are too noisy: ``identity.authenticate.success``, ``identity.authenticate.pending`` and ``identity.authenticate.failed``. -.. _Telemetry Measurements: https://docs.openstack.org/admin-guide/telemetry-measurements.html#openstack-identity +.. _Telemetry Measurements: https://docs.openstack.org/ceilometer/latest/admin/telemetry-measurements.html#openstack-identity diff --git a/doc/source/cli/keystone-manage.rst b/doc/source/cli/keystone-manage.rst index 0afbe2261d..5f3ccda9ee 100644 --- a/doc/source/cli/keystone-manage.rst +++ b/doc/source/cli/keystone-manage.rst @@ -103,7 +103,7 @@ None SEE ALSO ======== -* `OpenStack Keystone `__ +* `OpenStack Keystone `__ SOURCE ====== diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 18a274c814..29ae151321 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -546,7 +546,7 @@ It's important that the healthcheck go to the front of the pipeline for the most efficient checks. For more information and configuration options for the middleware see -`oslo.middleware `_. +`oslo.middleware `_. .. _`API protection with RBAC`: @@ -730,8 +730,8 @@ There are two supported clients, `python-keystoneclient`_ project provides python bindings and `python-openstackclient`_ provides a command line interface. -.. _`python-openstackclient`: https://docs.openstack.org/developer/python-openstackclient/ -.. _`python-keystoneclient`: https://docs.openstack.org/developer/python-keystoneclient/ +.. _`python-openstackclient`: https://docs.openstack.org/python-openstackclient/latest +.. _`python-keystoneclient`: https://docs.openstack.org/python-keystoneclient/latest Authenticating with a Password via CLI diff --git a/doc/source/contributor/http-api.rst b/doc/source/contributor/http-api.rst index 5c6ce4d41c..2f11b6954f 100644 --- a/doc/source/contributor/http-api.rst +++ b/doc/source/contributor/http-api.rst @@ -126,7 +126,7 @@ With unversioned ``identity`` endpoints in the service catalog, you should be able to `authenticate with keystoneclient`_ successfully. .. _`latest sample configuration`: https://git.openstack.org/cgit/openstack/keystone/tree/etc/keystone-paste.ini -.. _`authenticate with keystoneclient`: https://docs.openstack.org/developer/python-keystoneclient/using-api-v3.html#authenticating-using-sessions +.. _`authenticate with keystoneclient`: https://docs.openstack.org/python-keystoneclient/latest/using-api-v3.html#authenticating-using-sessions I have a Python client ---------------------- diff --git a/doc/source/contributor/release-notes.rst b/doc/source/contributor/release-notes.rst index d5a5620405..8191214225 100644 --- a/doc/source/contributor/release-notes.rst +++ b/doc/source/contributor/release-notes.rst @@ -19,7 +19,7 @@ Working with Release Notes ========================== The Keystone team uses `reno -`_ to generate release +`_ to generate release notes. These are important user-facing documents that must be included when a user or operator facing change is performed, like a bug-fix or a new feature. A release note should be included in the same patch the work is being performed. diff --git a/doc/source/contributor/services.rst b/doc/source/contributor/services.rst index 18bd39e9f0..1ae7eadb9d 100644 --- a/doc/source/contributor/services.rst +++ b/doc/source/contributor/services.rst @@ -195,7 +195,7 @@ Use OpenStack CLI not keystone CLI ---------------------------------- The keystone CLI is deprecated and will be removed soon. The `OpenStack CLI -`_ has all the +`_ has all the keystone CLI commands and even supports v3. diff --git a/doc/source/contributor/set-up-keystone.rst b/doc/source/contributor/set-up-keystone.rst index 637dc24bde..85b8a9e6de 100644 --- a/doc/source/contributor/set-up-keystone.rst +++ b/doc/source/contributor/set-up-keystone.rst @@ -69,7 +69,7 @@ Install the keystone web service: list of platform-specific dependencies is outside the scope of this documentation, but is within scope of DEVSTACK_. -.. _DEVSTACK: https://docs.openstack.org/developer/devstack/ +.. _DEVSTACK: https://docs.openstack.org/devstack/latest Development environment ======================= diff --git a/doc/source/contributor/testing-keystone.rst b/doc/source/contributor/testing-keystone.rst index 3ef4b4226d..86af3514ff 100644 --- a/doc/source/contributor/testing-keystone.rst +++ b/doc/source/contributor/testing-keystone.rst @@ -271,9 +271,9 @@ from the tempest directory: the correct place to add new tests. .. _devstack: https://git.openstack.org/cgit/openstack-dev/devstack -.. _devstack plugin: https://docs.openstack.org/developer/devstack/plugins.html +.. _devstack plugin: https://docs.openstack.org/devstack/latest/plugins.html .. _tempest: https://git.openstack.org/cgit/openstack/tempest -.. _tempest plugin: https://docs.openstack.org/developer/tempest/plugin.html +.. _tempest plugin: https://docs.openstack.org/tempest/latest/plugin.html Writing new API & Scenario Tests ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -411,6 +411,6 @@ Notice that the ``test_request_unscoped_token`` test only executes if the the tempest plugin are executed in the ``gate-keystone-dsvm-functional-v3-only-*`` job. -.. _Tempest Field Guide to Scenario tests: https://docs.openstack.org/developer/tempest/field_guide/scenario.html -.. _Tempest Field Guide to API tests: https://docs.openstack.org/developer/tempest/field_guide/api.html -.. _tempest coding guide: https://docs.openstack.org/developer/tempest/HACKING.html +.. _Tempest Field Guide to Scenario tests: https://docs.openstack.org/tempest/latest/field_guide/scenario.html +.. _Tempest Field Guide to API tests: https://docs.openstack.org/tempest/latest/field_guide/api.html +.. _tempest coding guide: https://docs.openstack.org/tempest/latest/HACKING.html diff --git a/doc/source/index.rst b/doc/source/index.rst index b0dd92124b..82477dad3b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -40,9 +40,9 @@ In addition to creating OpenStack's Identity Service, the Keystone team also provides a `WSGI middleware`_, an `Authentication library`_ and a `Python client library`_. -.. _`WSGI middleware`: https://docs.openstack.org/developer/keystonemiddleware/ -.. _`Authentication library`: https://docs.openstack.org/developer/keystoneauth/ -.. _`Python client library`: https://docs.openstack.org/developer/python-keystoneclient/ +.. _`WSGI middleware`: https://docs.openstack.org/keystonemiddleware/latest +.. _`Authentication library`: https://docs.openstack.org/keystoneauth/latest +.. _`Python client library`: https://docs.openstack.org/python-keystoneclient/latest Installation Guides ~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/install/keystone-openrc.rst b/doc/source/install/keystone-openrc.rst index 053e555095..42f0b03438 100644 --- a/doc/source/install/keystone-openrc.rst +++ b/doc/source/install/keystone-openrc.rst @@ -31,7 +31,7 @@ scripts to load appropriate credentials for client operations. The OpenStack client also supports using a ``clouds.yaml`` file. For more information, see - the `os-client-config `_. + the `os-client-config `_. .. code-block:: bash diff --git a/keystone/common/sql/upgrades.py b/keystone/common/sql/upgrades.py index 4e668ef4fe..0e4066792e 100644 --- a/keystone/common/sql/upgrades.py +++ b/keystone/common/sql/upgrades.py @@ -287,7 +287,8 @@ def validate_upgrade_order(repo_name, target_repo_version=None): if int(repo.latest) != get_db_version(): raise db_exception.DBMigrationError( 'Your Legacy repo version is not up to date. Please refer to ' - 'https://docs.openstack.org/developer/keystone/upgrading.html ' + 'https://docs.openstack.org/keystone/latest/admin/' + 'identity-upgrading.html ' 'to see the proper steps for rolling upgrades.') return @@ -304,7 +305,8 @@ def validate_upgrade_order(repo_name, target_repo_version=None): if dependency_repo_version < target_repo_version: raise db_exception.DBMigrationError( 'You are attempting to upgrade %s ahead of %s. Please refer to ' - 'https://docs.openstack.org/developer/keystone/upgrading.html ' + 'https://docs.openstack.org/keystone/latest/admin/' + 'identity-upgrading.html ' 'to see the proper steps for rolling upgrades.' % ( repo_name, db_sync_order[repo_name])) diff --git a/setup.cfg b/setup.cfg index 43bb672943..de39dfbcf8 100644 --- a/setup.cfg +++ b/setup.cfg @@ -5,7 +5,7 @@ description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = https://docs.openstack.org/developer/keystone/ +home-page = https://docs.openstack.org/keystone/latest classifier = Environment :: OpenStack Intended Audience :: Information Technology