Fix last typos and remarks in developers guide

Also User guide was filled in with screenshots and updated with new information.

Change-Id: I5e2592087c142202fe03db2123d0fe91dd9669de

src/developers-guide/src/docbkx/content/installation-guide.xml

@@ -85,7 +85,7 @@
                     <para>Superuser privileges is required to install and configure system packages. Let's switch to root account:</para>
                     <programlisting>
                         <![CDATA[
-sudo su
+sudo su -
                         ]]>
                     </programlisting>
                 </listitem>
@@ -284,9 +284,9 @@ initctl start murano-api
             <title>Install</title>
             <itemizedlist spacing="compact">
                 <listitem>
-                    <para>Murano Condutor uses OpenStack Heat for new virtual machines creation, therefore Heat should
+                    <para>Murano Conductor uses OpenStack Heat for new virtual machines creation, therefore Heat should
                         been installed and configured. Some services require the Internet access for virtual machines to
-                        successfull deployment.
+                        successful deployment.
                     </para>
                     <para>The detailed information about Heat configuration is described
                         <link xlink:href="http://docs.openstack.org/developer/heat/getting_started/index.html">here.
@@ -306,7 +306,7 @@ initctl start murano-api
                     <para>Superuser privileges is required to install and configure system packages. Let's switch to root account:</para>
                     <programlisting>
                         <![CDATA[
-sudo su
+sudo su -
                         ]]>
                     </programlisting>
                 </listitem>
@@ -478,7 +478,7 @@ initctl start murano-conductor
                     <para>Superuser privileges is required to install and configure system packages. Let's switch to root account:</para>
                     <programlisting>
                         <![CDATA[
-sudo su
+sudo su -
                         ]]>
                     </programlisting>
                 </listitem>
@@ -516,6 +516,10 @@ sh setup-centos.sh install
     </section>
     <section xml:id="ssl">
         <title>SSL configuration</title>
+        <para>
+            Murano components are able to work with SSL. This chapter will
+            help your to make proper settings with SSL configuration.
+        </para>
         <section>
             <title>HTTPS for Murano API</title>
             <para>

src/developers-guide/src/docbkx/content/knownissues.xml

@@ -52,11 +52,13 @@
             <para>
                 Farm services can't be deployed without KeyPair. If KeyPair is not set
                 load balancer won't be created and these messages will show up in logs:
+                <programlisting>
+                <![CDATA[
 2013-08-06 09:10:07 - Unable to deploy instance ipkrmhk0vzq4b6 (asp-farm_instance_0) due to Unexpected state
 2013-08-06 09:10:07 - Unable to create a Server Farm load balancer on unit ipkrmhk0vzq4b6 (asp-farm_instance_0) due to Unexpected state
+]]>             </programlisting>
                 And deploy will hang up.
             </para>
         </listitem>
     </itemizedlist>
-
 </chapter>

src/developers-guide/src/docbkx/content/overview.xml

@@ -23,6 +23,10 @@
       version="5.0">
     <title>Overview</title>
     <para>Welcome to Murano Project.
+        Full information about Murano you can found information in openstack wiki
+         <link xlink:href="https://wiki.openstack.org/wiki/Murano"> page.</link>
+    </para>
+    <para>
         Murano is intended to get opportunity for non-experienced
         users to deploy reliable Windows-based environments with 1-Click.
         Key goal is to provide UI and API which

src/developers-guide/src/docbkx/content/specification.xml

@@ -2664,7 +2664,7 @@
                     </tgroup>
                 </table>
                 <table frame="all">
-                    <title>ASP.NET Application Farm Unit Object</title>
+                    <title>MS SQL Server Unit Object</title>
                     <tgroup cols="4" align="left" colsep="1" rowsep="1">
                         <colspec colnum="1" colname="col1" colwidth="2*"/>
                         <colspec colnum="2" colname="col2" colwidth="1*"/>

src/developers-guide/src/docbkx/content/workflows.xml

