Merge pull request #214 from mvincerx/guides-vs-tutorials

Define guides vs tutorials
This commit is contained in:
michael vincerra
2018-08-16 17:47:39 -07:00
committed by GitHub
3 changed files with 31 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:
* :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` Detailed technical information about
|CL| features and what differentiates it from other |CL| distros
* :ref:`guides` Step-by-step instructions on how to complete
common tasks that help you leverage |CL| native features
* :ref:`tutorials` Step-by-step instructions for applying specific use
cases with |CL| that often involve third-party tools
* :ref:`reference` Technical descriptions that provide context or
important details about |CL|
.. 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 when 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,13 @@
Tutorials
#########
Our Tutorials:
* 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.