Merge pull request #607 from clearlinux/revert-604-rtd-theme

Revert "Merge of latest changes into RTD theme to enable multi-language support"

source/FAQ/faq.rst

@@ -1,189 +0,0 @@
-.. _faq:
-
-FAQ
-###
-
-Below is a list of commonly asked questions with answers sourced from the
-|CL-ATTR| team and `Clear Linux community forums`_.
-
-.. contents:: :local:
-    :depth: 2
-
-
-General
-*******
-
-Why did you make another distro?
-================================
-
-The |CL| team felt that performance was left on the table with Linux software.
-|CL| takes a holistic approach to improving performance across the stack. We
-also wanted to take more modern approaches with OS updates and tooling.
-
-|
-
-Can other distros copy |CL| improvements?
-=========================================
-
-Yes, we absolutely love open source reuse and upstreaming improvements.
-
-|
-
-How often do you update?
-========================
-
-The |CL| team puts out multiple releases a week, often releasing 2 or more
-times a day. This rolling release approach allows |CL| to remain agile to
-upstream changes and security patches.
-
-|
-
-Is telemetry required?
-======================
-
-The telemetry solution provided by |CL| is entirely optional and customizable.
-It is disabled by default. If you do choose to enable telemetry, the data
-helps the |CL| team proactively identify and resolve bugs. See the
-:ref:`telemetry <telemetry-about>` page for more information.
-
-|
-
-What is the default firewall?
-=============================
-
-|CL| packages :command:`iptables` as a bundle, however, there are no default
-firewall rules. All network traffic is allowed by default.
-
-|
-
-Where are the files that I usually see under /etc like fstab?
-=============================================================
-
-|CL| has a stateless design that maintains a separation between system files
-and user files. Default values are stored under :file:`/usr/share/defaults/`.
-Files under :file:`/etc/` are not created unless you create one.
-
-A blog post explaining how this is accomplished with :file:`/etc/fstab/`
-specifically is available here:
-https://clearlinux.org/news-blogs/where-etcfstab-clear-linux
-
-|
-
-Software packages
-*****************
-
-How is software installed and updated?
-======================================
-
-|CL| provides software in the form of :ref:`bundles <bundles-about>` and
-updates software with :ref:`swupd <swupd-about>`.
-
-:ref:`FlatPak\* <flatpak>` is an application virtualization solution that allows
-more software to be available to |CL| users by augmenting the software |CL|
-packages natively with software available through FlatPak.
-
-Our goal is to have software packaged natively and made available through
-bundles whenever possible.
-
-|
-
-Does |CL| use RPMs like other distros?
-======================================
-
-|CL| provides software in the form of :ref:`bundles <bundles-about>`. The RPM
-format is used as an intermediary step for packaging and determining software
-dependencies at OS build time.
-
-Individual RPMs can sometimes be manually installed on a |CL| system with the
-right tools, but that is not the intended use case.
-
-|
-
-Can I install a software package from another OS on |CL|?
-=========================================================
-
-Software that is packaged in other formats for other Linux distributions is
-not guaranteed to work on |CL| and may be impacted by |CL| updates.
-
-If the software you're seeking is open source, please submit a request to add
-it to |CL|. Submit requests on GitHub\* here:
-https://github.com/clearlinux/distribution/issues
-
-|
-
-Software availability
-*********************
-
-What software is available on |CL|?
-===================================
-
-Available software can be found in the `Software Store`_, through the GNOME\*
-Software application on the desktop, or by using :ref:`swupd search <bundle-commands>`.
-
-|
-
-Is Google\* Chrome\* available?
-===============================
-
-The Google Chrome web browser is not distributed as a bundle in |CL| due to
-copyright and licensing complexities.
-
-A discussion on manually installing and maintaining Google Chrome can be found
-on GitHub: https://github.com/clearlinux/distribution/issues/422
-
-|
-
-Is FFmpeg available?
-====================
-
-`FFmpeg`_ is a multimedia software suite, which is commonly used for
-various media encoding/decoding, streaming, and playback.
-
-|CL| does not distribute FFmpeg due to well-known licensing and legal
-complexities (See https://www.ffmpeg.org/legal.html and
-http://blog.pkh.me/p/13-the-ffmpeg-libav-situation.html).
-
-Read more in the |CL| repository, including discussion of an alternative
-hardware-based solution:
-https://github.com/clearlinux/distribution/issues/429.
-
-While |CL| cannot distribute FFmpeg, a manual solution to build and install
-FFmpeg under :file:`/usr/local` has been shared on the community forums:
-https://community.clearlinux.org/t/how-to-h264-etc-support-for-firefox-including-ffmpeg-install.
-
-|
-
-Is ZFS\* available?
-===================
-
-ZFS is not available with |CL| because of copyright and licensing
-complexities. BTRFS is an alternative filesystem that is available in |CL|
-natively.
-
-A user on GitHub notes that the ZFS kernel module can be compiled, built, and
-installed manually: https://github.com/clearlinux/distribution/issues/631
-
-|
-
-Can you add a driver that I need?
-=================================
-
-If a kernel module is available as part of the Linux kernel source tree but
-not enabled in the |CL| kernels, in many cases the |CL| team will enable it
-upon request. Submit requests on GitHub here:
-https://github.com/clearlinux/distribution/issues
-
-The |CL| team does not typically add out-of-tree kernel modules as a matter of
-practice because of the maintenance overhead. If the driver was unable to be
-merged upstream, there is a good chance we may be unable to merge it for
-similar reasons.
-
-Kernel modules can be individually built and installed on |CL|. See the
-:ref:`kernel modules <kernel-modules>` page for more information.
-
-|
-
-
-.. _`Clear Linux community forums`: https://community.clearlinux.org
-.. _`Software Store`: https://clearlinux.org/software
-.. _`FFmpeg`: https://ffmpeg.org/

source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css

@@ -249,9 +249,4 @@ th,td {
    font-family: "IntelClear-Bold", Helvetica, Arial, sans-serif;
    margin-left: 0.67em;
    line-height: 100px;
-}
-
-/*Adds a bit of spacing after the last paragraph in a bulleted list*/
-.wy-plain-list-disc li p:last-child, .rst-content .section ul li p:last-child, .rst-content .toctree-wrapper ul li p:last-child, article ul li p:last-child {
-    margin-bottom: 10px;
 }

source/clear-linux/clear-linux.rst

@@ -0,0 +1,48 @@
+.. _clear-linux:
+
+|CL-PRJ|
+#############################################
+
+Welcome to the |CL-ATTR| documentation pages, the source for |CL| documentation.
+
+.. raw:: html
+
+   <iframe width="560" height="315" src="https://www.youtube.com/embed/JFg-_5xihkE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
+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.
+
+* :ref:`concepts`
+
+  Wondering what makes |CL| different? Learn about |CL| features and what
+  differentiates |CL| from other Linux distros.
+
+* :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.
+
+* :ref:`reference`
+
+  Find the detailed information you need to enable your configuration or task
+  in our |CL| reference section.
+
+.. toctree::
+    :maxdepth: 2
+    :hidden:
+
+    get-started/get-started
+    concepts/concepts
+    guides/guides
+    tutorials/tutorials
+    reference/reference

source/clear-linux/concepts/concepts.rst

@@ -0,0 +1,18 @@
+.. _concepts:
+
+Concepts
+########
+
+|CL-ATTR| does things differently than other Linux distributions. Use the concepts section to learn in detail about the features that make |CL|
+different.
+
+.. toctree::
+   :maxdepth: 2
+
+   swupd-about
+   mixer-about
+   bundles-about
+   autospec-about
+   restart
+   security
+   telemetry-about

source/clear-linux/concepts/swupd-about.rst

@@ -60,8 +60,12 @@ to update.
 Update integrity
 ----------------
 
-This is the basis of the :command:`swupd diagnose` subcommand, which allows a |CL| system to check for any discrepancies to system files. As necessary,
-:command:`swupd repair` provides a useful way for software developers to remediate these discrepancies and return to a known filesystem state.
+:command:`swupd` operates against a published manifest of files for a
+particular |CL| version that contains the unique hash of each file. This is
+the basis of the :command:`swupd verify` subcommand, which allows a |CL|
+system to check for and remediate any discrepancies to system files. As
+necessary, :command:`swupd verify` provides a useful way for software
+developers to return to a known filesystem state.
 
 Bundles
 =======

source/clear-linux/concepts/telemetry-about.rst

@@ -24,10 +24,6 @@ for debugging purposes. You can use **libtelemetry** in your code to create cust
 telemetry records. You can also use **telem-record-gen** in script files or call
 it from another program.
 
-.. note::
-
-   The |CL| telemetry client is disabled by default until you decide to enable it.  Telemetry is an **opt-in** solution and can be easily enabled or disabled.
-
 Architecture
 ************
 
@@ -78,5 +74,10 @@ own records, then you must set up your own telemetry backend server.
 Next steps
 **********
 
-To put this concept into practice, refer to :ref:`telem-guide`.
+To put this concept into practice, see the following resources:
 
+*	:ref:`telem-guide`
+*	`Telemetry feature description`_
+
+.. _`Telemetry feature description`:
+	https://clearlinux.org/features/telemetry

source/clear-linux/get-started/bare-metal-install-desktop/bare-metal-install-desktop.rst

@@ -70,8 +70,8 @@ Confirm network connection
 ==========================
 
 Confirm there is a network connection before launching the installer.
-Choose a method: `Wired Connection`, or `WiFi Connected`. This guide shows
-an example of a **Wired Connection**.
+Choose a method: `Wired Connection`, or `WiFi Connected`.
+This guide shows an example of a **Wired Connection**.
 
 #. In the upper right of the top menu bar, select the square icon to view
    Network settings, shown in Figure 2.
@@ -243,16 +243,6 @@ Use this method to safely install |CL| on media with available space, or
 alongside existing partitions, and accept the `Default partition schema`_.
 If enough free space exists, safe installation is allowed.
 
-.. note::
-
-   |CL| allows installation alongside another OS. Typically, when you boot
-   your system, you can press an `F key` to view and select a bootable
-   device or partition during the BIOS POST stage. Some BIOSes present the
-   |CL| partition, and you can select and boot it. However, other
-   BIOSes may only show the primary partition, in which case you will not be
-   able boot |CL|. Be aware of this possible limitation.
-
-
 Destructive Installation
 ------------------------
 
@@ -354,7 +344,11 @@ team for improvements. For more information, see :ref:`telemetry-about`.
 
 #. From :guilabel:`Required Options`, select :guilabel:`Telemetry`.
 
-#. Select :kbd:`Yes`.
+#. Select :kbd:`Confirm`.
+
+#. If you don't wish to participate, deselect :kbd:`Enable Telemetry`.
+
+#. Select :kbd:`Confirm`.
 
    .. figure:: figures/bare-metal-install-desktop-12.png
       :scale: 100%
@@ -362,8 +356,6 @@ team for improvements. For more information, see :ref:`telemetry-about`.
 
       Figure 12: Enable Telemetry
 
-#. If you don't wish to participate, select :kbd:`No`.
-
 Advanced options
 ****************
 

source/clear-linux/get-started/bare-metal-install-server/bare-metal-install-server.rst

@@ -49,11 +49,6 @@ Follow these steps to install |CL| on the target system:
 #. Open the system BIOS setup menu by pressing the :kbd:`F2` key.
    Your BIOS setup menu entry point may vary.
 
-   .. note::
-      |CL| supports UEFI boot. Some hardware may list UEFI and non-UEFI USB
-      boot entries. In this case, you should select the `UEFI` boot
-      option.
-
 #. In the setup menu, enable the UEFI boot and set the USB drive as the first
    option in the device boot order.
 

source/clear-linux/get-started/get-started.rst

@@ -10,40 +10,20 @@ from a live desktop or to a virtual machine.
 Pre-install
 ***********
 
-There are a couple of things to take care of before you install.
-
 * :ref:`system-requirements`
-* :ref:`compatibility-check`
-* :ref:`bootable-usb`
-
-When installing |CL-ATTR| in a VM, consider which kernel to use. 
-
-* :ref:`Compatible VM kernels <vm-kernels>`
 
 .. toctree::
    :maxdepth: 1
-   :hidden:
 
    compatibility-check
    bootable-usb/bootable-usb
 
-Install
-*******
+Install |CL|
+************
 
 .. toctree::
    :maxdepth: 1
 
    bare-metal-install-desktop/bare-metal-install-desktop
    bare-metal-install-server/bare-metal-install-server
-
-.. _virtual-machine-install:
-
-Install in a virtual machine
-****************************
-
-.. toctree::
-   :maxdepth: 1
-   :glob:
-
-   virtual-machine-install/*
-   ../../guides/maintenance/increase-virtual-disk-size.rst
+   virtual-machine-install/virtual-machine-install