From 2a5845428978e01cc015bb87d68add71d433a65f Mon Sep 17 00:00:00 2001 From: chenxing Date: Fri, 21 Jul 2017 15:50:11 +0800 Subject: [PATCH] Update the documentation link for doc migration These links need to be updated due to the doc migration. Current links are no longer effective. Change-Id: I218995d5c8cde34286e2133a53bd7d19ae46c75d --- HACKING.rst | 2 +- README.md | 4 ++-- api-guide/source/acls.rst | 24 +++++++++---------- api-guide/source/consumers.rst | 2 +- api-guide/source/containers.rst | 2 +- api-guide/source/orders.rst | 10 ++++---- api-guide/source/quotas.rst | 12 +++++----- api-guide/source/secret_metadata.rst | 2 +- api-guide/source/secrets.rst | 16 ++++++------- devstack/README.md | 2 +- doc/source/admin/barbican_manage.rst | 2 +- doc/source/configuration/audit.rst | 6 ++--- doc/source/configuration/keystone.rst | 4 ++-- doc/source/configuration/noauth.rst | 4 ++-- doc/source/contributor/architecture.rst | 4 ++-- .../contributor/database_migrations.rst | 2 +- setup.cfg | 2 +- 17 files changed, 50 insertions(+), 50 deletions(-) diff --git a/HACKING.rst b/HACKING.rst index 028446215..3ec8da276 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -2,7 +2,7 @@ Barbican 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 diff --git a/README.md b/README.md index 5db2fac29..0a1c2ae51 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Barbican is an OpenStack project developed by the [Barbican Project Team Johns Hopkins University, HP, Red Hat, Cisco Systems, and many more. The full documentation can be found on the [Barbican Developer Documentation -Site](http://docs.openstack.org/developer/barbican/). +Site](https://docs.openstack.org/barbican/latest/). If you have a technical question, you can ask it at [Ask OpenStack]( https://ask.openstack.org/en/questions/) with the `barbican` tag, or you can @@ -48,7 +48,7 @@ ecosystem. The other systems are: ## Getting Started Please visit our [Users, Developers and Operators documentation -](https://docs.openstack.org/developer/barbican/) for details. +](https://docs.openstack.org/barbican/latest/) for details. ## Why Should You Use Barbican? diff --git a/api-guide/source/acls.rst b/api-guide/source/acls.rst index 323dbc691..1dfe270b1 100644 --- a/api-guide/source/acls.rst +++ b/api-guide/source/acls.rst @@ -12,7 +12,7 @@ access. This guide will assume you will be using a local running development environment of barbican. If you need assistance with getting set up, please reference the -`development guide `__ +`development guide `__ .. warning:: @@ -145,8 +145,8 @@ To set/replace an ACL for a container: {"acl_ref": "http://localhost:9311/v1/containers/8c077991-d524-4e15-8eaf-bc0c3bb225f2/acl"} To get more details on the create API you can reference the -`Set Secret ACL `__ -or `Set Container ACL `__ +`Set Secret ACL `__ +or `Set Container ACL `__ documentation. @@ -258,10 +258,10 @@ To update only the users list for secret ACL (use PATCH): Container and Secret ACL(s) update operation are similar except `containers` resource is used instead of the `secrets` resource in URI. To get more details on ACL update APIs, you can reference -the `Update Secret ACL `__ -, `Update Container ACL `__ -, `Partial Update Secret ACL `__ -or `Partial Update Container ACL `__ +the `Update Secret ACL `__ +, `Update Container ACL `__ +, `Partial Update Secret ACL `__ +or `Partial Update Container ACL `__ documentation. @@ -326,8 +326,8 @@ To get container ACL data: To get more details on ACL lookup APIs you can reference the -`Get Secret ACL `__ -, `Get Container ACL `__ +`Get Secret ACL `__ +, `Get Container ACL `__ documentation. @@ -342,7 +342,7 @@ returned on successful deletion. Delete operation removes existing ACL on a secret or a container if there. It can be treated as resetting a secret or a container to -`Default ACL `__ +`Default ACL `__ setting. That's why invoking delete multiple times on this resource will not result in error. @@ -359,6 +359,6 @@ result in error. To get more details on ACL delete APIs, you can reference the -`Delete Secret ACL `__ -, `Delete Container ACL `__ +`Delete Secret ACL `__ +, `Delete Container ACL `__ documentation. diff --git a/api-guide/source/consumers.rst b/api-guide/source/consumers.rst index aa8097c74..cb1d6e142 100644 --- a/api-guide/source/consumers.rst +++ b/api-guide/source/consumers.rst @@ -4,7 +4,7 @@ Consumers API - User Guide This guide assumes you will be using a local development environment of barbican. If you need assistance with getting set up, please reference the -`development guide `__. +`development guide `__. What is a Consumer? diff --git a/api-guide/source/containers.rst b/api-guide/source/containers.rst index d9cf1ac36..9670da54c 100644 --- a/api-guide/source/containers.rst +++ b/api-guide/source/containers.rst @@ -16,7 +16,7 @@ held within. These will be broken down in their respective sections. This guide will assume you will be using a local running development environment of barbican. If you need assistance with getting set up, please reference the -`development guide `__. +`development guide `__. .. _generic_containers: diff --git a/api-guide/source/orders.rst b/api-guide/source/orders.rst index 8d3f06099..92465d28f 100644 --- a/api-guide/source/orders.rst +++ b/api-guide/source/orders.rst @@ -12,7 +12,7 @@ The orders resource supports the following types: This user guide provides high level examples of the orders resource. It will assume you will be using a local running development environment of barbican. If you need assistance with getting set up, please reference the -`development guide `__. +`development guide `__. .. _create_order: @@ -25,7 +25,7 @@ bit_length, and algorithm must be valid. Otherwise the order will fail and the secret will not be generated. The example below shows a valid order for generating a symmetric key. You can find a more detailed explanation about the parameters in the -`Orders API `__ +`Orders API `__ documentation. .. code-block:: bash @@ -87,7 +87,7 @@ The order metadata is very useful for determining if your order was processed correctly. Since orders are processed asynchronously, you can use the metadata returned for the order to verify a successful secret creation. The parameters of the response are explained in more detail -`here `__. +`here `__. .. _retrieve_order_list: @@ -146,9 +146,9 @@ It is also possible to retrieve all orders for a project. } You can refer to the -`orders parameters `__ +`orders parameters `__ section of the -`Orders API `__ +`Orders API `__ documentation in order to refine your search among orders. .. _delete_order: diff --git a/api-guide/source/quotas.rst b/api-guide/source/quotas.rst index 592567634..db61bba38 100644 --- a/api-guide/source/quotas.rst +++ b/api-guide/source/quotas.rst @@ -17,7 +17,7 @@ configuration for all projects in his cloud. This guide will assume you will be using a local running development environment of barbican. If you need assistance with getting set up, please reference the -`development guide `__. +`development guide `__. .. _user_project_quotas_overview: @@ -102,7 +102,7 @@ with the request. To get more details on the quota lookup API, you can reference the -`Get Quotas `__ +`Get Quotas `__ documentation. @@ -134,7 +134,7 @@ To set or replace the quotas for the project with the ID 1234: To get more details on the project quota setting API you can reference the -`Set Project Quotas `__ +`Set Project Quotas `__ documentation. @@ -206,9 +206,9 @@ The returned response contains a list with all project quota data. To get more details on project quota lookup APIs you can reference the -`Get Project Quota `__ +`Get Project Quota `__ and -`Get Project Quota List `__ +`Get Project Quota List `__ documentation. @@ -236,5 +236,5 @@ There is no response content returned on successful deletion. To get more details on project quota delete APIs, you can reference the -`Delete Project Quotas `__ +`Delete Project Quotas `__ documentation. diff --git a/api-guide/source/secret_metadata.rst b/api-guide/source/secret_metadata.rst index 36f5c2d83..5a0f3cb3c 100644 --- a/api-guide/source/secret_metadata.rst +++ b/api-guide/source/secret_metadata.rst @@ -14,7 +14,7 @@ To create/update the secret metadata for a specific secret, we will need to know the secret reference of the secret we wish to add user metadata to. Any metadata that was previously set will be deleted and replaced with this metadata. For more information on creating/updating secret metadata, you can view the -`PUT /v1/secrets/{uuid}/metadata `__ +`PUT /v1/secrets/{uuid}/metadata `__ section. .. code-block:: bash diff --git a/api-guide/source/secrets.rst b/api-guide/source/secrets.rst index 708a6a947..388ea06f9 100644 --- a/api-guide/source/secrets.rst +++ b/api-guide/source/secrets.rst @@ -9,7 +9,7 @@ Barbican supports the storage of data for various content-types securely. This guide will assume you will be using a local running development environment of barbican. If you need assistance with getting set up, please reference the -`development guide `__. +`development guide `__. What is a Secret? @@ -27,11 +27,11 @@ Some examples of a secret may include: For the purpose of this user guide, we will use a simple plaintext secret. If you would like to learn more in detail about -`secret parameters `__, -`responses `__, -and `status codes `__ +`secret parameters `__, +`responses `__, +and `status codes `__ you can reference the -`secret reference `__ +`secret reference `__ documentation. @@ -48,7 +48,7 @@ barbican expects the user to provide the payload to be stored within the secret itself. Once the secret has been created with a payload it cannot be updated. In this example we will provide a plain text secret. For more information on creating secrets you can view the -`POST /v1/secrets `__ +`POST /v1/secrets `__ section. .. code-block:: bash @@ -109,7 +109,7 @@ your own in order to update the secret. No response will be provided. This is expected behavior! If you do receive a response, something went wrong and you will have to address that before moving forward. (For more information visit -`PUT /v1/secrets/{uuid} `__ +`PUT /v1/secrets/{uuid} `__ .) @@ -148,5 +148,5 @@ the initial creation (See :ref:`How to Create a Secret `.) No response will be provided. This is expected behavior! If you do receive a response, something went wrong and you will have to address that before moving forward. (For more information visit -`DELETE /v1/secrets/{uuid} `__ +`DELETE /v1/secrets/{uuid} `__ .) diff --git a/devstack/README.md b/devstack/README.md index 1e467a949..75db33f9d 100644 --- a/devstack/README.md +++ b/devstack/README.md @@ -18,4 +18,4 @@ For example enable_plugin barbican https://git.openstack.org/openstack/barbican stable/liberty For more information, see the "Externally Hosted Plugins" section of -http://docs.openstack.org/developer/devstack/plugins.html +https://docs.openstack.org/devstack/latest/plugins.html diff --git a/doc/source/admin/barbican_manage.rst b/doc/source/admin/barbican_manage.rst index d0ce0d93a..b8cceab22 100644 --- a/doc/source/admin/barbican_manage.rst +++ b/doc/source/admin/barbican_manage.rst @@ -80,4 +80,4 @@ Barbican PKCS11/HSM key labels in /etc/barbican.conf and restart barbican server before executing this command. -.. _Database Migration: http://docs.openstack.org/developer/barbican/contribute/database_migrations.html +.. _Database Migration: https://docs.openstack.org/barbican/latest/contributor/database_migrations.html diff --git a/doc/source/configuration/audit.rst b/doc/source/configuration/audit.rst index 804ccbb76..e122c4353 100644 --- a/doc/source/configuration/audit.rst +++ b/doc/source/configuration/audit.rst @@ -18,7 +18,7 @@ Audit middleware creates two events per REST API interaction. First event has information extracted from request data and the second one has request outcome (response). -.. _Audit middleware: https://docs.openstack.org/keystonemiddleware/latest/ +.. _Audit middleware: https://docs.openstack.org/keystonemiddleware/latest/audit.html .. _CADF format: http://www.dmtf.org/sites/default/files/standards/documents/DSP2038_1.0.0.pdf @@ -39,8 +39,8 @@ used for creating events in CADF format. .. _keystonemiddleware: https://github.com/openstack/keystonemiddleware/blob/master/keystonemiddleware/audit.py -.. _Enabling Middleware Link: https://docs.openstack.org/keystonemiddleware/latest/#enabling-audit-middleware -.. _Configuring Middleware Link: https://docs.openstack.org/keystonemiddleware/latest/#configure-audit-middleware +.. _Enabling Middleware Link: https://docs.openstack.org/keystonemiddleware/latest/audit.html#enabling-audit-middleware +.. _Configuring Middleware Link: https://docs.openstack.org/keystonemiddleware/latest/audit.html#configure-audit-middleware .. note:: diff --git a/doc/source/configuration/keystone.rst b/doc/source/configuration/keystone.rst index 46e56a663..7ff23ca5d 100644 --- a/doc/source/configuration/keystone.rst +++ b/doc/source/configuration/keystone.rst @@ -15,8 +15,8 @@ following ways to setup your own. .. _Simple Dockerized Keystone: https://registry.hub.docker.com/u/ jmvrbanac/simple-keystone/ -.. _Installing Keystone: https://docs.openstack.org/developer/keystone/ - installing.html +.. _Installing Keystone: https://docs.openstack.org/keystone/latest/ + install/index.html Hooking up Barbican to Keystone diff --git a/doc/source/configuration/noauth.rst b/doc/source/configuration/noauth.rst index 0a5420d34..6f9ceacf5 100644 --- a/doc/source/configuration/noauth.rst +++ b/doc/source/configuration/noauth.rst @@ -40,5 +40,5 @@ instead. In case of API, replace ``'X-Auth-Token: $TOKEN'`` with You can also find detailed explanation to run barbican client with an unauthenticated context -`here `__ and run barbican CLI in no auth mode -`here `__. +`here `__ and run barbican CLI in no auth mode +`here `__. diff --git a/doc/source/contributor/architecture.rst b/doc/source/contributor/architecture.rst index 988acb0a4..56f953d8e 100644 --- a/doc/source/contributor/architecture.rst +++ b/doc/source/contributor/architecture.rst @@ -44,9 +44,9 @@ available plugin. The API node noted in the previous section is a WSGI server. Similar to OpenStack projects such as -`Glance `_ it utilizes paste to +`Glance `_ it utilizes paste to support configurable middleware such as to interface with -`Keystone `_ for authentication +`Keystone `_ for authentication and authorization services. `Pecan `_ (a lean Python web framework inspired by CherryPy, TurboGears, and Pylons) is utilized to map resources to REST routes. These resources contain the controller diff --git a/doc/source/contributor/database_migrations.rst b/doc/source/contributor/database_migrations.rst index d730582d1..7a2000cec 100644 --- a/doc/source/contributor/database_migrations.rst +++ b/doc/source/contributor/database_migrations.rst @@ -273,7 +273,7 @@ TODO Items .. _Alembic Example: https://julo.ch/blog/migrating-content-with-alembic/ .. _Alembic Operation Reference: https://alembic.readthedocs.org/en/latest/ops.html .. _Alembic tutorial: https://alembic.readthedocs.org/en/latest/tutorial.html -.. _Barbican DevStack: http://docs.openstack.org/developer/barbican/setup/devstack.html +.. _Barbican DevStack: https://docs.openstack.org/barbican/latest/contributor/devstack.html .. _Developer Guide: https://github.com/cloudkeep/barbican/wiki/Developer-Guide .. _Need to alter column types in production database: http://stackoverflow.com/questions/5329255/need-to-alter-column-types-in-production-database-sql-server-2005 .. _OpenStack and SQLAlchemy: https://wiki.openstack.org/wiki/OpenStack_and_SQLAlchemy#Migrations diff --git a/setup.cfg b/setup.cfg index e0f266fb6..05a4e6708 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,7 +6,7 @@ description-file = README.md author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://docs.openstack.org/developer/barbican/ +home-page = https://docs.openstack.org/barbican/latest/ classifier = Environment :: OpenStack Intended Audience :: Information Technology