@@ -159,8 +159,6 @@ For both list and map functions names of item nodes ("item" in examples above) i
     </section>
     <section>
         <title>Workflows</title>
-        <section>
-            <title>About workflows</title>
             <para>
                 Workflows are XML DSL scripts that describe the steps that conductor need to perform in order to deploy specified environment. All workflow constructs are just ordinary DSL functions similar to those described above.
             </para>
@@ -171,10 +169,12 @@ For both list and map functions names of item nodes ("item" in examples above) i
                 Actions are:
                 <itemizedlist>
                     <listitem>
+                        <para>
                         Heat commands that update or delete Heat Stack: <![CDATA[ <update-cf-stack>, <delete-cf-stack> ]]>
+                        </para>
                     </listitem>
                     <listitem>
-                        Send command to Murano Agent: <![CDATA[ <send-command> ]]>
+                        <para>Send command to Murano Agent: <![CDATA[ <send-command> ]]></para>
                     </listitem>
                     <listitem>
                         Report state to API: <![CDATA[ <report> ]]>
@@ -185,26 +185,31 @@ For both list and map functions names of item nodes ("item" in examples above) i
                 Workflow logic can be described in 6 steps:
                 <orderedlist>
                     <listitem>
-                        Choose a node (set of nodes) to update. If none of the nodes can be updated we are done.
+                        <para>
+                            Choose a node (set of nodes) to update. If none of the nodes can be updated we are done.
+                        </para>
                     </listitem>
                     <listitem>
-                        According to the current state of node (that is a part of input Object Model) choose appropriate command to execute (update Heat stack or issue PowerShell command)
+                        <para>
+                            According to the current state of node (that is a part of input Object Model) choose appropriate command to execute (update Heat stack or issue PowerShell command)
+                        </para>
                     </listitem>
                     <listitem>
-                        Select appropriate information from Object Model and substitute it into chosen template
+                        <para>
+                            Select appropriate information from Object Model and substitute it into chosen template
+                        </para>
                     </listitem>
                     <listitem>
-                        Execute command
+                        <para>Execute command</para>
                     </listitem>
                     <listitem>
-                        Update Object Model according to command execution result
+                        <para>Update Object Model according to command execution result</para>
                     </listitem>
                     <listitem>
-                        Go to step 1
+                        <para>Go to step 1</para>
                     </listitem>
                 </orderedlist>
             </para>
-        </section>
         <section>
             <title>Accessing Object Model</title>
             <para>Object Model is a definition of environment that Murano Conductor was asked to deploy.</para>

src/developers-guide/src/docbkx/developers-guide.xml

@@ -73,8 +73,6 @@
             contact
             Murano community directly by
             <link xlink:href="mailto:openstack-dev@lists.openstack.org">openstack-dev@lists.openstack.org</link>
-            (please, note that your email address should be registered in launchpad, otherwise your mail will be ignored
-            by mailing system).
         </para>
         <para>
             We’re going to hold public weekly meetings on Mondays at 15:00 UTC on #openstack-meeting-alt irc channel.

src/user-guide/src/docbkx/content/murano-dashboard.xml

