openstack/openstack-manuals
Code Issues Proposed changes

Move subsections inside the section

Browse Source 
When I updated the VMAX Cinder driver doc, I put subsections
outside of the section that referenced them. The published doc
doesn't look right. This patch is to move subsections inside
the section.

Here is how the VMAX doc looks like currently:

http://docs.openstack.org/trunk/config-reference/content/emc-vmax-driver.html

The following links are displayed at the top of the doc:

System requirements
Supported operations
Install the python-pywbem package
Set up SMI-S
cinder.conf configuration file
cinder_emc_config_CONF_GROUP_ISCSI.xml configuration file
FC Zoning with VMAX
iSCSI with VMAX
Set up the VMAX drivers
VMAX masking view and group naming info
Concatenated or striped volumes

As shown above, links to the sub-sections inside the "Set up the VMAX
drivers" section also showed up in the beginning.

The purpose of this patch is to hide the sub-sections inside the
"Set up the VMAX drivers" section, so that only the following links
showing up in the beginning of the doc:

System requirements
Supported operations
Set up the VMAX drivers
VMAX masking view and group naming info
Concatenated or striped volumes

Change-Id: I952386116f696c59412291d1f89afd7f9220d678
This commit is contained in:
Xing Yang 2014-10-04 23:49:41 -04:00
parent 636df08a60
commit 61b12bd2cf
1 changed files with 29 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
doc/config-reference/block-storage/drivers/emc-vmax-driver.xml
View File

@ -73,6 +73,35 @@
</listitem>
</itemizedlist>
</section>
<section xml:id="emc-prep">
<?dbhtml stop-chunking?>
<title>Set up the VMAX drivers</title>
<procedure>
<title>To set up the EMC VMAX drivers</title>
<step>
<para>Install the <package>python-pywbem</package>
package for your distribution. See <xref
linkend="install-pywbem"/>.</para>
</step>
<step>
<para>Download SMI-S from PowerLink and install it.
Add your VMAX arrays to SMI-S.</para>
<para>For information, see <xref
linkend="setup-smi-s"/> and the SMI-S release
notes.</para>
</step>
<step>
<para>Change configuration files. See <xref
linkend="emc-config-file"/> and <xref
linkend="emc-config-file-2"/>.</para>
</step>
<step>
<para>Configure connectivity. For FC driver,
see <xref linkend="configuring-connectivity-fc"/>.
For iSCSI driver, see <xref
linkend="configuring-connectivity-iscsi"/>.</para>
</step>
</procedure>
<section xml:id="install-pywbem">
<title>Install the <package>python-pywbem</package>
package</title>
@ -271,34 +300,6 @@ volume_backend_name=FC_backend</programlisting>
</listitem>
</itemizedlist>
</section>
<section xml:id="emc-prep">
<title>Set up the VMAX drivers</title>
<procedure>
<title>To set up the EMC VMAX drivers</title>
<step>
<para>Install the <package>python-pywbem</package>
package for your distribution. See <xref
linkend="install-pywbem"/>.</para>
</step>
<step>
<para>Download SMI-S from PowerLink and install it.
Add your VMAX arrays to SMI-S.</para>
<para>For information, see <xref
linkend="setup-smi-s"/> and the SMI-S release
notes.</para>
</step>
<step>
<para>Change configuration files. See <xref
linkend="emc-config-file"/> and <xref
linkend="emc-config-file-2"/>.</para>
</step>
<step>
<para>Configure connectivity. For FC driver,
see <xref linkend="configuring-connectivity-fc"/>.
For iSCSI driver, see <xref
linkend="configuring-connectivity-iscsi"/>.</para>
</step>
</procedure>
</section>
<section xml:id="vmax-masking-view-and-group-naming">
<title>VMAX masking view and group naming info</title>