From 51ceff5817a8aca5521373d1ce04b3207209851b Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Thu, 9 Aug 2018 14:57:15 -0700 Subject: [PATCH 1/5] Redefines guides and tutorials by: - Revising clear-linux top-level TOC - Adding a clear definition of what a guide is - Adding a clear definition of what a tutorial is Signed-off-by: Michael Vincerra --- source/clear-linux/clear-linux.rst | 27 ++++++++++++++-------- source/clear-linux/guides/guides.rst | 7 ++++++ source/clear-linux/tutorials/tutorials.rst | 8 +++++++ 3 files changed, 32 insertions(+), 10 deletions(-) diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index 2c4ffe42..4cea05bc 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -3,16 +3,23 @@ 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. +Welcome to the |CLOSIA| documentation pages. Our documentation is divided +into five sections: Get started, Concepts, Guides, Tutorials, and Reference. + +* :ref:`get-started` is where you find information about installing |CL| on + bare metal, in a virtual environment, or as a live image on a USB stick. + +* :ref:`concepts` is where you can find detailed technical information about + |CL| features and what differentiates it from other |CL| distros. + +* :ref:`guides` contains step-by-step instructions to complete + common tasks that are critical to understanding |CL| and its features. + +* :ref:`tutorials` contains step-by-step instructions for + applying specific use cases with |CL| that often involve third-party tools. + +* :ref:`reference` contains information providing + additional context or details. .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/guides/guides.rst b/source/clear-linux/guides/guides.rst index c45065fb..24a22dc7 100644 --- a/source/clear-linux/guides/guides.rst +++ b/source/clear-linux/guides/guides.rst @@ -3,6 +3,13 @@ Guides ###### +Our Guides: + +* Provide a critical, fundamental understanding of |CL| features +* Show you how to leverage the full feature set of |CL| +* Enhance your productivity using |CL| + + The following guides provide step-by-step instructions for tasks that come after completing the |CL| :ref:`installation `. diff --git a/source/clear-linux/tutorials/tutorials.rst b/source/clear-linux/tutorials/tutorials.rst index 9bc120ad..770a12f7 100644 --- a/source/clear-linux/tutorials/tutorials.rst +++ b/source/clear-linux/tutorials/tutorials.rst @@ -3,6 +3,14 @@ Tutorials ######### +Our Tutorials: + +* Demonstrate how to use distinct |CL| features in cloud, + client, distributed processing, and virtualization environments +* Involve applications of |CL| that often use third-party tools +* Extend the development possibilities of |CL| with specific use cases + + This section provides detailed instructions to guide you through completing specific |CLOSIA| use cases. From 769c922fbc93670d359562c4e245d82d38ed1fd3 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Thu, 9 Aug 2018 16:51:38 -0700 Subject: [PATCH 2/5] Revises wording of tutorials for simplicity. Signed-off-by: Michael Vincerra --- source/clear-linux/tutorials/tutorials.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/clear-linux/tutorials/tutorials.rst b/source/clear-linux/tutorials/tutorials.rst index 770a12f7..bfec223c 100644 --- a/source/clear-linux/tutorials/tutorials.rst +++ b/source/clear-linux/tutorials/tutorials.rst @@ -5,9 +5,9 @@ Tutorials Our Tutorials: -* Demonstrate how to use distinct |CL| features in cloud, - client, distributed processing, and virtualization environments -* Involve applications of |CL| that often use third-party tools +* Demonstrate how to use |CL| features in cloud, client, distributed + processing, and virtualization environments +* Involve specific application of |CL| that often use third-party tools * Extend the development possibilities of |CL| with specific use cases From 1bea0ec609cadee21073309cd6d11cb4a6057e00 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Wed, 15 Aug 2018 16:52:34 -0700 Subject: [PATCH 3/5] Reduces wordiness of descriptions. Signed-off-by: Michael Vincerra --- source/clear-linux/clear-linux.rst | 16 ++++++++-------- source/clear-linux/guides/guides.rst | 2 +- source/clear-linux/tutorials/tutorials.rst | 5 ++--- 3 files changed, 11 insertions(+), 12 deletions(-) diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index 4cea05bc..3fb4f343 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -4,22 +4,22 @@ Clear Linux\* Project for Intel® Architecture ############################################# Welcome to the |CLOSIA| documentation pages. Our documentation is divided -into five sections: Get started, Concepts, Guides, Tutorials, and Reference. +into five sections: -* :ref:`get-started` is where you find information about installing |CL| on +* :ref:`get-started` Find information about installing |CL| on bare metal, in a virtual environment, or as a live image on a USB stick. -* :ref:`concepts` is where you can find detailed technical information about +* :ref:`concepts` Find detailed technical information about |CL| features and what differentiates it from other |CL| distros. -* :ref:`guides` contains step-by-step instructions to complete +* :ref:`guides` Find step-by-step instructions on how to complete common tasks that are critical to understanding |CL| and its features. -* :ref:`tutorials` contains step-by-step instructions for - applying specific use cases with |CL| that often involve third-party tools. +* :ref:`tutorials` Find step-by-step instructions for applying specific use + cases with |CL| that often involve third-party tools. -* :ref:`reference` contains information providing - additional context or details. +* :ref:`reference` Find technical descriptions that provide context or + important details. .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/guides/guides.rst b/source/clear-linux/guides/guides.rst index 24a22dc7..2be109e1 100644 --- a/source/clear-linux/guides/guides.rst +++ b/source/clear-linux/guides/guides.rst @@ -7,7 +7,7 @@ Our Guides: * Provide a critical, fundamental understanding of |CL| features * Show you how to leverage the full feature set of |CL| -* Enhance your productivity using |CL| +* Enhance your productivity when using |CL| The following guides provide step-by-step instructions for tasks that come diff --git a/source/clear-linux/tutorials/tutorials.rst b/source/clear-linux/tutorials/tutorials.rst index bfec223c..c312c8ad 100644 --- a/source/clear-linux/tutorials/tutorials.rst +++ b/source/clear-linux/tutorials/tutorials.rst @@ -5,12 +5,11 @@ Tutorials Our Tutorials: -* Demonstrate how to use |CL| features in cloud, client, distributed - processing, and virtualization environments +* Demonstrate how to use |CL| features for cloud, client, distributed + processing, and virtual environments * Involve specific application of |CL| that often use third-party tools * Extend the development possibilities of |CL| with specific use cases - This section provides detailed instructions to guide you through completing specific |CLOSIA| use cases. From 04c3a56b45b3eb149f8bec34fe5779edaa2881d2 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Thu, 16 Aug 2018 17:40:49 -0700 Subject: [PATCH 4/5] Revises bullet 3 to clarify justification of guides' usage. Signed-off-by: Michael Vincerra --- source/clear-linux/clear-linux.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index 3fb4f343..39de925a 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -13,7 +13,7 @@ into five sections: |CL| features and what differentiates it from other |CL| distros. * :ref:`guides` Find step-by-step instructions on how to complete - common tasks that are critical to understanding |CL| and its features. + common tasks that help you leverage |CL| native features. * :ref:`tutorials` Find step-by-step instructions for applying specific use cases with |CL| that often involve third-party tools. From d0d95ce789ad003b494fc8602f427697adda6983 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Thu, 16 Aug 2018 17:45:09 -0700 Subject: [PATCH 5/5] Removes repetitive "Find" from bulleted list. Signed-off-by: Michael Vincerra --- source/clear-linux/clear-linux.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index 39de925a..b0c4258a 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -6,20 +6,20 @@ Clear Linux\* Project for Intel® Architecture Welcome to the |CLOSIA| documentation pages. Our documentation is divided into five sections: -* :ref:`get-started` Find information about installing |CL| on - bare metal, in a virtual environment, or as a live image on a USB stick. +* :ref:`get-started` Information about installing |CL| on + bare metal, in a virtual environment, or as a live image on a USB stick -* :ref:`concepts` Find detailed technical information about - |CL| features and what differentiates it from other |CL| distros. +* :ref:`concepts` Detailed technical information about + |CL| features and what differentiates it from other |CL| distros -* :ref:`guides` Find step-by-step instructions on how to complete - common tasks that help you leverage |CL| native features. +* :ref:`guides` Step-by-step instructions on how to complete + common tasks that help you leverage |CL| native features -* :ref:`tutorials` Find step-by-step instructions for applying specific use - cases with |CL| that often involve third-party tools. +* :ref:`tutorials` Step-by-step instructions for applying specific use + cases with |CL| that often involve third-party tools -* :ref:`reference` Find technical descriptions that provide context or - important details. +* :ref:`reference` Technical descriptions that provide context or + important details about |CL| .. toctree:: :maxdepth: 2