diff --git a/source/clear-linux/concepts/bundles-about.rst b/source/clear-linux/concepts/bundles-about.rst index f6cccf3b..0db3efb2 100644 --- a/source/clear-linux/concepts/bundles-about.rst +++ b/source/clear-linux/concepts/bundles-about.rst @@ -14,18 +14,17 @@ distributions deploy their software. With those kinds of distributions, system administrators can then install and update sub-packages individually or as a set, using tools such as "yum" and "apt-get." -The |CLOSIA| takes a slightly different approach. While we also use the +The |CL-ATTR| takes a slightly different approach. While we also use the concept of packages to manage compiling source code into binaries, we do not use the package concept to deploy software. Instead, we provide software -"bundles" that are installed and managed using :ref:`swupd`. Each -bundle contains as many or as few open source projects needed to provide a -complete functionality. +"bundles" that are installed and managed using :ref:`swupd`. +Each bundle contains as many or as few open source projects needed to provide a complete functionality. Next steps ========== To put this concept into practice, see the following resources: -* :ref:`available-bundles` +* :ref:`bundles` * :ref:`bundle-commands` * :ref:`compatible-kernels` diff --git a/source/clear-linux/concepts/security.rst b/source/clear-linux/concepts/security.rst index 9bfe90ff..5b6b250f 100644 --- a/source/clear-linux/concepts/security.rst +++ b/source/clear-linux/concepts/security.rst @@ -1,9 +1,9 @@ .. _security: -Clear Linux\* OS Security -********************** +|CL-ATTR| OS Security +************************* -Clear Linux\* OS aims to make systemic and layered security-conscious decisions +|CL-ATTR| aims to make systemic and layered security-conscious decisions that are both performant and practical. This security philosophy is rooted within the project's codebase and operating culture. @@ -133,7 +133,7 @@ Intel® architecture, security conscious kernel and compiler options are sensibly taken advantage of. Below are some examples: -* Kernels shipped with Clear Linux are signed and disallow the usage of +* Kernels shipped with |CL| are signed and disallow the usage of custom kernel modules to maintain verifiable system integrity. * `Address space layout randomization (ASLR)`_ and diff --git a/source/clear-linux/get-started/bare-metal-install/bare-metal-manual-install.rst b/source/clear-linux/get-started/bare-metal-install/bare-metal-manual-install.rst index 8f750061..512478fd 100644 --- a/source/clear-linux/get-started/bare-metal-install/bare-metal-manual-install.rst +++ b/source/clear-linux/get-started/bare-metal-install/bare-metal-manual-install.rst @@ -1,10 +1,10 @@ .. _bare-metal-manual-install: -Install Clear Linux OS on bare metal (manual) +Install |CL-ATTR| on bare metal (manual) ############################################# -This section contains the steps for a |CL| manual installation. It picks up -where the :ref:`bare-metal-install` left off. +This section contains the steps for a |CL-ATTR| manual installation. It +picks up where the :ref:`bare-metal-install` left off. To perform additional tasks during the |CL| Installer setup, select the :guilabel:`< Manual(Advanced) >` menu option (figure 1). @@ -180,7 +180,7 @@ The next steps of the manual installer setup process allows you to: Figure 9: :guilabel:`Bundle selector` For a complete description of the content of these additional bundles, go to -the :ref:`software bundle list` and select the name for a +the :ref:`software bundle list ` and select the name for a specific bundle to show the contents within the bundle. Target system network configuration diff --git a/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst index 88d7f9fd..0fc7dfb4 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst @@ -1,9 +1,9 @@ .. _virtualbox: -Run pre-configured Clear Linux\* as a VirtualBox\* guest OS +Run pre-configured |CL-ATTR| as a VirtualBox\* guest OS ########################################################### -This instruction explains how to deploy a pre-configured Clear Linux\* image as a guest on the `VirtualBox hypervisor`_ . +This instruction explains how to deploy a pre-configured |CL-ATTR| image as a guest on the `VirtualBox hypervisor`_ . Download VirtualBox =================== @@ -21,7 +21,7 @@ The instruction assumes that you have: .. note:: - For help, see: `Intel® Virtualization Technology`_ (Intel® VT). + For help, see: Intel® `Virtualization Technology`_ (Intel® VT). #. Installed VirtualBox on your host machine per the `appropriate instructions`_ for your platform. @@ -34,7 +34,7 @@ Create a virtual machine in VirtualBox #. Log in to your host and open a terminal emulator. #. Download the `latest`_ **live** version (clear-XXXX-live.img.xz) of - Clear Linux. You can also use this command: + |CL|. You can also use this command: .. code-block:: bash @@ -193,3 +193,4 @@ To enable Hyper-V again, you should execute:: .. _VirtualBox hypervisor: https://www.virtualbox.org/ .. _latest: https://download.clearlinux.org/image/ .. _7zip: http://www.7-zip.org/ +.. _Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html \ No newline at end of file diff --git a/source/clear-linux/guides/maintenance/bulk-provision.rst b/source/clear-linux/guides/maintenance/bulk-provision.rst index 6badd952..71e6e1d1 100644 --- a/source/clear-linux/guides/maintenance/bulk-provision.rst +++ b/source/clear-linux/guides/maintenance/bulk-provision.rst @@ -3,7 +3,7 @@ Bulk provision ############## -The |CLOSIA| can be automatically provisioned in bulk using a combination of +The |CL-ATTR| can be automatically provisioned in bulk using a combination of the |CL| installer, **Ister**, and :abbr:`ICIS (Ister Cloud Init Service)`. This guide covers how to perform a bulk provision of |CL| using **Ister** and **ICIS**. @@ -49,7 +49,7 @@ Configuration with the steps it needs to perform an installation. The file outlines what partitions, file systems, and mount points **Ister** should set up. Lastly, the file outlines which bundles to install. See our - :ref:`available-bundles` document for the list of available bundles. The + :ref:`bundles` document for the list of available bundles. The following example shows the contents of an Ister installation file: .. code-block:: json diff --git a/source/clear-linux/guides/maintenance/swupd-guide.rst b/source/clear-linux/guides/maintenance/swupd-guide.rst index e22a2695..db0ba772 100644 --- a/source/clear-linux/guides/maintenance/swupd-guide.rst +++ b/source/clear-linux/guides/maintenance/swupd-guide.rst @@ -3,7 +3,7 @@ Use swupd ######### -*swupd* manages the software update capability of |CLOSIA|. It can check for +*swupd* manages the software update capability of |CL-ATTR|. It can check for valid system updates and, if found, download and install them. It can also perform verification of the system software. @@ -165,7 +165,7 @@ binary. Note that it may be present in multiple bundles: Adding a bundle =============== -Start by selecting a bundle from the list of :ref:`available-bundles`. In +Start by selecting a bundle from the list of :ref:`bundles`. In this example we're adding dev-utils-dev, which is useful for development. .. code-block:: bash diff --git a/source/clear-linux/guides/network/custom-clear-container.rst b/source/clear-linux/guides/network/custom-clear-container.rst index 5615a1d8..685e5cf5 100644 --- a/source/clear-linux/guides/network/custom-clear-container.rst +++ b/source/clear-linux/guides/network/custom-clear-container.rst @@ -1,11 +1,11 @@ .. _custom-clear-container: -Build a custom Clear Linux based Docker container image +Build a custom |CL-ATTR| based Docker container image ####################################################### -The official base |CLOSIA| container image is published on Docker\* Hub and is -updated on a regular basis. This guide contains the steps to build a custom -container image. +The official base |CL-ATTR| container image is published on Docker\* Hub and +is updated on a regular basis. This guide contains the steps to build a +custom container image. Prerequisites ************* @@ -117,7 +117,7 @@ Build the base container image #. Optionally, you can include additional bundles with the base image. #. Identify the desired bundles on the |CL| website's - :ref:`available-bundles` page or execute the + :ref:`bundles` page or execute the :command:`swupd bundle-list -a` command. #. Create reference files for the identified bundles. For example, diff --git a/source/clear-linux/reference/bundle-commands.rst b/source/clear-linux/reference/bundle-commands.rst index 81c8edd8..47c1f5d2 100644 --- a/source/clear-linux/reference/bundle-commands.rst +++ b/source/clear-linux/reference/bundle-commands.rst @@ -15,7 +15,8 @@ To see the list of all available bundles, enter: sudo swupd bundle-list --all -Alternatively, you may reference the `available bundle list`_ webpage. +Alternatively, you can view our :ref:`available bundles ` +webpage. To search for bundles and their contents, enter: @@ -44,4 +45,3 @@ To reference the :command:`swupd` man page, enter: man swupd -.. _available bundle list: https://clearlinux.org/documentation/clear-linux/reference/bundles/available-bundles diff --git a/source/clear-linux/reference/bundles/available-bundles.rst b/source/clear-linux/reference/bundles/bundles.rst similarity index 54% rename from source/clear-linux/reference/bundles/available-bundles.rst rename to source/clear-linux/reference/bundles/bundles.rst index d5f54ef6..e063c3c5 100644 --- a/source/clear-linux/reference/bundles/available-bundles.rst +++ b/source/clear-linux/reference/bundles/bundles.rst @@ -1,10 +1,10 @@ -.. _available-bundles: +.. _bundles: Available bundles ################# -This document provides a current list of available `bundles`_ as of -``12 September 2018``. +This document provides a current list of `available bundles`_ as +of ``12 September 2018``. See in depth descriptions of the following bundles: @@ -22,4 +22,4 @@ Bundle list .. raw:: html :file: bundles.html -.. _bundles: https://github.com/clearlinux/clr-bundles +.. _available bundles: https://github.com/clearlinux/clr-bundles diff --git a/source/clear-linux/reference/reference.rst b/source/clear-linux/reference/reference.rst index 1ad206a7..2f8286d3 100644 --- a/source/clear-linux/reference/reference.rst +++ b/source/clear-linux/reference/reference.rst @@ -11,7 +11,7 @@ features. compatible-hardware bundle-commands - bundles/available-bundles + bundles/bundles how-to-clear-overview collaboration/collaboration compatible-kernels