@@ -0,0 +1,262 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2013 Mirantis, Inc.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<chapter xmlns="http://docbook.org/ns/docbook"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xmlns:xlink="http://www.w3.org/1999/xlink"
+      xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
+                          http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
+      version="5.0">
+    <title>Murano dashboard plugin</title>
+    <para>
+        For a Murano usage you should be familiar with Openstack. Murano Dashboard is just a plugin to Openstack dashboard - Horizon.
+        Please visit
+        <link xlink:href="http://docs.openstack.org/user-guide/content/"> horizon user guide </link>
+        first to see how dashboard is organized and how login to it.
+    </para>
+    <section>
+        <title>Creating environment</title>
+        <para> Once you installed all Murano components and login to horizon dashboard successfully you will see Environments panel:</para>
+        <mediaobject>
+            <imageobject role="fo">
+                <imagedata  fileref="../images/env_panel.png" />
+            </imageobject>
+        </mediaobject>
+        <para>
+            First you need to do is to create an environment - virtual Windows Data Center which will contain different Windows services.
+            Navigate to "Environments" page and click "Create Environment". After setting name to your virtual environment it will be created.
+            Just created environment has status <emphasis>Ready to configure</emphasis>.
+        </para>
+        <mediaobject>
+            <imageobject role="fo">
+                <imagedata fileref="../images/env_btn.png" />
+            </imageobject>
+        </mediaobject>
+    </section>
+    <section>
+        <title>Creating service prototype</title>
+        <para >
+            All services should be created within the framework of Environment
+            - virtual Windows Data Center. First you need to create one or more service's prototypes
+            and then send Environment to deploy process. After that one or more instances with your service be spawned on Openstack.
+            To create service prototype navigate to environment services by
+            clicking on environment name (or on "Services" button) and press on "Create Service" button.
+        </para>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/service_btn.png"/>
+                </imageobject>
+            </mediaobject>
+        <para>
+            You have opportunity to create one of the following services:
+        </para>
+        <mediaobject>
+            <imageobject role="fo">
+                <imagedata fileref="../images/service_list.png"/>
+            </imageobject>
+        </mediaobject>
+        <para>
+            Once you choose service that you want to create click "Next" and fill the form.
+            Forms for each service are specific.
+            To see more information about filling the form for a specified service follow one of the link below:
+        </para>
+        <itemizedlist>
+            <listitem>
+                <para>
+                    <emphasis role="bold"><link linkend="AD">Active Directory:</link></emphasis>
+                    Active Directory is a directory service implemented by Microsoft for Windows domain networks.
+                    In one installation in addition to primary Domain Controller
+                    you can add optional count of secondary Domain Controllers.
+                    Any other services you are intending to create can be
+                    joined to that domain.
+            </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis role="bold">
+                        <link linkend="IIS">Internet Information Service:</link></emphasis>
+                    IIS is a web server and a set of feature extension modules.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis role="bold">
+                        <link linkend="IISfarm">Internet Information Web Farm Service:</link>
+                    </emphasis>
+                    Murano installs the Web Farm Framework on the controller server,
+                    configures the primary server and prepares the secondary servers.
+                    In addition load balancer is installed to monitor service statuses.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis role="bold">
+                        <link linkend="ASP">ASP.NET Service:</link>
+                    </emphasis>
+                    is a server-side Web application framework designed for Web
+                    development to produce dynamic Web pages. Service is able
+                    to install custom application onto one IIS Web Server. Murano installs
+                    all needed components and make proper configuration.
+            </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis role="bold">
+                        <link linkend="ASPfarm">ASP.NET Farm Service:</link>
+                    </emphasis>
+                    ASP.NET Farm Service installs a custom application on a
+                    load-balanced array of IIS servers
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis role="bold"><link linkend="SQL">MS SQL Service:</link></emphasis>
+                    Microsoft SQL Service is a relational database management system.
+                </para>
+            </listitem>
+            <listitem>
+                <para>
+                    <emphasis role="bold">
+                        <link linkend="SQLfarm">SQL Server Failover Cluster:</link>
+                    </emphasis>
+                    Murano installs all needed components and configures your
+                    SQL Server Cluster the way you want.
+                </para>
+            </listitem>
+        </itemizedlist>
+        <para>
+            On the last step of creating service prototype you have opportunity to set
+            the hardware flavor of the instance which will be created -
+            and the image with the operating system, which will be installed on
+            the instance. Also you may select availability zone, if there are more
+            then one in your environment.
+        </para>
+        <mediaobject>
+            <imageobject role="fo">
+                <imagedata fileref="../images/last_step.png"/>
+            </imageobject>
+        </mediaobject>
+        <section  xml:id="AD">
+            <title>Active Directory</title>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/ad.png"/>
+                </imageobject>
+            </mediaobject>
+        </section>
+        <section xml:id="IIS">
+            <title>Internet Information Service</title>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/iis.png"/>
+                </imageobject>
+            </mediaobject>
+        </section>
+        <section xml:id="IISfarm">
+            <title>Internet Information Web Farm Service</title>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/iis_farm.png"/>
+                </imageobject>
+            </mediaobject>
+        </section>
+        <section xml:id="ASP">
+            <title>ASP.NET Service</title>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/asp_net.png"/>
+                </imageobject>
+            </mediaobject>
+        </section>
+        <section xml:id="ASPfarm">
+            <title>ASP.NET Farm Service</title>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/asp_net_farm.png"/>
+                </imageobject>
+            </mediaobject>
+        </section>
+        <section xml:id="SQL">
+            <title>MS SQL Service</title>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/sql.png"/>
+                </imageobject>
+            </mediaobject>
+        </section>
+        <section xml:id="SQLfarm">
+            <title>SQL Server Failover Cluster</title>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/cluster1.png"/>
+                </imageobject>
+            </mediaobject>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/cluster1a.png"/>
+                </imageobject>
+            </mediaobject>
+            <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/cluster2.png"/>
+                </imageobject>
+            </mediaobject>
+        </section>
+    </section>
+    <section>
+        <title>Deploying environment</title>
+        <para>
+            Once all services are prepared you can send environment to deploy
+            and wait while Murano installing and configuring your services.
+            Just press the "Deploy Environment" button.
+        </para>
+        <mediaobject>
+                <imageobject role="fo">
+                    <imagedata fileref="../images/deploy_btn.png"/>
+                </imageobject>
+        </mediaobject>
+        <para>
+            You can monitor deploying process. Just go to the Log tab on service
+            detailed page where you can get by clicking on the service name.
+        </para>
+        <mediaobject>
+            <imageobject role="fo">
+                <imagedata fileref="../images/service_name.png"/>
+            </imageobject>
+        </mediaobject>
+        <para>
+            And now you can see installation progress.
+        </para>
+        <mediaobject>
+            <imageobject role="fo">
+                <imagedata fileref="../images/logs.png"/>
+            </imageobject>
+        </mediaobject>
+
+        <para>
+            Until installation finished environment are in deployng state.
+        </para>
+    </section>
+    <section>
+        <title>Detailed information</title>
+        <mediaobject>
+            <imageobject role="fo">
+                <imagedata fileref="../images/iis_farm_detail.png"/>
+            </imageobject>
+        </mediaobject>
+</section>
+</chapter>

