diff --git a/api-ref/source/share-types.inc b/api-ref/source/share-types.inc index cc2b0d42ab..e2cbdd8dee 100644 --- a/api-ref/source/share-types.inc +++ b/api-ref/source/share-types.inc @@ -74,7 +74,7 @@ The scheduler uses the special ``capabilities`` prefix for filtering. The scheduler can only create a share on a back end that reports capabilities that match the un-scoped extra-spec keys for the share type. For details, see `Capabilities and Extra-Specs -`_. Each driver implementation determines which extra specification @@ -310,7 +310,7 @@ Sets an extra specification for the share type. Each driver implementation determines which extra specification keys it uses. For details, see `Capabilities and Extra-Specs -`_ and documentation for your driver. Normal response codes: 200 diff --git a/doc/source/admin/shared-file-systems-crud-share.rst b/doc/source/admin/shared-file-systems-crud-share.rst index bb854d5366..3ab4063e79 100644 --- a/doc/source/admin/shared-file-systems-crud-share.rst +++ b/doc/source/admin/shared-file-systems-crud-share.rst @@ -737,7 +737,7 @@ Allow access to the share with ``user`` access type: For the example, the Generic driver with the Block Storage service as a back-end doesn't support ``user`` and ``cert`` authentications methods. For details of supporting of features by different drivers, see `Manila share - features support mapping `_. To verify that the access rules (ACL) were configured correctly for a share, diff --git a/doc/source/admin/shared-file-systems-scheduling.rst b/doc/source/admin/shared-file-systems-scheduling.rst index 301c1f2e9e..c96b003ad2 100644 --- a/doc/source/admin/shared-file-systems-scheduling.rst +++ b/doc/source/admin/shared-file-systems-scheduling.rst @@ -15,7 +15,7 @@ A share type is a list from key-value pairs called extra-specs. The scheduler uses required and un-scoped extra-specs to look up the shared service most suitable for a new share with the specified share type. For more information about extra-specs and their type, see `Capabilities -and Extra-Specs `_ section in developer documentation. The general scheduler workflow: diff --git a/doc/source/contributor/adding_release_notes.rst b/doc/source/contributor/adding_release_notes.rst index abe2008849..f25345fc59 100644 --- a/doc/source/contributor/adding_release_notes.rst +++ b/doc/source/contributor/adding_release_notes.rst @@ -172,8 +172,8 @@ Dos and Don'ts * OpenStack prefers atomic changes. So remember that your change may need the fewest sections possible * General writing guidelines can be found - `here `_ + `here `_ * Proofread your note. Pretend you are a user or a deployer who is reading the note after a milestone or a release has been cut diff --git a/doc/source/contributor/documenting_your_work.rst b/doc/source/contributor/documenting_your_work.rst index d464e1fc87..d7dd27a7bf 100644 --- a/doc/source/contributor/documenting_your_work.rst +++ b/doc/source/contributor/documenting_your_work.rst @@ -26,9 +26,8 @@ OpenStack User Guide is available on ``python-manilaclient`` and/or ``manila-ui``. - If you develop an end user facing feature, you need to provide an overview, use cases and example work-flows as part of this documentation. -- **Link**: `User guide `_ -- **Repository**: The user guide is maintained within the - `OpenStack Manuals project `_ +- The source files for the user guide live in manila's code tree. +- **Link**: `User guide `_ OpenStack Administrator Guide @@ -39,9 +38,8 @@ OpenStack Administrator Guide for utilizing a feature, along with managing and troubleshooting manila when the feature is used. - Relevant configuration options may be mentioned here briefly. -- **Link**: `Administrator guide `_ -- **Repository**: The administrator guide is maintained within the - `OpenStack Manuals project `_ +- The source files for the administrator guide live in manila's code tree. +- **Link**: `Administrator guide `_ OpenStack Configuration Reference @@ -54,10 +52,9 @@ OpenStack Configuration Reference configuration options. - If you are a driver maintainer, please ensure that your driver and all of its relevant configuration is documented here. -- **Link**: `Mitaka release configuration reference - `_ -- **Repository**: The configuration reference is maintained within the - `OpenStack Manuals project `_ +- The source files for the configuration guide live in manila's code tree. +- **Link**: `Manila release configuration reference + `_ OpenStack Installation Tutorial @@ -70,7 +67,7 @@ OpenStack Installation Tutorial - The instructions are written with reference to different distributions. - The source files for this tutorial live in manila's code tree. - **Link**: `Draft installation tutorial - `_ + `_ OpenStack API Reference ----------------------- @@ -84,7 +81,7 @@ OpenStack API Reference - Since the Newton release, manila's API reference is maintained in-tree in custom YAML/JSON format files. - **Link**: `REST API reference of the Shared File Systems Project v2.0 - `_ + `_ Manila Developer Reference -------------------------- @@ -123,10 +120,7 @@ OpenStack Command Line Reference - No manual corrections are allowed on this repository; make necessary corrections in the ``python-manilaclient`` repository." - **Link**: `Manila CLI reference - `_ -- **Repository**: The CLI reference is maintained within the - `OpenStack Manuals project - `_. + `_. Important things to note @@ -147,11 +141,11 @@ Important things to note service`` and not the service type (``share``) or the project name (``manila``). - Follow documentation styles prescribed in the `OpenStack Documentation - Contributor Guide `_. Pay + Contributor Guide `_. Pay heed to the `RST formatting conventions - `_ + `_ and `Writing style - `_. + `_. - Use CamelCase to spell out `OpenStack` and sentence casing to spell out service types, ex: `Shared File Systems service` and lower case to spell out project names, ex: `manila` (except when the project name is in @@ -165,9 +159,7 @@ Important things to note built with every commit in the respective codebase. Therefore, documentation added here need not be backported to previous releases. - You may backport changes to some documentation such as the configuration - reference and the installation guide. Refer to the instructions `here - `_. + reference and the installation guide. - **Important "documentation" that isn't really documentation** - ``specs`` and ``release notes`` are *NOT* documentation. A specification document is written to initiate a dialogue and gather feedback regarding the diff --git a/doc/source/contributor/driver_requirements.rst b/doc/source/contributor/driver_requirements.rst index 7a7e423d7e..ee07f95fb0 100644 --- a/doc/source/contributor/driver_requirements.rst +++ b/doc/source/contributor/driver_requirements.rst @@ -220,7 +220,7 @@ report the ``replication_type`` they support as a capability and implement necessary methods. More details can be found at: -https://docs.openstack.org/manila/latest/contributor/share_replication.html +https://docs.openstack.org/manila/latest/admin/share_replication.html Update "used_size" of shares ----------------------------