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 <michael.vincerra@intel.com>
This commit is contained in:
Michael Vincerra
2018-08-09 14:57:15 -07:00
parent 34487d2d46
commit 51ceff5817
3 changed files with 32 additions and 10 deletions
+17 -10
View File
@@ -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
+7
View File
@@ -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 <get-started>`.
@@ -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.