Merge "GettingStarted: fix some typo"

5 files changed, 131 insertions, 126 deletions

diff --git a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml
index d0e25b5..255cfbe 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml
@@ -311,13 +311,13 @@
 
           <listitem>
             <para>When prompted by the following UI, make sure the
-            <literal>VNF Package</literal> radio button is selected. </para>
+            <literal>VNF Package</literal> radio button is selected.</para>
           </listitem>
 
           <listitem>
-            <para> Click <literal>Choose File</literal> and choose the VNF
+            <para>Click <literal>Choose File</literal> and choose the VNF
             Package ZIP archive, e.g <literal>VProbe.zip</literal>, which
-            represents the VNF bundle. </para>
+            represents the VNF bundle.</para>
           </listitem>
 
           <listitem>
@@ -402,7 +402,7 @@
 
           <listitem>
             <para><emphasis role="bold">Memory in MB.</emphasis> This is the
-            amount of memory (in Megabytes) that will be provided to this type
+            amount of memory (in megabytes) that will be provided to this type
             of VNF when it is instantiated. To determine the value for this
             field, consult the VNF vendor.</para>
           </listitem>
@@ -435,7 +435,7 @@
         </figure>
 
         <para>Click on the <literal>Interfaces</literal> tab to show the
-        Interfaces table. </para>
+        Interfaces table.</para>
 
         <para>This table will contain the interfaces required by this VNF to
         be configured, when creating an instance. Consult the VNF vendor to
@@ -445,8 +445,8 @@
 
         <para><emphasis role="bold">Cloud-Init Tab</emphasis></para>
 
-        <para>You must provide Clout-Init configuration for the VNF. Click the
-        <literal>Clout Init</literal> tab.</para>
+        <para>Click the <literal>Clout Init</literal> tab to provide the
+        Clout-Init configuration.</para>
 
         <figure>
           <title>Cloud-Init Tab</title>
@@ -459,36 +459,42 @@
           </mediaobject>
         </figure>
 
-       <para>Shown in the picture above are three fields that need to be populated:
-       Cloud-Init Datasource, Cloud-Init Disk Type and the Content Files Table.</para>
-
-       <para>To onboard the VNF you must specify the Cloud-Init datasource that the VNF
-       uses. You can get this information from the VNF Vendor. Choose one of the following
-       methods to specify the datasource:</para>
-
-        <itemizedlist>
-          <listitem>
-           <para><emphasis role="bold">ConfigDrive</emphasis>. This method allows you to provide
-           any number of content-data files containing Cloud-Init data.</para></listitem>
-           <listitem>
-  
-          <para><emphasis role="bold">NoCloud</emphasis>. This is a simpler method that uses only
-        one cloud init file (User-Data).</para></listitem>
-        </itemizedlist>
-
-        <para>The Cloud-Init Disk Type field must be set to either <literal>Disk</literal>,
-        or <literal>CD ROM</literal>, depending on what the VNF requires. You can get this
-        information from the VNF Vendor.</para>
-
-        <para>The Content Files Table is used ONLY if you chose <literal>ConfigDrive</literal>
-         as the Cloud-Init Datasource. For each content file added, you must provide a
-         <literal>Path</literal>. When a user uses the uCPE Manager to create an instance
-         of one of these VNFs, they will be prompted to provide a data file for each entry
-         in this table. Each type of VNF will require different cloud-init files, e.g.:
-         a license file.</para>
-
-        <para>Consult with the VNF vendor to determine what is required for the VNF you
-        are onboarding.</para>
+        <para>As shown in the picture above, there are three fields that need
+        to be populated: Cloud-Init Datasource, Cloud-Init Disk Type and the
+        Content Files Table.</para>
+
+        <para>To onboard the VNF you must specify the Cloud-Init datasource
+        that the VNF uses. You can get this information from the VNF Vendor.
+        Choose one of the following methods to specify the datasource:</para>
+
+        <itemizedlist>
+          <listitem>
+            <para><emphasis role="bold">ConfigDrive</emphasis>. This method
+            allows you to provide any number of content-data files containing
+            Cloud-Init data.</para>
+          </listitem>
+
+          <listitem>
+            <para><emphasis role="bold">NoCloud</emphasis>. This is a simpler
+            method that uses only one cloud init file (User-Data).</para>
+          </listitem>
+        </itemizedlist>
+
+        <para>The Cloud-Init Disk Type field must be set to either
+        <literal>Disk</literal>, or <literal>CD-ROM</literal>, depending on
+        what the VNF requires. You can get this information from the VNF
+        Vendor.</para>
+
+        <para>The Content Files Table is used ONLY if you chose
+        <literal>ConfigDrive</literal> as the Cloud-Init Datasource. For each
+        content file added, you must provide a <literal>Path</literal>. When a
+        user uses the uCPE Manager to create an instance of one of these VNFs,
+        they will be prompted to provide a data file for each entry in this
+        table. Each type of VNF will require different cloud-init files, e.g.:
+        a license file.</para>
+
+        <para>Consult with the VNF vendor to determine what is required for
+        the VNF you are onboarding.</para>
 
         <figure>
           <title>Content Files Table example</title>
