From ef893406be2e35a27d6a8aa5a913f0183a4206e9 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 14:16:04 -0700 Subject: [PATCH 01/16] Renamed available-bundles.rst to bundles.rst - Purpose: So bundles.rst shows up under bundles folder. Signed-off-by: Michael Vincerra --- .../reference/bundles/{available-bundles.rst => bundles.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename source/clear-linux/reference/bundles/{available-bundles.rst => bundles.rst} (100%) diff --git a/source/clear-linux/reference/bundles/available-bundles.rst b/source/clear-linux/reference/bundles/bundles.rst similarity index 100% rename from source/clear-linux/reference/bundles/available-bundles.rst rename to source/clear-linux/reference/bundles/bundles.rst From 243e0703ff5c7301266a05548c77dc2de8f31cb5 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 14:45:57 -0700 Subject: [PATCH 02/16] Changes internal file name at top to ..bundles: Signed-off-by: Michael Vincerra --- source/clear-linux/reference/bundles/bundles.rst | 2 +- source/clear-linux/reference/reference.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/clear-linux/reference/bundles/bundles.rst b/source/clear-linux/reference/bundles/bundles.rst index d5f54ef6..79d70826 100644 --- a/source/clear-linux/reference/bundles/bundles.rst +++ b/source/clear-linux/reference/bundles/bundles.rst @@ -1,4 +1,4 @@ -.. _available-bundles: +.. _bundles: Available 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 From 92093be98c6305f5a0e2fe93df66fe714110aa7a Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 14:50:12 -0700 Subject: [PATCH 03/16] Changes file name reference to :ref:`bundles` Signed-off-by: Michael Vincerra --- source/clear-linux/concepts/bundles-about.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/clear-linux/concepts/bundles-about.rst b/source/clear-linux/concepts/bundles-about.rst index f6cccf3b..8188aa77 100644 --- a/source/clear-linux/concepts/bundles-about.rst +++ b/source/clear-linux/concepts/bundles-about.rst @@ -17,15 +17,14 @@ 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 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` From 4e9dbf85053f36b0f21858d85f6090c0292d46cf Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 15:44:41 -0700 Subject: [PATCH 04/16] Updates reference to new doc title page. Signed-off-by: Michael Vincerra --- .../bare-metal-install/bare-metal-manual-install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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..d2fa453b 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 @@ -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 From 5258f1abe3b88f2b08668cb2f9523722c839ae57 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 15:49:04 -0700 Subject: [PATCH 05/16] Updates reference to new doc title `bundles` and |CLR-ATTR|. Signed-off-by: Michael Vincerra --- source/clear-linux/guides/maintenance/bulk-provision.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 From 6ed3f93b8793fb1fee3ed9bd6b9c3dfc3dcded79 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 15:59:37 -0700 Subject: [PATCH 06/16] Updates reference to new doc title `bundles` and |CL-ATTR| Signed-off-by: Michael Vincerra --- source/clear-linux/guides/maintenance/swupd-guide.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 From a0ac2fd1245139adf45c1528ee09cfcbaa2b0bcb Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 16:03:49 -0700 Subject: [PATCH 07/16] Updates reference to new doc title `bundles` and |CL-ATTR|. Signed-off-by: Michael Vincerra --- .../guides/network/custom-clear-container.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) 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, From 10f9fb9dafb1483274a4fcfc5b14aff507425833 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 16:12:15 -0700 Subject: [PATCH 08/16] Updates in-text reference to ; omits URL method. Signed-off-by: Michael Vincerra --- source/clear-linux/reference/bundle-commands.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 From d57c051e898daafdde34c5e457099f7fb20c7001 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Mon, 17 Sep 2018 16:16:25 -0700 Subject: [PATCH 09/16] Updates to |CL-ATTR| where necessary. Signed-off-by: Michael Vincerra --- .../bare-metal-install/bare-metal-manual-install.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) 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 d2fa453b..e0d72d22 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). From c4d3a7d598fb35e4b70382da9c5f40891c7e467e Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Tue, 18 Sep 2018 09:19:09 -0700 Subject: [PATCH 10/16] Fixes underline length in header. Signed-off-by: Michael Vincerra --- source/clear-linux/concepts/security.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/clear-linux/concepts/security.rst b/source/clear-linux/concepts/security.rst index 9bfe90ff..8e8381d1 100644 --- a/source/clear-linux/concepts/security.rst +++ b/source/clear-linux/concepts/security.rst @@ -1,7 +1,7 @@ .. _security: Clear Linux\* OS Security -********************** +************************* Clear Linux\* OS aims to make systemic and layered security-conscious decisions that are both performant and practical. This security philosophy is rooted From acd86c2149f9915a90b5dce5ae31abb9d83ab07f Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Tue, 18 Sep 2018 09:28:40 -0700 Subject: [PATCH 11/16] =?UTF-8?q?Adds=20missing=20hyperlink=20for=20Intel?= =?UTF-8?q?=C2=AE=20Virtualization=20Technology.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michael Vincerra --- .../get-started/virtual-machine-install/virtualbox.rst | 2 ++ 1 file changed, 2 insertions(+) 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..1fde1f92 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst @@ -193,3 +193,5 @@ 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/ +.. _Intel® Virtualization Technology: https://www.intel.com/content/www/us/en +/virtualization/virtualization-technology/intel-virtualization-technology.html \ No newline at end of file From 76a40083e322165f34ca7c122369a5406da72ce6 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Tue, 18 Sep 2018 13:30:23 -0700 Subject: [PATCH 12/16] Revises hyperlink ref to available bundles to make it unique. Signed-off-by: Michael Vincerra --- source/clear-linux/reference/bundles/bundles.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/clear-linux/reference/bundles/bundles.rst b/source/clear-linux/reference/bundles/bundles.rst index 79d70826..e063c3c5 100644 --- a/source/clear-linux/reference/bundles/bundles.rst +++ b/source/clear-linux/reference/bundles/bundles.rst @@ -3,8 +3,8 @@ 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 From 8c44749f72965bdd3c8ebf913f3ec79bc596771b Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Tue, 18 Sep 2018 13:37:11 -0700 Subject: [PATCH 13/16] Adds empty space before reference. Signed-off-by: Michael Vincerra --- .../bare-metal-install/bare-metal-manual-install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 e0d72d22..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 @@ -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 From 4e24f2e89d9c6210d94158c097eb1e46d3b4a8c7 Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Tue, 18 Sep 2018 13:56:49 -0700 Subject: [PATCH 14/16] Changes line break for Sublime to recognize hyperlink. Signed-off-by: Michael Vincerra --- .../get-started/virtual-machine-install/virtualbox.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) 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 1fde1f92..b10e3ef8 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst @@ -193,5 +193,5 @@ 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/ -.. _Intel® Virtualization Technology: https://www.intel.com/content/www/us/en -/virtualization/virtualization-technology/intel-virtualization-technology.html \ No newline at end of file +.. _Intel® Virtualization Technology: +https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html \ No newline at end of file From 90b728d13aa2e11bc215b718a6f830105156f1ed Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Tue, 18 Sep 2018 14:05:42 -0700 Subject: [PATCH 15/16] Revises hyperlink target to omit problematic special characters. Signed-off-by: Michael Vincerra --- .../get-started/virtual-machine-install/virtualbox.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) 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 b10e3ef8..6da06c46 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst @@ -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. @@ -193,5 +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/ -.. _Intel® Virtualization Technology: -https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html \ No newline at end of file +.. _Virtualization Technology: https://www.intel.com/content/www/us/en/virtualization/virtualization-technology/intel-virtualization-technology.html \ No newline at end of file From b889f8fa223e6d803c0706b4f3cddcf22e24881f Mon Sep 17 00:00:00 2001 From: Michael Vincerra Date: Tue, 18 Sep 2018 16:43:49 -0700 Subject: [PATCH 16/16] Updates instances of Clear Linux using proper substitutions. Signed-off-by: Michael Vincerra --- source/clear-linux/concepts/bundles-about.rst | 2 +- source/clear-linux/concepts/security.rst | 6 +++--- .../get-started/virtual-machine-install/virtualbox.rst | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/source/clear-linux/concepts/bundles-about.rst b/source/clear-linux/concepts/bundles-about.rst index 8188aa77..0db3efb2 100644 --- a/source/clear-linux/concepts/bundles-about.rst +++ b/source/clear-linux/concepts/bundles-about.rst @@ -14,7 +14,7 @@ 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`. diff --git a/source/clear-linux/concepts/security.rst b/source/clear-linux/concepts/security.rst index 8e8381d1..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/virtual-machine-install/virtualbox.rst b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst index 6da06c46..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 =================== @@ -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