doc: Restructure docs for doc-migration

We have three populated sections:

- install
- user
- reference

There are three docs removed, as they served little useful purpose and
were mostly unreferenced.

Sphinx's 'warning-is-error' option is enabled to catch the few issues
that has snuck into the docs.

Change-Id: I04e426faf337f0b03175f439c80b3369d4066733
This commit is contained in:
Stephen Finucane
2017-08-04 16:10:43 +01:00
parent f3eb28dcf6
commit 4fc0a51a17
15 changed files with 89 additions and 106 deletions

View File

@@ -0,0 +1,38 @@
========
Tutorial
========
This tutorial is intended as an introduction to working with **os-brick**.
Prerequisites
-------------
Before we start, make sure that you have the **os-brick** distribution
:doc:`installed </install/index>`. In the Python shell, the following should
run without raising an exception:
.. code-block:: bash
>>> import os_brick
Fetch all of the initiator information from the host
----------------------------------------------------
An example of how to collect the initiator information that is needed to export
a volume to this host.
.. code-block:: python
from os_brick.initiator import connector
# what helper do you want to use to get root access?
root_helper = "sudo"
# The ip address of the host you are running on
my_ip = "192.168.1.1"
# Do you want to support multipath connections?
multipath = True
# Do you want to enforce that multipath daemon is running?
enforce_multipath = False
initiator = connector.get_connector_properties(root_helper, my_ip,
multipath,
enforce_multipath)