@@ -504,13 +510,12 @@
         <para><emphasis role="bold">Properties Tab</emphasis></para>
 
         <para>In this table, you can enter values for properties that will be
-        used during instantiation of the VNF. The values will augment the default
-        values in the Domain.XML file used by libvert/virsh (running in NFV Access)
-        when creating an instance of the VNF.
-        These property names are well known to the uCPE NFV Access
-        software, and more will be added in future versions. You will need to
-        consult with the VNF Vendor or ENEA support for values needed by
-        specific VNFs.</para>
+        used during instantiation of the VNF. The values will augment the
+        default values in the Domain.XML file used by libvirt/virsh (running
+        in NFV Access) when creating an instance of the VNF. These property
+        names are well known to the uCPE NFV Access software, and more will be
+        added in future versions. You will need to consult with the VNF Vendor
+        or ENEA support for values needed by specific VNFs.</para>
 
         <figure>
           <title>Properties Tab</title>
@@ -526,21 +531,21 @@
         <para><emphasis role="bold">Property Values</emphasis></para>
 
         <para><literal>numHugePages</literal> defines the number of huge
-        memory pages the VNF uses (for DPDK). Needed for Clavister COS
-        Stream.</para>
+        memory pages the VNF uses (for DPDK).</para>
       </section>
     </section>
 
     <section id="instantiating_a_vnf">
       <title>Instantiating a VNF</title>
 
-        <para>Once the VNF bundle has been onboarded, you can instantiate a
-        VNF on a specific uCPE host:</para>
+      <para>Once the VNF bundle has been onboarded, you can instantiate a VNF
+      on a specific uCPE host:</para>
 
-        <para>Launch the <literal>VNF instance</literal> table by choosing the
-        <literal>Instances</literal> option from the <literal>VNF</literal> menu.
-        This will display the table of VNF instances controlled by the VNF Manager.
-        Hit the <literal>Add</literal> button to create a new instance, as shown below:</para>
+      <para>Launch the <literal>VNF instance</literal> table by choosing the
+      <literal>Instances</literal> option from the <literal>VNF</literal>
+      menu. This will display the table of VNF instances controlled by the VNF
+      Manager. Hit the <literal>Add</literal> button to create a new
+      instance:</para>
 
       <figure>
         <title>Instantiating a VNF</title>
@@ -558,33 +563,34 @@
 
       <itemizedlist>
         <listitem>
-          <para><emphasis role="bold">VNF Type</emphasis>. The
-          <literal>VProbe</literal> VNF, in this case.</para>
+          <para><emphasis role="bold">Name</emphasis>. The name of the
+          VNF.</para>
         </listitem>
 
         <listitem>
-          <para><emphasis role="bold">VIM</emphasis>. This stands for <literal>
-         Virtual Infrastructure Manager</literal>, the target host on which to
-         instantiate a VNF, i.e. the target uCPE host that will run this VNF.</para>
-
+          <para><emphasis role="bold">VNF Type</emphasis>. The name of the
+          on-boarded VNF bundle. In this case <literal>VProbe</literal>
+          VNF.</para>
         </listitem>
 
         <listitem>
-          <para><emphasis role="bold">Name</emphasis>. The name of the
-          VNF.</para>
+          <para><emphasis role="bold">Flavor</emphasis>. The flavor of VNF (as
+          specified in the descriptor) you would like to instantiate.</para>
         </listitem>
 
         <listitem>
-          <para><emphasis role="bold">VNF Flavor</emphasis>. The flavor of VNF
-          (as specified in the descriptor) you would like to
-          instantiate.</para>
+          <para><emphasis role="bold">VIM</emphasis>. This stands for
+          <literal> Virtual Infrastructure Manager</literal>, the target host
+          on which to instantiate a VNF, i.e. the target uCPE host that will
+          run this VNF.</para>
         </listitem>
 
         <listitem>
           <para><emphasis role="bold">Device Name</emphasis>. The name by
-          which the VNF will be known in the uCPE Manager, if the <literal>Manage
-          Device</literal> checkbox is checked. If unchecked, the VNF will not
-          be shown as a managed device in the uCPE Manager.</para>
+          which the VNF will be known in the uCPE Manager, if the
+          <literal>Manage Device</literal> checkbox is checked. If unchecked,
+          the VNF will not be shown as a managed device in the uCPE
+          Manager.</para>
         </listitem>
 
         <listitem>
