diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index c270b683..a1083a19 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -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 diff --git a/source/clear-linux/concepts/concepts.rst b/source/clear-linux/concepts/concepts.rst index dd8e9b4d..06094655 100644 --- a/source/clear-linux/concepts/concepts.rst +++ b/source/clear-linux/concepts/concepts.rst @@ -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 diff --git a/source/clear-linux/concepts/swupd-about.rst b/source/clear-linux/concepts/swupd-about.rst index 341b55de..77b9ffaf 100644 --- a/source/clear-linux/concepts/swupd-about.rst +++ b/source/clear-linux/concepts/swupd-about.rst @@ -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. diff --git a/source/clear-linux/get-started/get-started.rst b/source/clear-linux/get-started/get-started.rst index 24cbd016..e7af0759 100644 --- a/source/clear-linux/get-started/get-started.rst +++ b/source/clear-linux/get-started/get-started.rst @@ -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 `, under -a :ref:`virtual machine `, or by way of :ref:`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 `, under +a :ref:`virtual machine `, or by way of a +:ref:`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 \ No newline at end of file diff --git a/source/clear-linux/get-started/live-image.rst b/source/clear-linux/get-started/live-image.rst index 3d3e19cd..bdfb37c0 100644 --- a/source/clear-linux/get-started/live-image.rst +++ b/source/clear-linux/get-started/live-image.rst @@ -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. diff --git a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst index f5ad370b..4dfe9614 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst @@ -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 diff --git a/source/clear-linux/guides/guides.rst b/source/clear-linux/guides/guides.rst index 0e614850..c45065fb 100644 --- a/source/clear-linux/guides/guides.rst +++ b/source/clear-linux/guides/guides.rst @@ -3,8 +3,8 @@ Guides ###### -The following guides provide step by step instruction for all tasks that come -after |CL| :ref:`installation `. +The following guides provide step-by-step instructions for tasks that come +after completing the |CL| :ref:`installation `. .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/guides/maintenance/bulk-provision.rst b/source/clear-linux/guides/maintenance/bulk-provision.rst index b44095bc..4d2aa4f1 100644 --- a/source/clear-linux/guides/maintenance/bulk-provision.rst +++ b/source/clear-linux/guides/maintenance/bulk-provision.rst @@ -1,6 +1,6 @@ .. _bulk-provision: -Bulk Provision +Bulk provision ############## The |CLOSIA| can be automatically provisioned in bulk using a combination of diff --git a/source/clear-linux/guides/maintenance/maintenance.rst b/source/clear-linux/guides/maintenance/maintenance.rst index 4a2cbc6c..8d4f0c4b 100644 --- a/source/clear-linux/guides/maintenance/maintenance.rst +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -3,6 +3,9 @@ Maintenance guide ################# +This guide provides step-by-step instructions for common tasks associated with +maintaining |CLOSIA| after :ref:`installation ` is completed. + .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/guides/network/network.rst b/source/clear-linux/guides/network/network.rst index 6a62a3f9..3b5f0ff8 100644 --- a/source/clear-linux/guides/network/network.rst +++ b/source/clear-linux/guides/network/network.rst @@ -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 diff --git a/source/clear-linux/reference/reference.rst b/source/clear-linux/reference/reference.rst index 49de0990..f1a8ba8c 100644 --- a/source/clear-linux/reference/reference.rst +++ b/source/clear-linux/reference/reference.rst @@ -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 diff --git a/source/clear-linux/tutorials/tutorials.rst b/source/clear-linux/tutorials/tutorials.rst index babc586e..f0cef09f 100644 --- a/source/clear-linux/tutorials/tutorials.rst +++ b/source/clear-linux/tutorials/tutorials.rst @@ -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 diff --git a/source/clear-linux/tutorials/wp-install/wp-install.rst b/source/clear-linux/tutorials/wp-install/wp-install.rst index bc2274ea..7112c3aa 100644 --- a/source/clear-linux/tutorials/wp-install/wp-install.rst +++ b/source/clear-linux/tutorials/wp-install/wp-install.rst @@ -1,7 +1,7 @@ .. _wp-install: -Creating a Clear Linux WordPress\* server -######################################### +Create a Clear Linux WordPress\* server +####################################### Prerequisites =============