Update installation tutorial and api-ref instructions

This documentation has been brought in-tree in Newton.

TrivialFix

Change-Id: I943b55b22d23a1b84a886746852165656c5aa01e
This commit is contained in:
Goutham Pacha Ravi 2016-09-08 18:19:08 -04:00
parent a7dc61e425
commit d2f1d289e9

View File

@ -60,35 +60,17 @@ OpenStack Configuration Reference
`OpenStack Manuals project <https://github.com/openstack/openstack-manuals>`_ `OpenStack Manuals project <https://github.com/openstack/openstack-manuals>`_
OpenStack Installation Guide OpenStack Installation Tutorial
---------------------------- -------------------------------
- Instructions regarding setting up manila on OpenStack need to be documented - Instructions regarding setting up manila on OpenStack need to be documented
here. here.
- This guide covers step-by-step deployment of OpenStack services using a - This tutorial covers step-by-step deployment of OpenStack services using a
functional example architecture suitable for new users of OpenStack with functional example architecture suitable for new users of OpenStack with
sufficient Linux experience. sufficient Linux experience.
- The instructions are written together, but with the help of tags are - The instructions are written with reference to different distributions.
separated out into per-distro installation guides for hosting on the - The source files for this tutorial live in manila's code tree.
documentation website. - **Link**: `Draft installation tutorial
- The installation instructions for manila in the Mitaka release lived <http://docs.openstack.org/project-install-guide/shared-file-systems/draft/>`_
alongside the major projects in the installation guide. However, with the
Newton release, the install guide will be part of manila's code tree.
- **Links**:
- `Mitaka installation guide for openSUSE and SLES
<http://docs.openstack.org/mitaka/install-guide-obs/>`_
- `Mitaka installation guide for Red Hat Enterprise Linux and CentOS
<http://docs.openstack.org/mitaka/install-guide-rdo/>`_
- `Mitaka installation guide for Ubuntu 14.04
<http://docs.openstack.org/mitaka/install-guide-ubuntu/>`_
- **Repository**: The installation guide is maintained within the
`OpenStack Manuals project
<https://github.com/openstack/openstack-manuals>`_. However, with the
Newton release, manila's install guide will live in its project tree.
.. TODO(gouthamr): add actual links and repo instructions when available.
OpenStack API Reference OpenStack API Reference
----------------------- -----------------------
@ -97,23 +79,12 @@ OpenStack API Reference
expected HTTP response codes as part of the API reference. expected HTTP response codes as part of the API reference.
- For releases prior to Newton, the API reference was maintained in `Web - For releases prior to Newton, the API reference was maintained in `Web
Application Description Language (WADL) Application Description Language (WADL)
<https://en.wikipedia.org/wiki/Web_Application_Description_Language>`_ <https://en.wikipedia.org/wiki/Web_Application_Description_Language>`_ in
- Starting with the Newton release, manila's API reference will be maintained the `api-site <https://github.com/openstack/api-site>`_ project.
- 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.
- **Links**: - **Link**: `REST API reference of the Shared File Systems Project v2.0
<http://developer.openstack.org/api-ref/shared-file-systems/>`_
- `REST API reference of the Shared File Systems Project v1.0
<http://developer.openstack.org/api-ref-share-v1.html>`_
- `REST API reference of the Shared File Systems Project v2.0
<http://developer.openstack.org/api-ref-share-v2.html>`_
- **Repository**: The API reference is maintained within the
`OpenStack API Site repository
<https://github.com/openstack/api-site>`_. However, with the Newton release,
manila's API reference will live in its project tree.
.. TODO(gouthamr): add actual links and repo instructions when available.
Manila Developer Reference Manila Developer Reference
-------------------------- --------------------------
@ -133,7 +104,7 @@ Manila Developer Reference
OpenStack Security Guide OpenStack Security Guide
------------------------- ------------------------
- Any feature that has a security impact needs to be documented here. - Any feature that has a security impact needs to be documented here.
- In general, administrators will follow the guidelines regarding best - In general, administrators will follow the guidelines regarding best
practices of setting up their manila deployments with this guide. practices of setting up their manila deployments with this guide.