@@ -595,17 +601,17 @@
           for two separate interfaces (enp0s9 and enp0s10 respectively). Every
           VNF type will have a different UI section here. This section is
           populated by the <literal>getInstanceGui()</literal> method in the
-          <literal>VnfGuiProcessorIf</literal>
-          interface, see Section 6.1 to understand exactly how the VProbe
-          method causes the above GUI section to be displayed.</para>
+          <literal>VnfGuiProcessorIf</literal> interface, see Section 6.1 to
+          understand exactly how the VProbe method causes the above GUI
+          section to be displayed.</para>
         </listitem>
 
         <listitem>
           <para><emphasis role="bold">Auto-start</emphasis>. If checked, the
           VNF will be stopped and started when unreachable. When the VIM
-          reports that it has lost connection to the VNF, the uCPE Manager will
-          ask the VIM to terminate the VM and then start it up again.
-          If unchecked, only a <literal>Disconnected</literal> notification will
+          reports that it has lost connection to the VNF, the uCPE Manager
+          will ask the VIM to terminate the VM and then start it up again. If
+          unchecked, only a <literal>Disconnected</literal> notification will
           appear in the uCPE Manager.</para>
         </listitem>
       </itemizedlist>
@@ -632,36 +638,35 @@
 
           <itemizedlist>
             <listitem>
-            <para><emphasis role="bold">Networking information.</emphasis>
-             Use the <literal>VnfGuiProcessorIf
-              </literal>class<literal> getConnectionInfo()</literal> method to
-              convert user parameters into networking information objects
-              (refer to Section 6.1 for the <literal>VProbe</literal>
-              VNF).</para>
+              <para><emphasis role="bold">Networking information.</emphasis>
+              Use the <literal>VnfGuiProcessorIf</literal> class<literal>
+              getConnectionInfo()</literal> method to convert user parameters
+              into networking information objects (refer to Section 6.1 for
+              the <literal>VProbe</literal> VNF).</para>
             </listitem>
           </itemizedlist>
 
           <itemizedlist>
             <listitem>
-              <para><emphasis role="bold">Cloud-init.</emphasis>
-               Use generic VNF instance information in
-              conjunction with the networking information objects from
-              above and invoke the <literal>getCloudInitData()</literal> method on the
-              <literal>VnfProcessorIf</literal> class (refer to Section 6.2 for how this is done
-              for the <literal>VProbe</literal> VNF). The cloud-init data is
-              the script that will be executed by the VNF when it starts up
-              for the first time only. It is responsible for setting up the
-              initial system configuration to what is required by the VNF to
-              run correctly, setting up the network interfaces, static IP
-              addresses, etc.</para>
+              <para><emphasis role="bold">Cloud-init.</emphasis> Use generic
+              VNF instance information in conjunction with the networking
+              information objects from above and invoke the
+              <literal>getCloudInitData()</literal> method on the
+              <literal>VnfProcessorIf</literal> class (refer to Section 6.2
+              for how this is done for the <literal>VProbe</literal> VNF). The
+              cloud-init data is the script that will be executed by the VNF
+              when it starts up for the first time only. It is responsible for
+              setting up the initial system configuration to what is required
+              by the VNF to run correctly, setting up the network interfaces,
+              static IP addresses, etc.</para>
             </listitem>
           </itemizedlist>
         </listitem>
 
         <listitem>
-          <para>Make the uCPE create the VNF with the specified image,
-          flavor and cloud-init data via a NETCONF request and waits for it to
-          be created and started up.</para>
+          <para>Make the uCPE create the VNF with the specified image, flavor
+          and cloud-init data via a NETCONF request and wait for the VNF to be
+          created and booted up.</para>
         </listitem>
 
         <listitem>
@@ -723,7 +728,7 @@
       this update.</para>
 
       <para>This step needs to be done each time the uCPE Manager host changes
-      the IP address.</para>
+      its IP address.</para>
     </note>
 
     <para>An offline configuration can be prepared in advance for the uCPE
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
index 9e574f6..748ef5c 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_nfv_access.xml
@@ -261,51 +261,47 @@ sdb            8:0            0     111.8G  0  disk
 
         <listitem>
           <para>Power up the board and boot the USB stick. Verify the USB
-          stick is selected from BIOS boot menu.</para>
+          stick is selected from the BIOS boot menu.</para>
         </listitem>
 
         <listitem>
           <para>Once the USB stick is properly booted, a GRUB menu appears on
           the serial console. The following options are available:</para>
 
