From e5582cc5a605a0044ce5f55e0f64abab34fefb8f Mon Sep 17 00:00:00 2001 From: Goutham Pacha Ravi Date: Mon, 22 Jul 2019 12:50:43 -0700 Subject: [PATCH] [api-ref] Use relative links and fix grammar When referring to documents that are published from the same folder, we can use relative links. Change-Id: I431e20713e1b91be3bf9fa2f57a9c9b88519d6b4 --- api-ref/source/share-group-snapshots.inc | 3 +-- api-ref/source/share-group-types.inc | 23 ++++++++++++----------- api-ref/source/share-groups.inc | 7 +++---- api-ref/source/share-migration.inc | 4 +--- 4 files changed, 17 insertions(+), 20 deletions(-) diff --git a/api-ref/source/share-group-snapshots.inc b/api-ref/source/share-group-snapshots.inc index 8fd37c6df2..6e7146f937 100644 --- a/api-ref/source/share-group-snapshots.inc +++ b/api-ref/source/share-group-snapshots.inc @@ -19,8 +19,7 @@ roles. .. note:: - Share Group Snapshot APIs are part of the `experimental APIs - `_. + Share Group Snapshot APIs are `experimental APIs <#experimental-apis>`_. List share group snapshots ========================== diff --git a/api-ref/source/share-group-types.inc b/api-ref/source/share-group-types.inc index 6516beef6c..b1de7bed10 100644 --- a/api-ref/source/share-group-types.inc +++ b/api-ref/source/share-group-types.inc @@ -9,18 +9,20 @@ create a share group. You can set share group types as either public or private. By default a share group type is created as publicly accessible. Set -``share_group_type_access:is_public`` to ``False`` to make the share group +``share_group_type_access:is_public`` to ``False`` to make a share group type private. -You can manage the access to the private share group types for the -different projects. You can add access, remove access, and get -information about access for a private share group type. +You can manage access to the private share group types for different +projects. You can add access, remove access, and get information about +access for a private share group type. -Administrators can specifies which `share type(s) -`_ -a given group type may contain. If Administrators does not specify it, then -manila will use ``default`` share type. The scheduler then creates the group on -one of the back ends that match the specified share type(s) and share group type. +Administrators can specify which `share type(s) <#experimental-apis>`_ +a given group type may contain. If Administrators do not explicitly +associate share types with a given share group type, the service will associate +the share type configured as the ``default_share_type`` with the share group +type. When creating a share group, the scheduler picks one of the +back ends that match a combination of the extra specs in the specified share +type(s) and share group type. Administrators can also set additional group extra specifications for a share group type for the following purposes: @@ -31,8 +33,7 @@ share group type for the following purposes: .. note:: - Share Group Types APIs are part of the `experimental APIs - `_. + Share Group Types APIs are `experimental APIs <#experimental-apis>`_. List share group types ====================== diff --git a/api-ref/source/share-groups.inc b/api-ref/source/share-groups.inc index 8d6870c0b4..d8746ed675 100644 --- a/api-ref/source/share-groups.inc +++ b/api-ref/source/share-groups.inc @@ -18,10 +18,9 @@ share groups, and show information for delete a share group. .. note:: - Share Group APIs are part of the `experimental APIs - `_. - The ``availability_zone_id`` and ``consistent_snapshot_support`` fields were added - to ``share_group`` object introduced in version 2.34. + Share Group APIs are `experimental APIs <#experimental-apis>`_. + The ``availability_zone_id`` and ``consistent_snapshot_support`` + fields were added to ``share_group`` object since version 2.34. List share groups ================= diff --git a/api-ref/source/share-migration.inc b/api-ref/source/share-migration.inc index 2c2f4d8625..13115f75c9 100644 --- a/api-ref/source/share-migration.inc +++ b/api-ref/source/share-migration.inc @@ -15,9 +15,7 @@ Possible use cases for data migration include: .. note:: - Share Migration APIs are part of the `experimental APIs - `_ . + Share Migration APIs are `experimental APIs <#experimental-apis>`_ . Migrate share (DEPRECATED)