Updated file titles and descriptions to improve readability.

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
2026-07-06 04:35:59 +00:00 · 2017-08-29 18:39:53 -07:00
parent 622b8c0a3e
commit 7cb9cb0720
13 changed files with 42 additions and 32 deletions
@@ -3,6 +3,17 @@
 Clear Linux\* Project for Intel® Architecture
 #############################################

+Welcome to the |CLOSIA| documentation pages. Our documentation is split into
+five sections: Get started, Concepts, Guides, Tutorials, and Reference.
+Under :ref:`Get started`, you can find information about installing |CL| on
+bare metal, in a virtual environment, or as a live image on a USB stick. Under
+the :ref:`Concepts` section, you can find detailed technical information about
+the |CL| features. The :ref:`Guides` section contains step-by-step
+instructions to complete common tasks. The :ref:`Tutorials` section contains
+step-by-step instructions to complete the installation and configuration of
+tools needed for a specific use case. Lastly, the :ref:`Reference` section
+contains information providing additional context or details.
+
 .. toctree::
    :maxdepth: 2

@@ -3,8 +3,9 @@
 Concepts
 ########

-Get a deep understanding of how |CLOSIA| works. Read through concepts that are
-unique to |CL|.
+The concepts section provides content for a deeper understanding of the
+features of |CLOSIA|. These concepts attempt to provide all the technical
+details relevant to the |CL| features.

 .. toctree::
   :maxdepth: 1
@@ -129,13 +129,7 @@ system and its updates as the basis. Using this tool, system administrators
 can focus on the custom pieces their deployments require while staying on
 a controlled update stream.

-Next steps
-==========
-
-To put this concept into practice, we have the following step-by-step
-instruction:
-
-* :ref:`update`
+To learn how to run an update of your system, visit our :ref:`update` page.

 .. [1] The software update technology for Clear Linux* OS for Intel
   Architecture was first presented at the Linux Plumbers conference in 2012.
@@ -3,14 +3,13 @@
 Get started
 ###########

-This section is where you will find documentation to do with the
-installation of |CL|.
+This section contains information about the installation of |CLOSIA|.

-The :ref:`get-started` section provides end to end instructions for
-downloading and running |CL| on :ref:`bare metal <bare-metal-install>`, under
-a :ref:`virtual machine <virtual-machine-install>`, or by way of :ref:`live image <live-image>`.
-It is also home to single task instructions and other useful information
-related to tasks preceding the installation of |CL|.
+The :ref:`get-started` section provides step-by-step instructions to download
+and run |CL| on :ref:`bare metal <bare-metal-install>`, under
+a :ref:`virtual machine <virtual-machine-install>`, or by way of a
+:ref:`live image <live-image>`. Additionally, it provides useful pre-install
+information and instructions on how to complete pre-install tasks.

 .. toctree::
   :maxdepth: 1
@@ -19,5 +18,4 @@ related to tasks preceding the installation of |CL|.
   virtual-machine-install/virtual-machine-install
   live-image
   compatibility-check
-   ../reference/supported-hardware
-
+   ../reference/supported-hardware
@@ -1,7 +1,7 @@
 .. _live-image:

-Install Clear Linux from a live image
-#####################################
+Install Clear Linux as a live image
+###################################

 This option is a great way to try a live |CL| environment without writing
 to your computer's hard disk.
@@ -1,9 +1,9 @@
 .. _virtual-machine-install:

-Install Clear Linux under a Virtual Machine
-###########################################
+Install Clear Linux in a virtual machine
+########################################

-There are some considerations to make when installing |CL| under a VM.
+There are some considerations to make when installing |CL| in a VM.
 First, you need to decide which kernel to use. This document
 will walk you through the available kernel options to help this decision. At
 the end of this document, you will be able to select the set of installation
@@ -3,8 +3,8 @@
 Guides
 ######

-The following guides provide step by step instruction for all tasks that come
-after |CL| :ref:`installation <get-started>`.
+The following guides provide step-by-step instructions for tasks that come
+after completing the |CL| :ref:`installation <get-started>`.

 .. toctree::
   :maxdepth: 2
@@ -1,6 +1,6 @@
 .. _bulk-provision:

-Bulk Provision
+Bulk provision
 ##############

 The |CLOSIA| can be automatically provisioned in bulk using a combination of
@@ -3,6 +3,9 @@
 Maintenance guide
 #################

+This guide provides step-by-step instructions for common tasks associated with
+maintaining |CLOSIA| after :ref:`installation <get-started>` is completed.
+
 .. toctree::
   :maxdepth: 2

@@ -3,6 +3,9 @@
 Network guide
 #############

+This guide provides step-by-step instructions for common tasks associated with
+the configuration and administration of networking for |CLOSIA|.
+
 .. toctree::
    :maxdepth: 1

@@ -3,8 +3,8 @@
 Reference
 #########

-This section contains all content which provides additional information
-regarding the |CL| project and it's features.
+This section contains content which provides additional information
+regarding the |CL| project and the |CL| features.

 .. toctree::
   :maxdepth: 2
@@ -3,8 +3,8 @@
 Tutorials
 #########

-This section provides instruction to walk you through completing |CL| use
-cases.
+This section provides detailed instructions to guide you through completing
+specific |CLOSIA| use cases.

 .. toctree::
   :maxdepth: 2
@@ -1,7 +1,7 @@
 .. _wp-install:

-Creating a Clear Linux WordPress\* server
-#########################################
+Create a Clear Linux WordPress\* server
+#######################################

 Prerequisites
 =============