Update docs to fix broken links
We still left lots of broken links in the docs, this change is to fix them. Change-Id: I4965489974ffa24e62f04fc1c995d1c7017e1291
This commit is contained in:
parent
b0b4684994
commit
17ed3e0455
@ -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
|
filtering. The scheduler can only create a share on a back end that
|
||||||
reports capabilities that match the un-scoped extra-spec keys for
|
reports capabilities that match the un-scoped extra-spec keys for
|
||||||
the share type. For details, see `Capabilities and Extra-Specs
|
the share type. For details, see `Capabilities and Extra-Specs
|
||||||
<https://docs.openstack.org/manila/latest/contributor/
|
<https://docs.openstack.org/manila/latest/admin/
|
||||||
capabilities_and_extra_specs.html>`_.
|
capabilities_and_extra_specs.html>`_.
|
||||||
|
|
||||||
Each driver implementation determines which extra specification
|
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
|
Each driver implementation determines which extra specification
|
||||||
keys it uses. For details, see `Capabilities and Extra-Specs
|
keys it uses. For details, see `Capabilities and Extra-Specs
|
||||||
<https://docs.openstack.org/manila/latest/contributor/
|
<https://docs.openstack.org/manila/latest/admin/
|
||||||
capabilities_and_extra_specs.html>`_ and documentation for your driver.
|
capabilities_and_extra_specs.html>`_ and documentation for your driver.
|
||||||
|
|
||||||
Normal response codes: 200
|
Normal response codes: 200
|
||||||
|
@ -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
|
For the example, the Generic driver with the Block Storage service as a
|
||||||
back-end doesn't support ``user`` and ``cert`` authentications methods. For
|
back-end doesn't support ``user`` and ``cert`` authentications methods. For
|
||||||
details of supporting of features by different drivers, see `Manila share
|
details of supporting of features by different drivers, see `Manila share
|
||||||
features support mapping <https://docs.openstack.org/manila/latest/contributor
|
features support mapping <https://docs.openstack.org/manila/latest/admin
|
||||||
/share_back_ends_feature_support_mapping.html>`_.
|
/share_back_ends_feature_support_mapping.html>`_.
|
||||||
|
|
||||||
To verify that the access rules (ACL) were configured correctly for a share,
|
To verify that the access rules (ACL) were configured correctly for a share,
|
||||||
|
@ -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
|
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.
|
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
|
For more information about extra-specs and their type, see `Capabilities
|
||||||
and Extra-Specs <https://docs.openstack.org/manila/latest/contributor
|
and Extra-Specs <https://docs.openstack.org/manila/latest/admin
|
||||||
/capabilities_and_extra_specs.html>`_ section in developer documentation.
|
/capabilities_and_extra_specs.html>`_ section in developer documentation.
|
||||||
|
|
||||||
The general scheduler workflow:
|
The general scheduler workflow:
|
||||||
|
@ -172,8 +172,8 @@ Dos and Don'ts
|
|||||||
* OpenStack prefers atomic changes. So remember that your change may need the
|
* OpenStack prefers atomic changes. So remember that your change may need the
|
||||||
fewest sections possible
|
fewest sections possible
|
||||||
* General writing guidelines can be found
|
* General writing guidelines can be found
|
||||||
`here <http://docs.openstack
|
`here <https://docs.openstack
|
||||||
.org/contributor-guide/writing-style/general-writing-guidelines.html>`_
|
.org/doc-contrib-guide/writing-style/general-writing-guidelines.html>`_
|
||||||
* Proofread your note. Pretend you are a user or a deployer who is reading
|
* 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
|
the note after a milestone or a release has been cut
|
||||||
|
|
||||||
|
@ -26,9 +26,8 @@ OpenStack User Guide
|
|||||||
is available on ``python-manilaclient`` and/or ``manila-ui``.
|
is available on ``python-manilaclient`` and/or ``manila-ui``.
|
||||||
- If you develop an end user facing feature, you need to provide an
|
- 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.
|
overview, use cases and example work-flows as part of this documentation.
|
||||||
- **Link**: `User guide <http://docs.openstack.org/user-guide/>`_
|
- The source files for the user guide live in manila's code tree.
|
||||||
- **Repository**: The user guide is maintained within the
|
- **Link**: `User guide <https://docs.openstack.org/manila/latest/user/>`_
|
||||||
`OpenStack Manuals project <https://github.com/openstack/openstack-manuals>`_
|
|
||||||
|
|
||||||
|
|
||||||
OpenStack Administrator Guide
|
OpenStack Administrator Guide
|
||||||
@ -39,9 +38,8 @@ OpenStack Administrator Guide
|
|||||||
for utilizing a feature, along with managing and troubleshooting manila
|
for utilizing a feature, along with managing and troubleshooting manila
|
||||||
when the feature is used.
|
when the feature is used.
|
||||||
- Relevant configuration options may be mentioned here briefly.
|
- Relevant configuration options may be mentioned here briefly.
|
||||||
- **Link**: `Administrator guide <http://docs.openstack.org/admin-guide/>`_
|
- The source files for the administrator guide live in manila's code tree.
|
||||||
- **Repository**: The administrator guide is maintained within the
|
- **Link**: `Administrator guide <https://docs.openstack.org/manila/latest/admin/>`_
|
||||||
`OpenStack Manuals project <https://github.com/openstack/openstack-manuals>`_
|
|
||||||
|
|
||||||
|
|
||||||
OpenStack Configuration Reference
|
OpenStack Configuration Reference
|
||||||
@ -54,10 +52,9 @@ OpenStack Configuration Reference
|
|||||||
configuration options.
|
configuration options.
|
||||||
- If you are a driver maintainer, please ensure that your driver and all of
|
- If you are a driver maintainer, please ensure that your driver and all of
|
||||||
its relevant configuration is documented here.
|
its relevant configuration is documented here.
|
||||||
- **Link**: `Mitaka release configuration reference
|
- The source files for the configuration guide live in manila's code tree.
|
||||||
<http://docs.openstack.org/mitaka/config-reference/>`_
|
- **Link**: `Manila release configuration reference
|
||||||
- **Repository**: The configuration reference is maintained within the
|
<https://docs.openstack.org/manila/latest/configuration/index.html>`_
|
||||||
`OpenStack Manuals project <https://github.com/openstack/openstack-manuals>`_
|
|
||||||
|
|
||||||
|
|
||||||
OpenStack Installation Tutorial
|
OpenStack Installation Tutorial
|
||||||
@ -70,7 +67,7 @@ OpenStack Installation Tutorial
|
|||||||
- The instructions are written with reference to different distributions.
|
- The instructions are written with reference to different distributions.
|
||||||
- The source files for this tutorial live in manila's code tree.
|
- The source files for this tutorial live in manila's code tree.
|
||||||
- **Link**: `Draft installation tutorial
|
- **Link**: `Draft installation tutorial
|
||||||
<http://docs.openstack.org/project-install-guide/shared-file-systems/draft/>`_
|
<https://docs.openstack.org/project-install-guide/shared-file-systems/draft/>`_
|
||||||
|
|
||||||
OpenStack API Reference
|
OpenStack API Reference
|
||||||
-----------------------
|
-----------------------
|
||||||
@ -84,7 +81,7 @@ OpenStack API Reference
|
|||||||
- Since the Newton release, manila's API reference is maintained
|
- Since the Newton release, manila's API reference is maintained
|
||||||
in-tree in custom YAML/JSON format files.
|
in-tree in custom YAML/JSON format files.
|
||||||
- **Link**: `REST API reference of the Shared File Systems Project v2.0
|
- **Link**: `REST API reference of the Shared File Systems Project v2.0
|
||||||
<http://developer.openstack.org/api-ref/shared-file-systems/>`_
|
<https://developer.openstack.org/api-ref/shared-file-system/>`_
|
||||||
|
|
||||||
Manila Developer Reference
|
Manila Developer Reference
|
||||||
--------------------------
|
--------------------------
|
||||||
@ -123,10 +120,7 @@ OpenStack Command Line Reference
|
|||||||
- No manual corrections are allowed on this repository; make necessary
|
- No manual corrections are allowed on this repository; make necessary
|
||||||
corrections in the ``python-manilaclient`` repository."
|
corrections in the ``python-manilaclient`` repository."
|
||||||
- **Link**: `Manila CLI reference
|
- **Link**: `Manila CLI reference
|
||||||
<http://docs.openstack.org/cli-reference/manila.html>`_
|
<https://docs.openstack.org/python-openstackclient/latest/>`_.
|
||||||
- **Repository**: The CLI reference is maintained within the
|
|
||||||
`OpenStack Manuals project
|
|
||||||
<https://github.com/openstack/openstack-manuals>`_.
|
|
||||||
|
|
||||||
|
|
||||||
Important things to note
|
Important things to note
|
||||||
@ -147,11 +141,11 @@ Important things to note
|
|||||||
service`` and not the service type (``share``) or the project name
|
service`` and not the service type (``share``) or the project name
|
||||||
(``manila``).
|
(``manila``).
|
||||||
- Follow documentation styles prescribed in the `OpenStack Documentation
|
- Follow documentation styles prescribed in the `OpenStack Documentation
|
||||||
Contributor Guide <http://docs.openstack.org/contributor-guide/>`_. Pay
|
Contributor Guide <https://docs.openstack.org/doc-contrib-guide/>`_. Pay
|
||||||
heed to the `RST formatting conventions
|
heed to the `RST formatting conventions
|
||||||
<http://docs.openstack.org/contributor-guide/rst-conv.html>`_
|
<https://docs.openstack.org/doc-contrib-guide/rst-conv.html>`_
|
||||||
and `Writing style
|
and `Writing style
|
||||||
<http://docs.openstack.org/contributor-guide/writing-style.html>`_.
|
<https://docs.openstack.org/doc-contrib-guide/writing-style.html>`_.
|
||||||
- Use CamelCase to spell out `OpenStack` and sentence casing to
|
- Use CamelCase to spell out `OpenStack` and sentence casing to
|
||||||
spell out service types, ex: `Shared File Systems service` and lower case
|
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
|
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
|
built with every commit in the respective codebase. Therefore, documentation
|
||||||
added here need not be backported to previous releases.
|
added here need not be backported to previous releases.
|
||||||
- You may backport changes to some documentation such as the configuration
|
- 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.
|
||||||
<http://docs.openstack.org/contributor-guide/additional-git-workflow/
|
|
||||||
backport.html>`_.
|
|
||||||
- **Important "documentation" that isn't really documentation** - ``specs`` and
|
- **Important "documentation" that isn't really documentation** - ``specs`` and
|
||||||
``release notes`` are *NOT* documentation. A specification document is
|
``release notes`` are *NOT* documentation. A specification document is
|
||||||
written to initiate a dialogue and gather feedback regarding the
|
written to initiate a dialogue and gather feedback regarding the
|
||||||
|
@ -220,7 +220,7 @@ report the ``replication_type`` they support as a capability and implement
|
|||||||
necessary methods.
|
necessary methods.
|
||||||
|
|
||||||
More details can be found at:
|
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
|
Update "used_size" of shares
|
||||||
----------------------------
|
----------------------------
|
||||||
|
Loading…
Reference in New Issue
Block a user