Restructuring Getting Started chapter in the User's Guide and fixing minor bugs in several other sections and documents

1 files changed, 156 insertions, 0 deletions

diff --git a/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml b/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
new file mode 100644
index 0000000..772d8e3
--- /dev/null
+++ b/doc/book-enea-linux-user-guide/doc/getting_enea_linux.xml
@@ -0,0 +1,156 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter>
+  <title id="gettingel">Getting Enea Linux</title>
+
+  <para>Enea Linux is available as both pre-built binary images and source
+  code. Both serve a specific purpose and each have their advantages. However,
+  using the pre-built binary images allows for getting up and running faster.
+  Please refer to the sections below for details on how to get Enea Linux as
+  pre-built binary images or source code.</para>
+
+  <section id="gettingbin">
+    <title>Getting Pre-Built Binaries</title>
+
+    <para>Enea Linux pre-built binaries are available for download on <ulink
+    url="https://portal.enea.com/login/?redirect_to=https%3A%2F%2Fportal.enea.com%2F">Enea
+    Download Portal</ulink>. Log in using the credentials provided. Using the
+    menu, browse to the <emphasis role="bold">Linux</emphasis> section. You
+    will now have access to the <emphasis role="bold">Files</emphasis> section
+    and the <emphasis role="bold">Online Documentation</emphasis>
+    section.</para>
+
+    <para>The Files section lists each Enea Linux distribution, one for each
+    version and profile, as a separate download package. Clicking on the name
+    of the distribution will open a new page, which presents further details
+    about the content of the release and a list of downloadable archives, one
+    for each hardware target included in the release. Each archive provides
+    the following content:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para><emphasis>images</emphasis> directory - this directory includes
+        the binary image files needed to boot the target with Enea Linux. This
+        includes the kernel, the root file system, device tree, etc.</para>
+      </listitem>
+
+      <listitem>
+        <para><emphasis>sdk</emphasis> directory - this directory includes the
+        installer for the SDK.</para>
+      </listitem>
+
+      <listitem>
+        <para><emphasis>deb</emphasis> directory - this directory contains all
+        the packages included in the distribution in deb format, which can be
+        installed using the package manager.</para>
+      </listitem>
+    </itemizedlist>
+
+    <para>For faster downloads, each archive is mirrored in several places,
+    geographically. Choose the archive in the region closest to you.</para>
+
+    <para>The Documentation section lists all the documents delivered with the
+    release.</para>
+  </section>
+
+  <section id="gettingsources">
+    <title>Getting the Sources</title>
+
+    <para>Enea Linux sources are available for cloning from a set of Git
+    repositories on <ulink url="https://git.enea.com">git.enea.com</ulink>.
+    Since Enea Linux requires multiple repositories, Google Repo tool is used
+    in order to manage configurations and make the cloning step simpler.
+    Google Repo tool uses files, known as manifests, which store a list of
+    tuples (repository URL, version). The Repo tool is then used to traverse
+    the list of tuples in the manifest file and clone the specified versions
+    of each repository. See <ulink
+    url="https://code.google.com/p/git-repo/">https://code.google.com/p/git-repo/</ulink>
+    for more info.</para>
+
+    <section id="getting-source-code-step-one">
+      <title>Get access to git.enea.com</title>
+
+      <para>In order to get access to git.enea.com, a ssh key is required for
+      Git authentication. If you don't already have such a key, follow the
+      steps below to generate one:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Generate the ssh key pair:</para>
+
+          <programlisting>$ ssh-keygen -t rsa</programlisting>
+
+          <para>When asked for a password, just press Enter. This will create
+          two files in the .ssh directory in your home directory.</para>
+
+          <programlisting>id_rsa
+id_rsa.pub</programlisting>
+        </listitem>
+
+        <listitem>
+          <para>Copy the public key into an authorized_keys file:</para>
+
+          <programlisting>$ cat id_rsa.pub &gt;&gt; authorized_keys</programlisting>
+        </listitem>
+      </orderedlist>
+
+      <para>Once these steps are done and you have a valid ssh key pair, send
+      the public key, <emphasis>id_rsa.pub</emphasis>, via email to
+      <email>mailto:git_support@list.enea.se</email> in order to get access to
+      <ulink url="https://git.enea.com">git.enea.com</ulink>.</para>
+    </section>
+
+    <section id="getting-source-code-step-two">
+      <title>Get Sources</title>
+
+      <para>To use the Repo tool to download the sources for Enea Linux, do
+      the following:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Make sure that the repo tool is installed. If not, do the
+          following: <remark>Below is include of ID
+          "eltf-getting-repo-install-command" from
+          eltf_params_updated.xml</remark></para>
+
+          <xi:include href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml"
+                      xmlns:xi="http://www.w3.org/2001/XInclude"
+                      xpointer="element(eltf-getting-repo-install-command/1)" />
+        </listitem>
+
+        <listitem>
+          <para>Define the <filename>MACHINE</filename> from one of the
+          targets listed here:<remark>Below is the "machine_list"
+          programlisting in machine_list_generated.xml created by the make
+          system by extracting from the manifest</remark><itemizedlist>
+              <listitem>
+                <para>raspberrypi3-64</para>
+              </listitem>
+            </itemizedlist></para>
+        </listitem>
+
+        <listitem>
+          <para>Then use the repo command below:</para>
+
+          <xi:include href="../../book-enea-linux-release-info/doc/eltf_params_updated.xml"
+                      xmlns:xi="http://www.w3.org/2001/XInclude"
+                      xpointer="element(eltf-repo-cloning-enea-linux/1)" />
+        </listitem>
+      </orderedlist>
+
+      <para>Once the source code is downloaded, the current directory will
+      contain a <filename>README</filename> file with instructions on how to
+      build the distro and boot the machine you choose. .</para>
+
+      <para>It's not necessary to explicitly clone the manifest repository
+      since that is done automatically by the repo tool. To see the current
+      manifest, use the following command:</para>
+
+      <programlisting>$ repo manifest</programlisting>
+
+      <remark>The UG should be updated with instructions on how to add
+      customizations. That section should also contain more info about the
+      manifest: the manifest templates, using a branch instead of the tag EL6,
+      etc. When this is done a reference from here should be added.</remark>
+    </section>
+  </section>
+</chapter>
\ No newline at end of file