doc migration: new directory layout
This patch introduces a new directory layout
in doc/source in conformance with the OpenStack
manuals project migration spec [1], moves the
existing content in manila/doc/source into the
new directories, and adjusts index files accordingly.
This is the first step in the migration process
as outlined in the spec.
[1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partial-Bug: #1706181
Needed-By: Iac9a0180a8b1a45f6f1d84020c6d15f457ad92bf
Depends-On: I92cc896bbd505d10c9dc7101bacb4caedf43da8f
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I9c378a188f9009a82100f5488a936d43536bd5b6
(cherry picked from commit b7fb1dd1c8
)
This commit is contained in:
parent
b1605a4980
commit
bea1efa689
|
@ -118,7 +118,7 @@ expected to redefine enabled_share_protocols as follows:
|
||||||
'enabled_share_protocols': ['NFS'],
|
'enabled_share_protocols': ['NFS'],
|
||||||
}
|
}
|
||||||
|
|
||||||
Contributing
|
New Features
|
||||||
------------
|
------------
|
||||||
|
|
||||||
When implementing a new feature, you may think about making it optional,
|
When implementing a new feature, you may think about making it optional,
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
============
|
============
|
||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
.. include:: ../../../CONTRIBUTING.rst
|
|
@ -0,0 +1 @@
|
||||||
|
.. include:: ../../../README.rst
|
|
@ -4,17 +4,17 @@
|
||||||
contain the root `toctree` directive.
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
Welcome to manila-ui's documentation!
|
Welcome to manila-ui's documentation!
|
||||||
========================================================
|
=====================================
|
||||||
|
|
||||||
Contents:
|
Contents:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
readme
|
contributor/readme
|
||||||
installation
|
install/installation
|
||||||
usage
|
user/usage
|
||||||
contributing
|
contributor/contributing
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
==================
|
||||||
|
|
|
@ -1 +0,0 @@
|
||||||
.. include:: ../../README.rst
|
|
|
@ -1,7 +1,7 @@
|
||||||
========
|
=====
|
||||||
Usage
|
Usage
|
||||||
========
|
=====
|
||||||
|
|
||||||
To use manila-ui in a project::
|
To use manila-ui in a project::
|
||||||
|
|
||||||
import manila_ui
|
import manila_ui
|
Loading…
Reference in New Issue