-          <itemizedlist>
-            <para><emphasis role="bold">Using the serial
-            console</emphasis>:</para>
-
-            <listitem>
-              <para>live-boot serial. Boots NFV Access directly from the USB
-              stick.</para>
-            </listitem>
+          <figure>
+            <title>Installing NFV Access</title>
 
-            <listitem>
-              <para>installer serial. Launches NFV Access.</para>
-            </listitem>
-          </itemizedlist>
+            <mediaobject>
+              <imageobject>
+                <imagedata align="center"
+                           fileref="images/grub_menu_options.png" scale="75" />
+              </imageobject>
+            </mediaobject>
+          </figure>
 
           <itemizedlist>
-            <para><emphasis role="bold">Using the graphics
-            console:</emphasis></para>
-
             <listitem>
-              <para>live-boot graphical. Boots NFV Access directly from the
-              USB stick.</para>
+              <para>live-boot. Boots NFV Access directly from the USB stick. A
+              use case of the live-boot option is to troubleshoot networking
+              and boot on a new hardware. </para>
             </listitem>
 
             <listitem>
-              <para>installer graphical. Launches NFV Access.</para>
+              <para>installer. Launches the NFV Access installer and uses the
+              serial port for output.</para>
             </listitem>
           </itemizedlist>
 
           <note>
-            <para>A use case of the live-boot is to troubleshoot networking
-            and boot on a new hardware.</para>
+            <para>The graphical console requires that a display is connected
+            to the board.</para>
           </note>
         </listitem>
 
         <listitem>
-          <para>To launch the installer, select <command>installer</command>
-          from the GRUB menu. An installation menu will appear, containing the
-          following options:</para>
+          <para>To launch the installer, select one of the
+          <command>installer</command> options below from the GRUB
+          menu:</para>
 
           <itemizedlist>
             <listitem>
@@ -443,7 +439,7 @@ sdb            8:0            0     111.8G  0  disk
 
         <mediaobject>
           <imageobject>
-            <imagedata align="center" fileref="images/boot_ena.png" scale="85" />
+            <imagedata align="center" fileref="images/boot_ena.png" scale="75" />
           </imageobject>
         </mediaobject>
       </figure>
@@ -612,7 +608,7 @@ run</programlisting>
       <itemizedlist>
         <listitem>
           <para>2GB of memory: approximately 30% will be allocated for the OS
-           and the rest will be allocated as 2MB hugepages.</para>
+          and the rest will be allocated as 2MB hugepages.</para>
         </listitem>
 
         <listitem>
@@ -621,11 +617,15 @@ run</programlisting>
         </listitem>
 
         <listitem>
-          <para>16GB of memory: 2GB allocated for OS and  the rest as 1GB Hugepages.</para>
+          <para>16GB of memory: 2GB allocated for OS and the rest as 1GB
+          Hugepages.</para>
         </listitem>
       </itemizedlist>
-      <note><para>The memory allocated for the kernel and hugepages might
-       vary slightly depending on how much memory is available.</para></note>
+
+      <note>
+        <para>The memory allocated for the kernel and hugepages might vary
+        slightly depending on how much memory is available.</para>
+      </note>
     </section>
 
     <section id="hugepage_customizing_man">
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/add_a_device.png b/doc/book-enea-nfv-access-getting-started/doc/images/add_a_device.png
index cb240b6..8368e61 100755
--- a/doc/book-enea-nfv-access-getting-started/doc/images/add_a_device.png
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/add_a_device.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/images/grub_menu_options.png b/doc/book-enea-nfv-access-getting-started/doc/images/grub_menu_options.png
new file mode 100755
index 0000000..0ebf5f0
--- /dev/null
+++ b/doc/book-enea-nfv-access-getting-started/doc/images/grub_menu_options.png
diff --git a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml
index da6b2ee..0173ce6 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/in_band_management.xml
@@ -4,9 +4,8 @@
 <chapter id="in_band_managemen">
   <title>In-band Management</title>
 
-  <para>In-band Management refers to administrative access to systems and
-  network devices, over the same network used by the traffic being
-  filtered.</para>
+  <para>In-band Management refers to a model where both the data plane and
+  control plane flow over the same network path.</para>
 
   <para>In some situations, In-Band Management is the only option available to
   both control and configure the device, while also allowing for data-path
@@ -183,7 +182,8 @@
   </figure>
 
   <para>The VNF can be reached on the same IP address as the device, e.g.
-  <literal> https://&lt;WAN_IP&gt;</literal>.</para>
+  <literal> https://&lt;WAN_IP&gt;</literal> if a HTTP server is present
+   on that VNF.</para>
 
   <note>
     <para>The In-band management bridge must be recreated each time the uCPE