src/user-guide/src/docbkx/content/overview.xml

@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright (c) 2013 Mirantis, Inc.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<chapter xmlns="http://docbook.org/ns/docbook"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xmlns:xlink="http://www.w3.org/1999/xlink"
+      xsi:schemaLocation="http://docbook.org/ns/docbook http://www.docbook.org/xml/5.0/xsd/docbook.xsd
+                          http://www.w3.org/1999/xlink http://www.w3.org/1999/xlink.xsd"
+      version="5.0">
+    <title>How can I use Murano Service?</title>
+    <para>
+        Murano is intended to get opportunity for non-experienced
+        users to deploy reliable Windows-based environments with 1-Click.
+        This document describes steps for creation Windows Environment with different services.
+        You'll see how it's easy with Murano.
+    </para>
+    <section>
+        <title>Document change history</title>
+        <para>The following table describes the most recent changes:</para>
+        <informaltable rules="all">
+            <thead>
+                <tr>
+                    <td align="center" colspan="1">Revision Date</td>
+                    <td align="center" colspan="4">Summary of Changes</td>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td colspan="1" align="center">September. 4, 2013</td>
+                    <td colspan="4">
+                        <itemizedlist>
+                            <listitem>
+                                <para>Initial document creation.</para>
+                            </listitem>
+                        </itemizedlist>
+                    </td>
+                </tr>
+            </tbody>
+        </informaltable>        
+    </section>
+
+</chapter>