diff --git a/source/about.rst b/source/about.rst index ecf7b33d..63bc1f06 100644 --- a/source/about.rst +++ b/source/about.rst @@ -3,75 +3,84 @@ About ##### -|CL| is designed to deliver a secure, hardware optimized OS that is easy to -keep up to date while ensuring that software dependencies remain mutually -compatible. +The |CL| delivers a secure, hardware optimized OS. Its easy updates ensure that +software dependencies remain mutually compatible. -This is accomplished through a number of custom infrastructure components and process innovations that make |CL| unique. +|CL| does this via custom infrastructure components and process innovations. .. contents:: :local: :depth: 1 + +For detailed information on these topics, refer to the :ref:`cl-guides` guides. + + Release Cadence *************** -|CL| updates are based on a rolling release that can occur daily but usually occur a few times per week. Each release has a unique version number that identifies every component in the OS from kernel, to driver, to tool, to GUI application. Most components are included in entities called :ref:`bundles-about`. +|CL| updates are based on a rolling release that can occur daily but usually +occurs a few times per week. Each release has a unique version number that +identifies every component in the OS from kernel, to driver, to tool, to GUI +application. Most components are included in entities called *bundles*. Updates ******* -Updates are made to ensure that the latest performance and security fixes are installed as soon as they are available. :ref:`swupd-guide` is the custom tool designed to manage updates and bundles. +By default, |CL| automatically checks for updates, ensuring that the latest +performance and security fixes are installed as soon as they are available. +:ref:`swupd-guide` is the custom tool designed to manage updates and bundles. + +|CL| is :ref:`stateless` to make sure that system components can be updated +without impacting user settings. + -|CL| is :ref:`stateless` to make sure that system components can be updated without impacting user settings. - Ease of Use *********** -|CL| is designed to make a number of difficult problems easier to manage. -:ref:`autoproxy` makes it possible for |CL| tools to operate in some proxy -environments without needing to be configured. +|CL| makes it easier to manage a number of difficult problems. -Being :ref:`stateless` means that configuration settings are easier to manage and remain untouched when system sofware is updated. +* :ref:`autoproxy` makes it possible for |CL| tools to operate in some proxy + environments without needing to be configured. -:ref:`swupd-guide` also makes it easy to manage software and maintain compatibility. +* Being :ref:`stateless` means that configuration settings are easier to manage + and remain untouched when system sofware is updated. + +* :ref:`swupd-guide` also makes it easy to manage software and maintain + compatibility. Custom Derivatives ****************** -The same tooling that the |CL| team uses can be used to create a custom distribution that continues to benefit from rolling releases. +The same tools used to build the |CL| are available *in* the OS. These tools can +be used to create a custom distribution that continues to benefit from upstream +rolling releases. .. figure:: /_figures/clear-lifecycle.png :scale: 75% :align: center - :alt: Creating and Managing a Clear Linux* OS (or derivative) Version - - Figure 1: Creating and managing a Clear Linux\* OS (or derivative) version + :alt: Creating and managing a Clear Linux* OS version (or derivative) + Figure 1: Creating and managing a Clear Linux\* OS version (or derivative) Create ====== -You will need to understand how to use :ref:`autospec` and :ref:`mixer` -to create a custom distribution. +To create a custom distribution you need to understand how to use the +:ref:`autospec` and :ref:`mixer` tools. Additional training materials are available in the `how-to-clear`_ GitHub\* project to help you get started with |CL| tools. -To complete the training, you will need a clean |CL| installation and a -network connection. The project includes all files needed to complete the -exercises. - Deploy ====== We also provide training on how to :ref:`deploy-at-scale`. - + Administrate ============ -:ref:`telem-guide` provides a method of collecting useful information about a |CL| deployment, and there are also :ref:`debug` capabilities. - - +|CL| provides a :ref:`telem-guide` solution for collecting useful information +about a deployment, as well as :ref:`debug` capabilities. .. _how-to-clear: https://github.com/clearlinux/how-to-clear diff --git a/source/guides/index.rst b/source/guides/index.rst index 1c17266b..38d63b65 100644 --- a/source/guides/index.rst +++ b/source/guides/index.rst @@ -9,6 +9,8 @@ The following guides provide step-by-step instructions on using |CL|. As of 22 May 2019 :file:`mixin` is no longer supported. +.. _cl-guides: + Clear Linux =========== diff --git a/source/index.rst b/source/index.rst index 7acd0328..cab854a7 100644 --- a/source/index.rst +++ b/source/index.rst @@ -5,35 +5,38 @@ Welcome to the |CL-ATTR| documentation pages, the source for |CL| documentation. -.. raw:: html - - - Our documentation is divided into the following sections: + :ref:`get-started` - If you are new to |CL|, get started fast with tutorials for installing |CL| - on bare metal, in a virtual environment, or as a live image on a USB stick. + + If you are new to |CL|, get started quickly with step-by-step instructions for installing |CL| on bare metal, in a virtual environment, or as a live image on a USB stick. :ref:`about` - Clear Linux is a little different from other distros. Here are some - important tools and concepts for managing your install. + + |CL| is different from other Linux distributions. + + Updates, ease of use, and custom derivatives are a few of the differences this section explains. Orient yourself to these differences and why they matter to you. :ref:`guides` - Guides show how to complete common tasks that help you leverage |CL| native - features effectively. From basic system configuration to advanced - management of a cloud installation, there is a guide for you. -:ref:`tutorials` - |CL| tutorials provide step-by-step instructions on how |CL| features can - be used and extended, frequently with third-party tools. + Guides cover a range of topics from |CL| features and tooling, to system maintenance, network, and stacks. + +:ref:`Use Cases ` + + Sample use cases, with step-by-step instructions, show how to set up third-party tools and software with |CL|. :ref:`reference` - Find the detailed information you need to enable your configuration or task - in our |CL| reference section. + + The reference section contains supplemental information in support of |CL| configuration, system requirements, and contributions. :ref:`faq` - Refer to our FAQ section to read commonly asked questions and answers. + + The FAQ section provides answers to commonly asked questions about |CL|. + +.. raw:: html + + .. toctree:: :maxdepth: 2