openstack/manila
Code Issues Proposed changes

[api-ref] Use relative links and fix grammar

Browse Source 
When referring to documents that are published
from the same folder, we can use relative links.

Change-Id: I431e20713e1b91be3bf9fa2f57a9c9b88519d6b4
This commit is contained in:
Goutham Pacha Ravi 2019-07-22 12:50:43 -07:00
parent 7916986e64
commit e5582cc5a6
4 changed files with 17 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
api-ref/source/share-group-snapshots.inc
View File

@ -19,8 +19,7 @@ roles.
.. note:: .. note::
Share Group Snapshot APIs are part of the `experimental APIs Share Group Snapshot APIs are `experimental APIs <#experimental-apis>`_.
<https://docs.openstack.org/api-ref/shared-file-system/#experimental-apis>`_.
List share group snapshots List share group snapshots
========================== ==========================

23
api-ref/source/share-group-types.inc
View File

@ -9,18 +9,20 @@ create a share group.
You can set share group types as either public or private. By default a 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 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. type private.
You can manage the access to the private share group types for the You can manage access to the private share group types for different
different projects. You can add access, remove access, and get projects. You can add access, remove access, and get information about
information about access for a private share group type. access for a private share group type.
Administrators can specifies which `share type(s) Administrators can specify which `share type(s) <#experimental-apis>`_
<https://docs.openstack.org/api-ref/shared-file-system/#experimental-apis>`_ a given group type may contain. If Administrators do not explicitly
a given group type may contain. If Administrators does not specify it, then associate share types with a given share group type, the service will associate
manila will use ``default`` share type. The scheduler then creates the group on the share type configured as the ``default_share_type`` with the share group
one of the back ends that match the specified share type(s) and share group type. 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 Administrators can also set additional group extra specifications for a
share group type for the following purposes: share group type for the following purposes:
@ -31,8 +33,7 @@ share group type for the following purposes:
.. note:: .. note::
Share Group Types APIs are part of the `experimental APIs Share Group Types APIs are `experimental APIs <#experimental-apis>`_.
<https://docs.openstack.org/api-ref/shared-file-system/#experimental-apis>`_.
List share group types List share group types
====================== ======================

7
api-ref/source/share-groups.inc
View File

@ -18,10 +18,9 @@ share groups, and show information for delete a share group.
.. note:: .. note::
Share Group APIs are part of the `experimental APIs Share Group APIs are `experimental APIs <#experimental-apis>`_.
<https://docs.openstack.org/api-ref/shared-file-system/#experimental-apis>`_. The ``availability_zone_id`` and ``consistent_snapshot_support``
The ``availability_zone_id`` and ``consistent_snapshot_support`` fields were added fields were added to ``share_group`` object since version 2.34.
to ``share_group`` object introduced in version 2.34.
List share groups List share groups
================= =================

4
api-ref/source/share-migration.inc
View File

@ -15,9 +15,7 @@ Possible use cases for data migration include:
.. note:: .. note::
Share Migration APIs are part of the `experimental APIs Share Migration APIs are `experimental APIs <#experimental-apis>`_ .
<https://docs.openstack.org/api-ref/shared-file-system/
#experimental-apis>`_ .
Migrate share (DEPRECATED) Migrate share (DEPRECATED)