Update time.rst

Removed adding the polkit and instead added sudo to the timecatectl set-ntp command.

source/_themes/otc_tcs_sphinx_theme/layout.html

@@ -47,6 +47,10 @@
 
 <div id="trademarks">
   <p>*Other names and brands may be claimed as the property of others.</p>
+  <ul class="footer__menu_list">
+    <li class="footer__menu_list"><a href="https://www.intel.com/content/www/us/en/legal/trademarks.html">*Trademarks</a></li>
+    <li class="footer__menu_list"><a href="https://www.intel.com/content/www/us/en/privacy/intel-cookie-notice.html">Cookies</a></li>
+    <li class="footer__menu_list"><a href="https://www.intel.com/content/www/us/en/privacy/intel-privacy-notice.html">Privacy Terms</a></li>
 </div>
 
 {% endblock %}

source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css

@@ -520,3 +520,30 @@ div.linenodiv:before { /*add extra new line to make sure code and line numbers a
 }
 
 /*End support for multi-column sections*/
+
+/*Start fix for changes made to definition lists in sphinx/rtd post version 2.0*/
+
+.rst-content dl:not(.docutils) dt {
+  border-top: none;
+  background: none;
+}
+
+/*end fix to definition lists*/
+
+/*start formatting support for horizontal bullet list without bullets in footer*/
+ul.footer__menu_list {
+  display: inline-flex;
+}
+
+li.footer__menu_list {
+  margin-right: 30px;
+}
+/*end footer bullet list support*/
+
+/*Add drop shadow to figures*/
+
+div.figure.dropshadow img {
+  box-shadow: 10px 10px 10px LightGray;
+}
+
+/*end figure drop shadow*/

source/conf.py

@@ -54,7 +54,7 @@ master_doc = 'index'
 # General information about the project.
 #project = u'Clear Linux* project'
 project = u'Clear Linux* Project Docs'
-copyright = u'2019.'
+copyright = u'2020.'
 author = u'many'
 
 # The version info for the project you're documenting, acts as replacement for

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

@@ -16,6 +16,7 @@ System requirements
 Before installing |CL|, verify that the host system supports the
 installation:
 
+* Requires 20 GB or more disk space
 * :ref:`system-requirements`
 * :ref:`compatibility-check`
 
@@ -284,7 +285,6 @@ optional.
 
 #. Select :guilabel:`Confirm` in submenu.
 
-
 Advanced Installation
 ---------------------
 
@@ -657,5 +657,3 @@ Troubleshooting
 :ref:`erase-lvm-troubleshooting-tip`
 
 .. _Downloads: https://clearlinux.org/downloads
-
-

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

@@ -16,6 +16,7 @@ System requirements
 Before installing |CL|, verify that the host system supports the
 installation:
 
+* Requires 4 GB or more disk space
 * :ref:`system-requirements`
 * :ref:`compatibility-check`
 
@@ -38,12 +39,8 @@ Install |CL| on your target system
 **********************************
 
 Ensure that your system is configured to boot UEFI. The installation method
-described below requires a wired Internet connection with DHCP.
+described below requires a wired or wireless Internet connection with DHCP.
 
-.. note::
-
-   Alternatively, you can install |CL| over a wireless connection by first
-   using `nmtui`. Follow the `nmtui` instructions shown in Figure 2.
 
 Follow these steps to install |CL| on the target system:
 
@@ -90,6 +87,12 @@ Launch the |CL| Installer
 
       Figure 2: root login
 
+#. .. note::
+
+      If a wireless connection is needed, connect to the network using
+      :command:`nmtui` before lauching the installer. See the documentation on
+      :ref:`configuring Wifi with nmtui <wifi-nm-tui>` for more details.
+
 #. At the :guilabel:`root` prompt, enter :command:`clr-installer` and
    press :kbd:`Enter`.
 
@@ -488,7 +491,8 @@ Add New User
 
    .. note:
 
-      The User Name must be alphanumeric and can include spaces, commas, underscores or hyphens. Maximum length is 64 characters.
+      The User Name must be alphanumeric and can include spaces, commas,
+      underscores or hyphens. Maximum length is 64 characters.
 
    .. figure:: /_figures/bare-metal-install-server/bare-metal-install-server-19.png
       :scale: 100%

source/get-started/bootable-usb.rst

@@ -39,41 +39,33 @@ Burn the |CL| image onto a USB drive
 
 #. Plug in the USB drive.
 
-#. Identify the USB drive using the :command:`lsblk` command. This shows all
+#. Identify the USB drive using the :command:`lsblk` command with these options:
+   ``-po NAME,SIZE,TYPE,FSTYPE,PARTLABEL,MOUNTPOINT,VENDOR,MODEL``. This shows all
    drives attached to the system, including the primary hard disk. In the
-   example output below, there are 4 drives
-   (`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and `/dev/sdd`) attached, where
-   `/dev/sda` is the primary drive. The remaining are three USB drives. The output
-   also shows the mounted partitions (under the `MOUNTPOINT` column) for each
-   drive.
+   example output below, there are 3 drives (`/dev/sda`, `/dev/sdb`, and `/dev/sdc`) 
+   attached, where `/dev/sda` is the primary drive and the remaining are USB drives.
 
    .. code-block:: bash
 
-      lsblk
+      lsblk -po NAME,SIZE,TYPE,FSTYPE,PARTLABEL,MOUNTPOINT,VENDOR,MODEL
 
    Example output:
 
    .. code-block:: console
-      :emphasize-lines: 1-5
 
-      NAME   MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
-      sdd      8:48   1    15G  0 disk
-      ├─sdd2   8:50   1     5G  0 part /run/media/user1/960c184f-3bb7-42b7-bcaf-0c1282
-      ├─sdd3   8:51   1     8G  0 part /run/media/user1/704f3382-b26d-4f34-af1b-cb9aab
-      └─sdd1   8:49   1     2G  0 part
-      sdb      8:16   1  14.8G  0 disk
-      └─sdb1   8:17   1  14.8G  0 part /run/media/user1/PATRIOT_USB
-      sdc      8:32   1   7.3G  0 disk
-      └─sdc1   8:33   1   7.3G  0 part /run/media/user1/LINUX MINT
-      sda      8:0    0 335.4G  0 disk
-      ├─sda4   8:4    0    28G  0 part
-      ├─sda2   8:2    0   3.7G  0 part [SWAP]
-      ├─sda7   8:7    0     6G  0 part /home
-      ├─sda5   8:5    0     1G  0 part /boot
-      ├─sda3   8:3    0   954M  0 part /boot/efi
-      ├─sda1   8:1    0    28G  0 part
-      ├─sda8   8:8    0    30G  0 part /
-      └─sda6   8:6    0   7.9G  0 part [SWAP]
+      NAME          SIZE VENDOR   MODEL                    TRAN   TYPE PARTLABEL                    MOUNTPOINT
+      /dev/sda    119.2G ATA      SAMSUNG_MZ7PC128HAFU-000 sata   disk                              
+      ├─/dev/sda1   450M                                          part Basic data partition         
+      ├─/dev/sda2   100M                                          part EFI system partition         
+      ├─/dev/sda3    16M                                          part Microsoft reserved partition 
+      ├─/dev/sda4  97.2G                                          part Basic data partition         
+      ├─/dev/sda5   142M                                          part EFI                          
+      ├─/dev/sda6   245M                                          part linux-swap                   [SWAP]
+      └─/dev/sda7  21.1G                                          part /                            /
+      /dev/sdb      7.5G General  UDisk                    usb    disk                              
+      └─/dev/sdb1   7.5G                                          part Microsoft Basic Data         /run/media/clear/CENA_X64FRE
+      /dev/sdc       15G          Patriot_Memory           usb    disk                              
+      └─/dev/sdc1    15G                                          part                              /run/media/clear/U
 
    .. note::
 
@@ -81,18 +73,19 @@ Burn the |CL| image onto a USB drive
 
 #. If the USB drive you want to use is mounted, it must be umounted before
    burning an image onto it.  Use the :command:`umount` command followed by
-   the device identifier/partition. For example, to unmount all /dev/sdd
-   partitions:
+   the device identifier/partition. For example, to unmount all of the 
+   ``/dev/sdc`` partitions:
 
    .. code-block:: bash
 
-      sudo umount /dev/sdd*
+      sudo umount /dev/sdc*
 
-#. Burn the image onto the USB drive. The example below burns an image onto `<your USB device>`:
+#. Burn the image onto the USB drive. This example burns an image onto ``/dev/sdc``.  
+   The device name of the USB may vary.
 
    .. code-block:: bash
 
-      sudo dd if=./clear-[version number]-live-[desktop | server].iso of=<your USB device> oflag=sync bs=4M status=progress
+      sudo dd if=./clear-[version number]-live-[desktop | server].iso of=/dev/sdc oflag=sync bs=4M status=progress
 
 .. caution::
 
@@ -135,7 +128,7 @@ Burn the |CL| image onto a USB drive
 
       Figure 1: macOS - Get USB drive identifier
 
-#. Unmount the USB drive identified in the previous step. For example, to unmount /dev/disk2:
+#. Unmount the USB drive identified in the previous step. For example, to unmount /dev/disk2. The device name of the USB may vary.
 
    .. code-block:: bash
 
@@ -143,14 +136,13 @@ Burn the |CL| image onto a USB drive
 
 #. Burn the image onto the drive using the :command:`dd` command.
    This example uses `./`, your current directory, and it shows how to burn
-   an image onto `<your USB device>`:
+   an image onto `/dev/disk2`:
 
    .. code-block:: bash
 
-      sudo dd if=./clear-[version number]-live-[desktop | server].iso of=<your USB device> bs=4m
+      sudo dd if=./clear-[version number]-live-[desktop | server].iso of=/dev/disk2 bs=4m
 
-   To accelerate the imaging process, add an ‘r’ before the disk identifier.
-   Example: `sudo dd if=./clear-30800-live-server.iso of=/dev/rdisk2 bs=4m`.
+   To accelerate the imaging process, add an ‘r’ before the device identifier. Example: `sudo dd if=./clear-30800-live-server.iso of=/dev/rdisk2 bs=4m`.
 
    Press :kbd:`<CTRL>-T` to check imaging progress.
 
@@ -193,6 +185,8 @@ Burn the |CL| image onto a USB drive
 
       For other image tools, verify the `Volume label` is set to :guilabel:`CLR_ISO` **Do not change the label as installer relies on it.**
 
+#. In the dialog, navigate to where the |CL| ISO image was downloaded and select it.
+
 #. Click the :guilabel:`START` button. See Figure 2.
 
    .. figure:: /_figures/bootable-usb/bootable-usb-windows-02.png

source/get-started/cloud-install/gce.rst

@@ -229,12 +229,10 @@ Setup |CL| VM on GCP
 
         Figure 18: Set SSH key for remote login
 
-     .. warning::
+     .. note::
 
         The username is assigned from characters preceding ``@`` in the email
-        address, included in the SSH key. The dot symbol "." is not allowed,
-        because it is an invalid character while creating user accounts in
-        |CL|.
+        address, included in the SSH key.
 
    * Click the :guilabel:`Create` button to create the |CL| VM.
 

source/get-started/cloud-install/qingcloud.rst

@@ -0,0 +1,235 @@
+.. _qingcloud:
+
+|CL-ATTR| on QingCloud\* (如何在青云 QingCloud 上创建 |CL| 虚拟主机)
+#########################################################################
+
+本教程介绍如何通过青云 QingCloud\* 控制台创建和启动 |CL| 实例以及完成以下任务：
+
+#. 在 QingCloud 系统镜像中找到并选择 |CL| 操作系统。
+#. 创建新的公钥和私钥对，以便可以安全地连接到 |CL| 虚拟主机。
+#. 启动新的 |CL| 虚拟主机并连接到该主机。
+#. 删除 |CL| 虚拟主机。
+
+.. contents::
+   :local:
+   :depth: 1
+
+必备条件
+************
+
+本教程假定您已经完成了如下默认配置：
+
+* 您的环境可以运行 SSH 以访问远程 |CL| 虚拟主机。
+* 您知悉浏览器下载文件的绝对路径。
+* 您已设置了 QingCloud 的用户帐户，并确保该账户为启用状态，并且已登录到 QingCloud 控制台。 要了解有关青云和设置账户的更多信息，请访问青云官网，网址为 https://www.qingcloud.com/。
+
+在 QingCloud 控制台中选择并启动 |CL| 虚拟主机
+**********************************************
+
+#. 在浏览器中在 QingCloud 控制台主菜单中，依次选择 **“计算”** 、 **“主机”**，之后点击图1中所示的 **“创建”** 选项。
+
+   .. figure:: /_figures/qingcloud/QingCloud-1.png
+      :scale: 50 %
+      :alt: QingCloud 控制台
+
+      图1: QingCloud 控制台
+    
+   选择此选项后，页面将跳转到“创建主机”页面。
+
+#. 在创建主机页面，先点击图2中所示的 **“系统”** 选项，再点击最右侧 **|CL|** 图标，并点击 **“下一步”** 按钮。 
+
+   .. figure:: /_figures/qingcloud/QingCloud-2.png
+      :scale: 50 %
+      :alt: 选择 |CL| 创建虚拟主机
+
+      图2: 选择 |CL| 创建虚拟主机
+
+   之后，您将来到配置选择界面。 
+
+#. 在配置选择界面，您可以看到不同硬件配置类型的虚拟主机，比如调整 CPU 核心数量、内存大小以及硬盘和副本备份策略。这里我们将选择默认配置来进行接下来的演示。
+
+   .. figure:: /_figures/qingcloud/QingCloud-3.png
+      :scale: 50 %
+      :alt: 配置选择
+
+      图3: 配置选择
+
+   在点击 “下一步” 按钮之后，您将来到网络设置界面。
+
+#. 在网络设置界面，您可以创建私有的 VPC 网络，也可以快速测试 |CL| 选择基础网络。 这里我们选择 **“基础网络”**。
+
+   .. figure:: /_figures/qingcloud/QingCloud-4.png
+      :scale: 50 %
+      :alt: 网络设置
+
+      图4: 网络设置
+
+#. 在基本信息设置界面，您需要输入虚拟主机名称，并设置 SSH 密钥登录方式。
+
+   #. 如果之前没有创建过 SSH 密钥，请点击图5中 **“创建一个”** 按钮以创建 SSH 密钥。
+
+      .. figure:: /_figures/qingcloud/QingCloud-6.png
+         :scale: 50 %
+         :alt: 创建SSH密钥
+
+         图5: 创建SSH密钥
+
+      在点击 “创建一个” 按钮之后，页面将跳转到 SSH 密钥创建界面。
+
+   #. 在 SSH 密钥创建界面中，您可以依照图6填写密钥的名称以便记忆，并且选择您需要的加密方法，确认无误后即可点击 **“提交”** 按钮。
+
+      .. figure:: /_figures/qingcloud/QingCloud-6.png
+         :scale: 50 %
+         :alt: 新建SSH密钥
+
+         图6: 新建SSH密钥
+
+      提交之后，将跳出密钥下载按钮。
+
+   #. 出现密钥下载按钮后，请在10分钟之内点击下载按钮完成密钥的下载，并将该密钥妥善保存到本地，以便之后连接虚拟主机使用。
+
+      .. figure:: /_figures/qingcloud/QingCloud-7.png
+         :scale: 50 %
+         :alt: 下载SSH密钥
+
+         图7: 下载SSH密钥   
+
+      在关闭下载对话框之后，界面将跳转到之前的 “基本信息设置” 界面
+
+#. 在确保 SSH 密钥已妥善下载保存的情况下，如图8检查虚拟主机的基本信息，确认无误后请点击 **“创建”** 按钮。
+
+   .. figure:: /_figures/qingcloud/QingCloud-8.png
+      :scale: 50 %
+      :alt: 确认信息并创建虚拟主机
+
+      图8: 确认信息并创建虚拟主机
+
+   确认后，QingCloud 将会创建 |CL| 虚拟主机，您可以在新的界面中查看当前虚拟主机的状态。
+
+
+
+申请公网IP并添加到虚拟主机
+************************************
+   
+#. 由于 QingCloud 不会为使用默认网络创建的虚拟主机自动分配公网IP地址，所以我们需要手动申请，并添加到虚拟主机。如图9点击导航栏左侧的 **“网络与CDN”** 按钮。
+
+   .. figure:: /_figures/qingcloud/QingCloud-9.png
+      :scale: 50 %
+      :alt: 网络与CDN
+
+      图9: 网络与CDN
+
+   点击后，您将来到网络与CDN配置界面。
+
+#. 在新页面中，如图10点击左侧 **“公网IP”** 按钮，并点击中间的 **“申请”** 按钮以进行创建公网IP。
+
+   .. figure:: /_figures/qingcloud/QingCloud-10.png
+      :scale: 50 %
+      :alt: 申请创建公网IP
+
+      图10: 申请创建公网IP
+
+   点击申请后，将跳出提示栏，仔细阅读后按照图11点击 **“继续申请公网IP”** 按钮。
+
+   .. figure:: /_figures/qingcloud/QingCloud-11.png
+      :scale: 50 %
+      :alt: 提示栏确认
+
+      图11: 提示栏确认
+
+   之后将跳转到申请公网IP界面。
+
+#. 在申请公网IP页面中，如图12确认和填写相关信息，包括计费模式和带宽上限（本教程中使用的是流量计费模式并且设置了2Mbps的带宽上限），确认无误后点击 **“提交”** 按钮。
+
+   .. figure:: /_figures/qingcloud/QingCloud-13.png
+      :scale: 50 %
+      :alt: 确认提交公网IP申请
+
+      图12: 确认提交公网IP申请
+
+#. 之后如图13通过导航栏点击 **“计算”**、**“网卡”** 按钮来到网卡界面。
+
+   .. figure:: /_figures/qingcloud/QingCloud-13.png
+      :scale: 50 %
+      :alt: 网卡界面
+
+      图13: 网卡界面
+
+#. 在网卡界面，按照图14选中刚刚创建的 Clear Linux OS 主机的网卡，并点击上方 **“更多操作”** 按钮，再点击 **“绑定公网IPv4”** 按钮。
+
+   .. figure:: /_figures/qingcloud/QingCloud-14.png
+      :scale: 50 %
+      :alt: 绑定选中
+
+      图14: 绑定选中
+
+#. 在绑定公网IP确认界面，按照图15选择刚刚申请完成的公网IP地址，并点击下方 **“提交”** 按钮。 等待片刻后，状态将会变成图16中所示。
+
+   .. figure:: /_figures/qingcloud/QingCloud-15.png
+      :scale: 50 %
+      :alt: 提交绑定
+
+      图15: 提交绑定
+
+   .. figure:: /_figures/qingcloud/QingCloud-16.png
+      :scale: 50 %
+      :alt: 公网IP绑定成功
+
+      图16: 公网IP绑定成功
+
+
+连接到 |CL| 虚拟主机
+*****************************
+
+请您点击导航栏左侧 **“计算”**、**“主机”** 按钮，确认当前虚拟主机处于正在运行状态，且已绑定了公网IP地址。如图17所示。
+
+.. figure:: /_figures/qingcloud/QingCloud-17.png
+   :scale: 50 %
+   :alt: 确认虚拟主机当前处于正常状态
+
+   图17: 确认虚拟主机当前处于正常状态
+
+#. 复制当前 |CL| 虚拟主机的公网IP地址，并使用 SSH 客户端进行连接。 这里我们需要用到之前保存的 SSH 密钥。
+#. 在此教程中，以 MobaXterm 客户端为例演示登录过程。请如图18检查各项。用户名我们选择 **root**，密钥请选择之前下载并保存到本地的 SSH 密钥。
+
+   .. figure:: /_figures/qingcloud/QingCloud-18.png
+      :scale: 50 %
+      :alt: SSH 登录虚拟主机设置
+
+      图18: SSH 登录虚拟主机设置
+
+#. 设置成功后，点击登录即可登录到 |CL| 虚拟主机。
+   
+   .. figure:: /_figures/qingcloud/QingCloud-19.png
+      :scale: 50 %
+      :alt: SSH 登录成功
+
+      图19: SSH 登录成功
+
+
+删除 |CL| 虚拟主机
+*************************
+
+本章节介绍如何在 QingCloud 上删除所创建的 |CL| 虚拟主机。
+
+#. 通过左侧导航栏依次选择 **“计算”**、**“主机”** 后，找到刚刚创建的 Clear Linux OS 主机，如图20所示选中此主机，再点击上方 **“更多操作”** 按钮选择 **“删除”**，即可删除虚拟主机。
+
+   .. figure:: /_figures/qingcloud/QingCloud-20.png
+      :scale: 50 %
+      :alt: |CL| 虚拟主机
+
+      图20: 删除 |CL| 虚拟主机
+
+
+删除申请的公网IP
+*****************
+
+本章节介绍如何在 QingCloud 上删除所申请的公网IP地址。
+
+#. 通过左侧导航栏依次选择 **“网络与CDN”**、**“公网IP”** 后，找到刚刚申请的公网IP地址，如图21所示选中此项目，再点击上方 **“更多操作”** 按钮选择 **“删除”**，即可删除。
+
+   .. figure:: /_figures/qingcloud/QingCloud-21.png
+      :scale: 50 %
+      :alt: 删除公网IP地址
+
+      图21: 删除公网IP地址

source/get-started/virtual-machine-install/proxmox.rst

@@ -0,0 +1,209 @@
+.. _proxmox:
+
+|CL-ATTR| on Proxmox\* Virtual Environment 
+##########################################
+
+This guide explains how to create a new VM in Proxmox VE 6.1-3, install and run |CL| on as a guest OS.
+
+.. contents::
+   :local:
+   :depth: 1
+
+Prerequisites
+*************
+
+* Proxmox VE 6.1-3 server already set up and you have familiarity with how 
+  to use it.
+
+Download the Latest |CL| Live Server Image
+******************************************
+
+#. Visit our `Downloads`_ page.
+
+#. Download the file :file:`clear-<release number>-live-server.iso`,
+   also called the |CL| Server.
+
+   .. note::
+
+      <release-number> is the latest |CL| auto-numbered release.
+
+Upload |CL| Live Server Image to Promox Server
+**********************************************
+
+#. Connect to your Proxmox server and log into an account with sufficient
+   permission to create and manage VMs.
+
+#. Under the :guilabel:`Server View` window, select the :guilabel:`local` 
+   storage.  See Figure 1.
+
+#. On the right window, click :guilabel:`Upload`.
+
+   .. figure:: ../../_figures/proxmox/proxmox-01.png
+      :scale: 100%
+      :alt: Proxmox - Upload ISO
+
+      Figure 1: Proxmox - Upload ISO
+
+#. Set the :guilabel:`Content` as `ISO image`. See Figure 2.
+
+#. Click :guilabel:`Select File...` and select the |CL| ISO.
+
+#. Click :guilabel:`Upload`.
+
+   .. figure:: ../../_figures/proxmox/proxmox-02.png
+      :scale: 100%
+      :alt: Proxmox - Select ISO to upload
+
+      Figure 2: Proxmox - Select ISO to upload
+
+   The ISO should now appear in the :guilabel:`Content` list.  See Figure 3.
+
+   .. figure:: ../../_figures/proxmox/proxmox-03.png
+      :scale: 100%
+      :alt: Proxmox - Content list
+
+      Figure 3: Proxmox - Content list
+
+Create VM on Proxmox 
+********************
+
+#. Under the :guilabel:`Server View` window, select your Proxmox node.
+   See Figure 4.
+
+#. On the right window, click :guilabel:`Create VM`.
+
+   .. figure:: ../../_figures/proxmox/proxmox-04.png
+      :scale: 100%
+      :alt: Proxmox - Create VM
+
+      Figure 4: Proxmox - Create VM
+
+#. In the :guilabel:`General` tab:
+   | See Figure 5.
+  
+   a. Check the :guilabel:`Advanced` checkbox. 
+ 
+   #. In the :guilabel:`Name` field, give the VM a name.
+
+   .. figure:: ../../_figures/proxmox/proxmox-05.png
+      :scale: 100%
+      :alt: Proxmox - Create VM - General settings
+
+      Figure 5: Proxmox - Create VM - General settings
+
+#. In the :guilabel:`OS` tab:
+   See Figure 6.
+
+   a. Select :guilabel:`Use CD/DVD disc image file (iso)`.
+   
+   #. For :guilabel:`Storage`, select :guilabel:`local`.
+
+   #. For :guilabel:`ISO image`, select the |CL| ISO you uploaded earlier.
+
+   #. Set the :guilabel:`Type` to :guilabel:`Linux`.
+  
+   #. Set the :guilabel:`Version` to :guilabel:`5.x - 2.6 kernel`.
+
+   .. figure:: ../../_figures/proxmox/proxmox-06.png
+      :scale: 100%
+      :alt: Proxmox - Create VM - OS settings
+
+      Figure 6: Proxmox - Create VM - OS settings
+
+#. In the :guilabel:`System` tab:
+   See Figure 7.
+   
+   a. For :guilabel:`BIOS`, select :guilabel:`OVMF (UEFI)`.
+   
+   #. For :guilabel:`Storage`, select an appropriate location.
+   
+   #. For :guilabel:`Machine`, select :guilabel:`q35`.
+
+   .. figure:: ../../_figures/proxmox/proxmox-07.png
+      :scale: 100%
+      :alt: Proxmox - Create VM - System settings
+
+      Figure 7: Proxmox - Create VM - System settings
+
+#. In the :guilabel:`Hard Disk` tab:
+   See Figure 8.
+   
+   a. For :guilabel:`Disk size (GiB)`, set the desired disk size for your VM.  
+      A minimum of 4GB is required for |CL|.   
+
+   .. figure:: ../../_figures/proxmox/proxmox-08.png
+      :scale: 100%
+      :alt: Proxmox - Create VM - Hard Disk settings
+
+      Figure 8: Proxmox - Create VM - Hard Disk settings
+
+#. In the :guilabel:`CPU` tab:
+   See Figure 9.
+
+   a. Set the :guilabel:`Type` to :guilabel:`host`.
+
+   #. For the :guilabel:`Extra CPU Flags`, scroll to the bottom and turn on the 
+      :guilabel:`aes` setting by clicking the :guilabel:`+` radio button.
+
+   .. figure:: ../../_figures/proxmox/proxmox-09.png
+      :scale: 100%
+      :alt: Proxmox - Create VM - CPU settings
+
+      Figure 9: Proxmox - Create VM - CPU settings
+
+#. In the :guilabel:`Memory` tab:
+   See Figure 10.
+
+   a. For :guilabel:`Memory (MiB)`, set a desired value.
+
+   .. figure:: ../../_figures/proxmox/proxmox-10.png
+      :scale: 100%
+      :alt: Proxmox - Create VM - Memory settings
+
+      Figure 10: Proxmox - Create VM - Memory settings
+
+#. In the :guilabel:`Network` tab:
+   See Figure 11.
+
+   a. For :guilabel:`Model`, select :guilabel:`E1000`.
+
+   .. figure:: ../../_figures/proxmox/proxmox-11.png
+      :scale: 100%
+      :alt: Proxmox - Create VM - Network settings
+
+      Figure 11: Proxmox - Create VM - Network settings
+
+#. In the :guilabel:`Confirm` tab:
+   See Figure 12.
+
+   a. Confirm the settings.
+
+   #. Click :guilabel:`Finish` to create the VM.  The new VM should appear 
+      under the :guilabel:`Server View` window.  
+   
+   .. figure:: ../../_figures/proxmox/proxmox-12.png
+      :scale: 100%
+      :alt: Proxmox - Create VM - Confirm settings
+
+      Figure 12: Proxmox - Create VM - Confirm settings
+
+Start VM and Install |CL| on Promox
+***********************************
+
+#. Under the :guilabel:`Server View` window, select your newly-created VM.
+   See Figure 13.
+
+#. On the right window, click :guilabel:`Start`.
+
+#. Click :guilabel:`Console` button to bring up a console and interact with it.
+
+   .. figure:: ../../_figures/proxmox/proxmox-13.png
+      :scale: 100%
+      :alt: Proxmox - Start VM
+
+      Figure 13: Proxmox - Start VM
+
+#. Follow the instructions in the :ref:`bare-metal-install-server` guide 
+   starting at the `Launch the Clear Linux OS Installer` section.
+
+.. _Downloads: https://clearlinux.org/downloads

source/guides/clear/mixer.rst

@@ -296,14 +296,14 @@ inherit upstream bundles.
 
    .. code-block:: bash
 
-      mixer build bundles
+      sudo mixer build bundles
 
 #. First, browse to web server from Example 1. The web page appears yet
    has no update content. Build the update content:
 
    .. code-block:: bash
 
-      mixer build update
+      sudo mixer build update
 
    After that is completed, on your web server, you can see the update
    content for mix version 10.
@@ -330,15 +330,15 @@ Next, let’s create a new version of the mix. We’ll add a new bundle.
 
    .. code-block:: bash
 
-      mixer build bundles
-      mixer build update
+      sudo mixer build bundles
+      sudo mixer build update
 
 #. Optionally, you can build delta-packs, which help reduce client update
    time:
 
    .. code-block:: bash
 
-      mixer build delta-packs --from 10 --to 20
+      sudo mixer build delta-packs --from 10 --to 20
 
 Refresh your web server to see the update content for mix version 20.
 
@@ -559,7 +559,7 @@ bundle that we added to our mix in Example 2.
 
    .. code-block:: bash
 
-      mixer build all
+     sudo mixer build all
 
    .. note::
       :command:`mixer build all` runs both :command:`mixer build bundles` and :command:`mixer build update` in one step.
@@ -658,15 +658,8 @@ customizations during the update, such as:
 
 * Change the content of the chroot
 
-Tutorial
---------
-
-Try this tutorial to learn how to manually do a format bump. Read the
-comments above each line for an explanation of each step as you execute
-commands. Use this same process on your mix if you need to remove a bundle
-and its tracking.
-
-The `afb.sh reference script`_ shows an example of how to:
+Use the `afb.sh reference script`_ to learn how to do a manual format bump.
+The :file:`afb.sh` script shows an example of how to:
 
 * Create a mix
 
@@ -676,6 +669,11 @@ The `afb.sh reference script`_ shows an example of how to:
 
 * Do a format bump to remove the deprecated bundle
 
+Read the comments above each line for an explanation of each step as you
+execute commands. Use this same process on your mix if you need to remove a
+bundle and its tracking.
+
+
 
 .. Example: Create a mix with custom RPM
 .. -------------------------------------

source/guides/kernel/firmware.rst

@@ -23,22 +23,33 @@ provided as binary blobs which are licensed for free or non-free use.
 In |CL| firmware is loaded during device initialization which typically
 happens at boot time. 
 
+.. _firmware-included-begin:
 
 Included firmware
 *****************
 
 The Linux kernel project contains a repository for firmware binaries that are
-licensed to allow free redistribution. |CL| packages these firmware binaries
-in the `linux-firmware bundles
-<https://clearlinux.org/software?search_api_fulltext=linux-firmware>`_ and
-automatically includes them with the kernel.
-
-The Linux kernel's firmware repository can be found here:
+licensed to allow free redistribution. The Linux kernel's firmware repository
+can be found here:
 https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git
 
 If the firmware for your device is included upstream, no action is required
 for it to be automatically detected and loaded. 
 
+|CL| packages these firmware binaries
+in the `linux-firmware bundles
+<https://clearlinux.org/software?search_api_fulltext=linux-firmware>`_ and
+automatically includes them with the kernel. 
+
+You can double-check the linux-firmware bundle is installed with the commands below:
+
+   .. code-block:: bash
+
+      sudo swupd bundle-add linux-firmware
+      find /lib/firmware/
+
+
+
 
 Additional firmware loading
 ***************************

source/guides/kernel/kernel-modules-dkms.rst

@@ -16,7 +16,7 @@ Overview
 Certain kernel modules are enabled by default in |CL-ATTR|. To use additional
 kernel modules that are not part of the Linux source tree, you may need to
 build out-of-tree kernel modules. Use this guide to add kernel modules with
-:abbr:`DKMS (Dynamic Kernel Module System)` or refer to :ref:`kernel-modules`.
+DKMS or refer to :ref:`kernel-modules`.
 
 Description
 ***********
@@ -26,9 +26,9 @@ into the Linux kernel to add functionality, such as a hardware driver.
 Kernel modules may already be part of the Linux source tree (in-tree) or may
 come from an external source, such as directly from a vendor (out-of-tree).
 
-:abbr:`DKMS (Dynamic Kernel Module System)` is a framework that facilitates
-the building and installation of kernel modules. DKMS allows |CL| to provide
-hooks that automatically rebuild modules against new kernel versions.
+DKMS is a framework that facilitates the building and installation of kernel
+modules. DKMS allows |CL| to provide hooks that automatically rebuild modules
+against new kernel versions.
 
 .. include:: kernel-modules.rst
    :start-after: kernel-modules-availability-begin:
@@ -39,7 +39,7 @@ Install DKMS
 
 .. _kernel-modules-dkms-install-begin:
 
-The :command:`kernel-native-dkms` bundle provides the :command:`dkms` program and
+The :command:`kernel-native-dkms` bundle provides the DKMS program and
 Linux kernel headers, which are required for compiling kernel modules.
 
 The :command:`kernel-native-dkms` bundle also:

source/guides/maintenance/cpu-performance.rst

@@ -193,6 +193,52 @@ group:
    After adding a new group, you must log out and log back in for the new group
    to take effect.
 
+Enhanced thermal configuration
+===============================
+
+Better thermal control and performance can be achieved by providing platform
+specific configuration to thermald.
+
+`Linux DPTF Extract Utility`_ is a companion tool to thermald, This tool can
+make use of :abbr:`Intel® Dynamic Platform and Thermal Framework (`Intel DPTF)`
+technology, and convert to the thermal_conf.xml configuration format used
+by thermald. It's a closed-source project, and unable to be packaged as bundle
+in Clear Linux OS, so we need to follow below steps to generate configuration.
+
+Intel DPTF requires BIOS support, it's typically used by laptops.
+The first step is to make sure your machine's BIOS has DPTF feature
+and is enabled.
+
+Then generate thermal configuration as below:
+
+.. code:: bash
+
+   sudo swupd bundle-add acpica-unix2  # install acpi tools
+   git clone https://github.com/intel/dptfxtract.git
+   cd dptfxtract
+   sudo acpidump > acpi.out
+   acpixtract -a acpi.out
+   sudo ./dptfxtract *.dat
+
+thermald configuration files will be generated and saved to
+:command:`/etc/thermal/` folder. Restart thermald service to take effect.
+
+.. code:: bash
+
+   sudo systemctl restart thermald.service
+
+check whether the configuration is in used.
+
+.. code:: bash
+
+   sudo systemctl status thermald.service
+
+if the output contains below line, it means configuration already applied:
+
+.. code:: bash
+
+   thermald[*]: [WARN]Using generated /etc/thermald/thermal-conf.xml.auto
+
 
 .. _`Intel P-state driver`: https://www.kernel.org/doc/Documentation/cpu-freq/intel-pstate.txt
 
@@ -205,3 +251,7 @@ group:
 .. _`ThermalMonitor`: https://github.com/intel/thermal_daemon/tree/master/tools/thermal_monitor
 
 .. _`Intel® Turbo Boost Technology`: https://www.intel.com/content/www/us/en/architecture-and-technology/turbo-boost/turbo-boost-technology.html
+
+.. _`Linux DPTF Extract Utility`: https://github.com/intel/dptfxtract
+
+.. _`Intel DPTF`: https://software.intel.com/en-us/articles/2-in-1-tablet-mode-game-performance-with-intel-dynamic-platform-and-thermal-framework-intel

source/guides/maintenance/fix-broken-install.rst

@@ -3,7 +3,8 @@
 Fix a broken installation
 #########################
 
-This guide explains how to fix a broken installation of |CL-ATTR| using a live desktop image on a USB.
+This guide explains how to fix a broken installation of |CL-ATTR| using a live 
+desktop image on a USB.
 
 .. contents::
    :local:
@@ -16,7 +17,9 @@ This guide assumes you have installed |CL| on a target system, but the OS
 does not boot or function properly.
 
 The process described in this guide can only verify and fix files that
-:ref:`swupd<swupd-guide>` owns in :file:`/usr` and :file:`/var`. Files outside of this path, such as :file:`/home/`, :file:`/etc`, etc., cannot be repaired by this process.
+:ref:`swupd<swupd-guide>` owns in :file:`/usr` and :file:`/var`. Files outside 
+of this path, such as :file:`/home/`, :file:`/etc`, etc., cannot be 
+repaired by this process.
 
 Prerequisites
 *************
@@ -34,35 +37,66 @@ Boot a live desktop image to fix target system
 Mount root partition, verify, and fix
 *************************************
 
-#. Open a Terminal window.
-
 #. Ensure the system is connected to the network.
 
-#. Mount the system’s root partition.
+#. Open a terminal window.
 
-   #. To find the root partition, run:
+#. Find the |CL| root partition by using the :command:`lsblk` command with
+   these options: ``-o NAME,LABEL,PARTTYPE,PARTLABEL``.
 
-      .. code-block:: bash
+   .. code-block:: bash
 
-         lsblk -o NAME,LABEL,PARTTYPE,PARTLABEL
+      lsblk -o NAME,LABEL,PARTTYPE,PARTLABEL
 
-      We'll use :file:`/dev/sda3/` as the root partition example.
+   Example output:
 
-   #. Next, mount the root partition to the :file:`/mnt` folder.
+   .. code-block:: console
+      :emphasize-lines: 10
 
-      .. code-block:: bash
+      clrlinux@clr-live~ $ lsblk -po NAME,SIZE,LABEL,PARTTYPE,PARTLABEL
+      NAME          SIZE LABEL       PARTTYPE                             PARTLABEL
+      /dev/loop0  643.6M                                                  
+      /dev/sda     14.3G CLR_ISO                                          
+      ├─/dev/sda1   835M CLR_ISO     0x0                                  
+      └─/dev/sda2   100M "CLEAR_EFI" 0xef                                 
+      /dev/sdb     74.5G                                                  
+      ├─/dev/sdb1   142M boot        c12a7328-f81f-11d2-ba4b-00a0c93ec93b EFI
+      ├─/dev/sdb2   244M swap        0657fd6d-a4ab-43c4-84e5-0933c84b4f4f linux-swap
+      └─/dev/sdb3  74.2G root        4f68bce3-e8cd-4db1-96e7-fbcaf984b709 /
 
-         sudo mount /dev/sda3 /mnt
+   In the example above, ``/dev/sdb3/`` is the root partition.  
 
-#. Verify that you mounted the correct root partition by checking for some
-   files commonly found on |CL| systems.
+#. Next, mount the root partition.
+
+   .. code-block:: bash
+
+      sudo mount /dev/sdb3 /mnt
+
+#. Verify that you mounted the correct root partition by verifying the content
+   of ``/usr/lib/os-release`` looks similar to the example below.  
 
    .. code-block:: bash
 
       cat /mnt/usr/lib/os-release
-      ls /mnt/usr/share/clear/bundles
 
-#. Next, run swupd to fix any issues on the target system.
+   Example output:
+
+   .. code-block:: console
+
+      clrlinux@clr-live~ $ cat /mnt/usr/lib/os-release 
+      NAME="Clear Linux OS"
+      VERSION=1
+      ID=clear-linux-os
+      ID_LIKE=clear-linux-os
+      VERSION_ID=32150
+      PRETTY_NAME="Clear Linux OS"
+      ANSI_COLOR="1;35"
+      HOME_URL="https://clearlinux.org"
+      SUPPORT_URL="https://clearlinux.org"
+      BUG_REPORT_URL="mailto:dev@lists.clearlinux.org"
+      PRIVACY_POLICY_URL="http://www.intel.com/privacy"
+
+#. Next, run :command:`swupd` to fix any issues on the target system.
 
    .. code-block:: bash
 
@@ -82,5 +116,3 @@ Mount root partition, verify, and fix
    .. code-block:: bash
 
       sudo reboot
-
-**Congratulations!** You successfully restored |CL|.

source/guides/network/time.rst

@@ -45,7 +45,7 @@ the default :abbr:`NTP (Network Time Protocol)` servers cannot be reached.
 
    .. code-block:: bash
 
-      timedatectl set-ntp true
+      sudo timedatectl set-ntp true
 
 .. note::
 

source/guides/network/wifi.rst

@@ -78,6 +78,8 @@ CLI (Command Line Interface)
 
    To avoid having the Wi-Fi password stored in bash history, consider using the TUI.
 
+.. _wifi-nm-tui:
+
 TUI (Text-based User Interface)
 ===============================
 

source/guides/stacks/dbrs.rst

@@ -619,7 +619,7 @@ To start a redisfailover instance in Kubernetes run the following
 
 .. _Quick Start Guide: https://software.intel.com/en-us/articles/quick-start-guide-configure-intel-optane-dc-persistent-memory-on-linux
 
-.. _Managing NVDIMMs: https://docs.pmem.io/ndctl-users-guide/managing-nvdimms
+.. _Managing NVDIMMs: https://docs.pmem.io/ndctl-user-guide/managing-nvdimms
 
 .. _Configure, Manage, and Profile: https://software.intel.com/en-us/articles/configure-manage-and-profile-intel-optane-dc-persistent-memory-modules
 
@@ -645,7 +645,7 @@ To start a redisfailover instance in Kubernetes run the following
 
 .. _Intel Optane DC PMM: https://www.intel.com/content/www/us/en/architecture-and-technology/optane-technology/optane-for-data-centers.html
 
-.. _pmem-csi: https://github.com/intel/pmem-csi/blob/release-0.5/README.md
+.. _pmem-csi: https://github.com/intel/pmem-csi/blob/release-0.6/README.md
 
 .. _DBRS Terms of Use: https://clearlinux.org/stacks/database/terms-of-use
 

source/guides/stacks/dlrs.rst

@@ -378,95 +378,6 @@ We provide `DLRS PytorchJob`_ examples that use the Deep Learning Reference Stac
 
 
 
-Using Kubeflow Seldon and OpenVINO* with the Deep Learning Reference Stack
-**************************************************************************
-
-`Seldon Core`_  is an open source platform for deploying machine learning models on a Kubernetes cluster.  Seldon Core is supported in the `DLRS V4.0`_ release.
-
-Pre-requisites
-==============
-* A running :ref:`kubernetes` cluster
-
-.. note::
-
-   Instead of using Arrikto's configuration manifest as shown  in the preceding example, you should use the manifest provided by `Istio`_, for this example, as Seldon deployments depend on it.
-
-#. Install deployment tools
-
-   .. code-block:: bash
-
-      INSTALL_DIR=$HOME/install_dir
-      BIN_DIR=${INSTALL_DIR}/bin
-      SRC_DIR=${INSTALL_DIR}/source
-      export PATH=${BIN_DIR}:$PATH
-
-      mkdir -p ${BIN_DIR} && mkdir ${SRC_DIR}
-      cd ${SRC_DIR}
-
-#. Install Helm*
-
-   .. code-block:: bash
-
-      wget https://get.helm.sh/helm-v2.14.3-linux-amd64.tar.gz && tar xf helm-v2.14.3-linux-amd64.tar.gz
-      mv linux-amd64/helm ${BIN_DIR}/helm
-
-
-#. Clean the environment
-
-   .. code-block:: bash
-
-      rm -rf ${SRC_DIR}/*
-
-#. Prepare the DLRS image
-
-   The DLRS base image needs to be rebuilt with the `Dockerfile_openvino_base`_  to add Seldon and the OpenVINO inference engine.
-
-   .. code-block:: bash
-
-      docker build -f Dockerfile_openvino_base -t dlrs_openvino_base:0.1 .
-
-#. Mount pre-trained models into a persistent volume
-
-   This will also apply all PV manifests to the cluster
-
-   .. code-block:: bash
-
-      kubectl apply -f storage/pv-volume.yaml
-      kubectl apply -f storage/model-store-pvc.yaml
-      kubectl apply -f storage/pv-pod.yaml
-
-#. Start a shell for the container used as pv:
-
-   .. code-block:: bash
-
-      kubectl exec -it hostpath-pvc -- /bin/bash
-
-#. Save pre-trained models
-
-   Now that you're inside the running container, fetch your pre-trained models and save them at `/opt/ml`
-
-   .. code-block:: bash
-
-      root@hostpath-pvc:/# cd /opt/ml
-      root@hostpath-pvc:/# # Copy your models here
-      root@hostpath-pvc:/# # exit
-
-#. Deploy the model server
-
-   Now you're ready to deploy the model server using the Helm chart provided.
-
-   .. code-block:: bash
-
-       helm install -- name=seldonov-model-server \
-          --namespace kubeflow \
-          --set openvino.image=dlrs_openvino_base:0.1 \
-          --set openvino.model.path=/opt/ml/<models_directory> \
-          --set openvino.model.name=<model_name> \
-          --set openvino.model.input=data \
-          --set openvino.model.output=prob
-          dlrs-seldon/helm/seldon-model-server
-
-
 
 Using the Intel® OpenVINO Model Optimizer
 *****************************************
@@ -998,7 +909,7 @@ Related topics
 
 .. _DLRS Terms of Use: https://clearlinux.org/stacks/deep-learning/terms-of-use
 
-.. _DLRS Release notes: https://github.com/clearlinux/dockerfiles/blob/master/stacks/dlrs/releasenote.md
+.. _DLRS Release notes: https://github.com/intel/stacks/tree/master/dlrs
 
 .. _Seldon Core: https://docs.seldon.io/projects/seldon-core/en/latest/
 

source/index.rst

@@ -1,61 +1,78 @@
 .. _clear-linux:
 
-|CL-PRJ|
+|CL-PRJ| Documentation
 #############################################
 
-Welcome to the |CL-ATTR| documentation pages, the source for |CL| documentation.
+.. container:: multicolumns
 
-Our documentation is divided into the following sections:
+   .. container:: column verticalcard
+
+      .. rst-class:: colh2
+
+      Highlights
+
+      :ref:`autospec`
+         **autospec** is a tool to assist in the automated creation and
+         maintenance of RPM packaging in Clear Linux OS. 
+
+      :ref:`dlrs`
+         This tutorial shows you how to run benchmarking workloads in Clear
+         Linux OS using TensorFlow\* or PyTorch\* with the Deep Learning
+         Reference Stack.
+
+      :ref:`docker`
+         Clear Linux OS supports multiple containerization platforms,
+         including a Docker solution.
+
+      :ref:`developer-workstation`      
+         Developer Workstation helps you find the Bundles you need to start
+         your Clear Linux OS development project.
+
+   .. container:: column verticalcard
+
+      .. rst-class:: colh2
+
+      Quicklinks
+
+      :ref:`get-started`
+         Get up and running fast with Clear Linux\* OS. Use these step-by-step
+         instructions to guide you through the installation of Clear Linux OS
+         from bare metal to live image.
+
+      :ref:`bare-metal-install-desktop`
+         These instructions guide you through the installation of Clear Linux
+         OS on bare metal using a bootable USB drive.
+
+      :ref:`architect-lifecycle`
+         This guide provides DevOps with a model to architect the life-cycle
+         of a Clear Linux OS derivative that integrates custom software and
+         content using distinct workflows.
+
+      :ref:`bundles`
+         Useful bundle commands for working with bundles on the Clear Linux OS.
+
+   .. container:: column featurecard
+
+      **Community**
+
+      | `Ask the Clear Linux experts <https://clearlinux.org/community/mailing-list>`_
+      | `Clear Linux Forum <https://community.clearlinux.org/>`_
+      | `Freenode IRC: #clearlinux <https://webchat.freenode.net/#clearlinux>`_
 
 
-:ref:`get-started`
+.. container:: video
 
-    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.
+   .. raw:: html
 
-:ref:`about`
+      <iframe width="100%" height="100%" src="https://www.youtube.com/embed/JFg-_5xihkE" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen style="padding:10px; background-color: #fff;"></iframe>
 
-    |CL| is different from other Linux distributions.
+.. toctree:: 
+   :hidden:
 
-    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.
-
-    .. 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 style="padding:10px; background-color: #fff;"></iframe>
-
-:ref:`guides`
-
-    Guides cover a range of topics from |CL| features and tooling, to system
-    maintenance, network, and stacks.
-
-:ref:`Use case tutorials <tutorials>`
-
-    Sample use cases, with step-by-step instructions, show how to set up
-    third-party tools and software with |CL|.
-
-:ref:`reference`
-
-    This section provides additional reference information on the |CL| project.
-
-:ref:`faq`
-
-    The FAQ section provides answers to commonly asked questions about |CL|.
-
-:ref:`collaboration`
-
-    This section describes how to contribute to |CL| documentation.
-
-.. toctree::
-    :maxdepth: 2
-    :hidden:
-
-    get-started/index
-    about
-    guides/index
-    tutorials/index
-    reference/index
-    FAQ/index
-    collaboration/collaboration
+   get-started/index
+   about
+   guides/index
+   tutorials/index
+   reference/index
+   FAQ/index
+   collaboration/collaboration

source/reference/image-types.rst

@@ -55,32 +55,37 @@ Table 2 lists the currently available images that are platform specific.
      - Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform.
 
    * - azure-docker.vhd
-     - Virtual Hard Disk for use on Microsoft Azure cloud platform with Docker\* pre-installed.
+     - Virtual Hard Disk for use on Microsoft Azure cloud platform with
+       Docker\* pre-installed.
 
    * - azure-machine-learning.vhd
-     - Virtual Hard Disk for use on Microsoft Azure cloud platform with the `machine-learning-basic` bundle installed.
+     - Virtual Hard Disk for use on Microsoft Azure cloud platform with the
+       `machine-learning-basic` bundle installed.
 
    * - cloudguest.img
-     - Image with generic cloud guest virtual machine (VM) requirements installed.
+     - Image with generic cloud guest virtual machine (VM) requirements
+       installed.
 
    * - gce.tar
      - Image with the Google Compute Engine (GCE) specific kernel.
 
    * - hyperv.vhdx
-     - Virtual Hard Disk for use with Microsoft Hyper-V\* hypervisor. Includes `optimized kernel`_ for Hyper-V.
+     - Virtual Hard Disk for use with Microsoft Hyper-V\* hypervisor. Includes
+       :ref:`optimized kernel <vm-kernels>` for Hyper-V.
 
    * - kvm.img
      - Image for booting in a simple VM with start_qemu.sh. Includes
-       `optimized kernel`_ for KVM.
+       :ref:`optimized kernel <vm-kernels>` for KVM.
 
    * - kvm-legacy.img
-     - Image for booting in a simple VM using legacy BIOS, if using start_qemu.sh make sure to remove -bios parameter.
+     - Image for booting in a simple VM using legacy BIOS, if using
+       start_qemu.sh make sure to remove -bios parameter.
 
    * - pxe.tar
      - Image suitable for use with PXE server.
 
    * - vmware.vmdk
-     - Virtual Machine Disk for VMware\* platforms including Player, Workstation, and ESXi.
+     - Virtual Machine Disk for VMware\* platforms including Player,
+       Workstation, and ESXi.
 
 .. _images: https://clearlinux.org/downloads
-.. _`optimized kernel`: https://clearlinux.org/documentation/clear-linux/reference/compatible-kernels

source/reference/system-requirements.rst

@@ -4,8 +4,10 @@ Recommended minimum system requirements
 #######################################
 
 |CL-ATTR| can run on most modern hardware and is capable of running with
-modest hardware resources. Out of the box, |CL| can run on a single CPU core, 1
-GB RAM, and 2 GB of disk space.
+modest hardware resources. Out of the box, |CL| can run on a single CPU core, 1 GB RAM, and minimum of disk space of: 
+
+* 4 GB for the *live server*
+* 20 GB for the *live desktop*
 
 For use cases requiring minimal resources, |CL| :ref:`about <about>` can
 be used to create a highly customized installation that can even run on a

source/tutorials/broadcom.rst

@@ -0,0 +1,238 @@
+.. _broadcom:
+
+Broadcom\* Drivers
+##################
+
+Broadcom manufactures wireless network interfaces, including devices that
+support WiFi and Bluetooth. 
+
+Broadcom wireless devices on Linux\* have a lot of different combinations of
+possible required software depending on the exact model of your device. These
+combinations of software can overlap and conflict, creating an additional
+challenge to get working.
+
+As with most hardware devices, two components are needed for complete
+functionality: a device driver and device firmware. These instructions show
+how to identify Broadcom wireless hardware and configure a |CL| system with
+the correct drivers and firmware for functionality. 
+
+.. important::
+
+   The Linux community has documented solutions and caveats for using specific
+   Broadcom devices on Linux over time. It is worth doing research on your
+   particular device model to see what others have already encountered.
+
+.. contents:: :local:
+    :depth: 1
+
+
+Identify your device model
+**************************
+
+Broadcom device models start with BCM in the name and are identified by the
+PCI vendor ID 14e4. To identify the exact model of Broadcom device you have
+installed:
+
+#. Run the commands below:
+
+   .. code-block:: bash
+
+      lspci -vnn -d 14e4:
+
+Once the device model has been identified, you can cross-reference which
+drivers support it.
+
+
+Drivers
+*******
+
+brcmfmac and brcmsmac
+=====================
+
+*brcmfmac* and *brcmsmac*, historically known as *brcm80211*, are open-source
+drivers for some newer Broadcom devices. These drivers are available in the
+upstream Linux kernel, are enabled in the |CL| kernels, and will be
+automatically loaded if a compatible device is detected. 
+
+#. See if your device is listed on the support matrix of this driver:
+   https://wireless.wiki.kernel.org/en/users/Drivers/brcm80211#supported_chips
+
+   It is important to note that not all functionality is developed for these
+   drivers yet. If you are looking for specific functionality, be sure to
+   review the "To be done" list.
+
+#. The firmware for cards supported by the *brcmfmac* and *brcmsmac* drivers
+   are usually made available. Continue reading the `Firmware`_ section of
+   this document.
+
+
+b43 and b43legacy
+=================
+
+*b43* and *b43legacy* are community reverse-engineered open-source drivers for
+some newer and older Broadcom devices. These drivers are available in the
+upstream Linux kernel, are enabled in the |CL| kernels, and will be
+automatically loaded if a compatible device is detected. 
+
+#. See if your device is listed on the support matrix of this driver:
+   https://wireless.wiki.kernel.org/en/users/Drivers/b43#list_of_hardware
+
+#. The firmware for cards supported by the *b43* and *b43legacy* drivers
+   usually needs to be sourced and installed manually. Continue reading the
+   `Firmware`_ section of this document.
+
+
+broadcom-wl
+===========
+
+*broadcom-wl*, also known as *broadcom-sta* or *wl*, is the proprietary closed
+source driver from Broadcom and tends to work only for older devices. It is
+also unmaintained and needs to be patched to work with newer kernels (>=4.7).
+As such, it is not part of the Linux kernel, cannot be distributed by |CL|,
+and has to be built as an out-of-tree kernel module.
+
+.. note::
+
+   It is recommended to use the :ref:`LTS kernel <compatible-kernels>` if you
+   have to use this driver.
+
+#. See if your device is supported and download the **Linux® STA 64-bit
+   driver** from
+   `Broadcom's download website
+   <https://www.broadcom.com/support/download-search?pg=&pf=Wireless+LAN+Infrastructure>`_
+   or another trusted source.
+   
+   
+#. Extract the downloaded archive into a separate folder. For example:
+   
+   .. code-block:: bash
+
+      mkdir ./broadcom-wl/
+      tar xvf ./hybrid-v35_64-nodebug-pcoem-6_30_223_271.tar.gz -C broadcom-wl/
+      cd ./broadcom-wl/
+   
+#. Create a patches folder in the source tree and copy any necessary patches
+   to it. You will have to research which specific set of patches are required
+   for the running kernel version. The `gentoo repository for broadcom-sta
+   <https://github.com/gentoo/gentoo/tree/master/net-wireless/broadcom-sta/files>`_
+   is a good place to start looking for up-to-date patches.
+
+   .. code-block:: bash
+      
+      mkdir ./patches/
+
+#. :ref:`Install the DKMS bundle <kernel-modules-dkms-install-begin>` for your
+   kernel. DKMS provides the framework to automatically rebuild the wl driver
+   against new kernels versions from |CL| updates.
+
+#.  In the extracted driver directory, create a :file:`dkms.conf` file based
+    the contents below to provide DKMS information about how to build and
+    install the kernel module. This example uses version *6.30.223.271*.
+
+    .. code-block:: bash
+
+       cat <<'EOF' >> dkms.conf
+       PACKAGE_NAME=broadcom-wl
+       PACKAGE_VERSION=6.30.223.271
+       MAKE="make KBASE=/lib/modules/${kernelver}"
+       CLEAN="make KBASE=/lib/modules/${kernelver} clean"
+       BUILT_MODULE_NAME=wl
+       DEST_MODULE_LOCATION=/kernel/drivers/net/wireless
+       AUTOINSTALL=yes
+       EOF
+
+#. Add the filename of any patches previously added to the :file:`patches`
+   folder to the :file:`dkms.conf` file so that DKMS applies them to the
+   driver source before building. Below are example patch names to show the
+   format used in :file:`dkms.conf`.
+
+   .. code-block:: bash
+
+      echo "PATCH[0]="first.patch" >> dkms.conf
+      echo "PATCH[1]="second.patch" >> dkms.conf
+      echo "PATCH[2]="third.patch" >> dkms.conf
+
+#. Copy the directory to the dkms tree. This example uses version
+   *6.30.223.271*.
+
+   .. code-block:: bash
+
+      sudo cp -Rv . /usr/src/broadcom-wl-6.30.223.271
+
+#. Run the :command:`dkms` commands to add the broadcom-wl module to the dkms
+   tree, build it, and install it. This example uses version *6.30.223.271*.
+
+   .. code-block:: bash
+
+      sudo dkms add -m broadcom-wl -v 6.30.223.271
+      sudo dkms install -m broadcom-wl -v 6.30.223.271
+
+#. Blacklist all other variations of Broadcom drivers from loading to prevent
+   conflicts and problems.
+
+   .. code-block:: bash
+
+      sudo mkdir -p /etc/modprobe.d/
+
+      sudo tee /etc/modprobe.d/broadcom.conf > /dev/null <<'EOF'
+      blacklist b43
+      blacklist b43legacy
+      blacklist ssb
+      blacklist bcm43xx
+      blacklist brcm80211
+      blacklist brcmfmac
+      blacklist brcmsmac
+      blacklist bcma
+      EOF
+
+#. Reboot the system and check that the module is loaded and working. If not,
+   try manually updating dependencies and loading the module.
+
+   .. code-block:: bash
+
+      depmod -a
+      modprobe wl
+
+
+Firmware
+********
+
+In addition to device drivers, devices require firmware that gets loaded onto
+the device directly.
+
+Firmware for Broadcom devices are not fully open-source and not always
+licensed for redistribution. |CL| kernel bundles :ref:`include the
+linux-firmware bundle <firmware-included-begin>` which contains the firmware
+binaries that are able to be redistributed. If your device's firmware is part
+of the linux-firmware repository, nothing else is needed. This is usually
+the case for devices supported by the *brcmfmac* and *brcmsmac* drivers.
+
+In other cases, firmware may need to be obtained or extracted manually from a
+trusted source because it is not licensed for distribution. This is usually
+the case for devices supported by the *b43* and *b43legacy* drivers. Obtaining
+these firmware is out of scope for this document, however there is information
+about solutions to this problem available on the `Linux wireless wiki
+<http://linuxwireless.sipsolutions.net/en/users/Drivers/b43/#firmware>`_.
+
+On |CL| systems, firmware should be placed in :file:`/etc/firmware`. See the
+:ref:`firmware` documentation for more information on loading custom
+firmware.
+
+
+Troubleshooting
+***************
+
+- See which drivers are currently loaded with the :command:`lsmod` and
+  :command:`modinfo` commands.
+
+- If your device is not showing up or having intermittent issues, ensure the
+  card is not blocked by the kernel with the :command:`rfkill` command.
+
+- Try blacklisting all the other variations of drivers not intended to be
+  used. In some cases, the wrong device driver will be loaded causing
+  problems. 
+
+- If an external firmware image is required, it may be trying to load from a
+  different path than expected. Check the output of :command:`sudo dmesg |
+  grep -i firmware` for firmware loading issues.
+

source/tutorials/multi-boot/dual-boot-win.rst

@@ -6,17 +6,14 @@ Dual-boot |CL-ATTR| and Windows\* 10 OS
 This guide shows how to install |CL-ATTR| adjacent to an existing Windows\*
 10 :abbr:`OS (operating system)`. To add |CL| to an existing Windows installation, follow a method below.
 
-.. contents::
-   :local:
-   :depth: 1
-
-Description
-***********
-
 In this tutorial you'll :ref:`bare-metal-install-desktop` as
 an additional partition. Alternatively, you may also
 :ref:`bare-metal-install-server`.
 
+.. contents::
+   :local:
+   :depth: 1
+
 Method 1: Shrink Windows partition and install |CL|
 ***************************************************
 For this method, we shrink the Windows 10 OS partition to make space for |CL|.
@@ -28,6 +25,8 @@ For this method, we shrink the Windows 10 OS partition to make space for |CL|.
 
 #. Right-click the primary Windows partition and select :guilabel:`Shrink Volume...`.
 
+   .. rst-class:: dropshadow
+
    .. figure:: ../../_figures/multi-boot/dual-boot-win-01.png
       :scale: 85%
       :alt: Disk Management > Shrink Volume
@@ -43,7 +42,9 @@ For this method, we shrink the Windows 10 OS partition to make space for |CL|.
      allow at least 4GB.
 
 
-#. We shrink C by about 21 GB, as shown in Figure 2.
+#. We shrink C by about 21GB, as shown in Figure 2.
+
+   .. rst-class:: dropshadow
 
    .. figure:: ../../_figures/multi-boot/dual-boot-win-02.png
       :scale: 85%
@@ -71,6 +72,8 @@ For this method, we shrink the Windows 10 OS partition to make space for |CL|.
 #. During the BIOS POST stage, press :kbd:`F10`, or the proper F-key for your
    system, to launch the :guilabel:`Boot Menu`.
 
+   .. rst-class:: dropshadow
+
    .. figure:: ../../_figures/multi-boot/dual-boot-win-03.png
       :scale: 85%
       :alt: Boot menu
@@ -86,10 +89,11 @@ For this method, we shrink the Windows 10 OS partition to make space for |CL|.
    .. tip::
 
       If you don't want to use the BIOS boot menu each time to select an OS,
-      follow :ref:`Advanced: Use systemd-boot to boot Windows 10 OS and |CL| <advanced-systemd-boot>`.
+      follow :ref:`Advanced: Use systemd-boot to boot Windows 10 OS and 
+      |CL| <advanced-systemd-boot>`.
 
-Method 2: Add another hard disk to your system where you install |CL|
-*********************************************************************
+Method 2: Add another hard disk to your system where you installed |CL|
+***********************************************************************
 
 #. Shutdown your system.
 
@@ -117,6 +121,8 @@ Method 2: Add another hard disk to your system where you install |CL|
 #. During the BIOS POST stage, press :kbd:`F10`, or the proper F-key for your
    system, to launch the :guilabel:`Boot Menu`.
 
+   .. rst-class:: dropshadow
+
    .. figure:: ../../_figures/multi-boot/dual-boot-win-03.png
       :scale: 85%
       :alt: Boot menu
@@ -141,39 +147,46 @@ Advanced: Use systemd-boot to boot Windows 10 OS and |CL|
 
 If you prefer not to use your BIOS to load the :guilabel:`Boot Menu` and select an OS to boot, you can make :command:`systemd-boot` the default bootloader and add Windows 10 OS to the boot list. This option is also a workaround for BIOSes that don’t support booting more than one partition.
 
-#. Boot up the |CL| installer.
+#. Boot up a |CL| live image from a USB thumb drive. 
 
-#. Open a Terminal window and enter:
+#. Open a terminal window and enter:
 
    .. code-block:: bash
 
-      lsblk
+      lsblk -po NAME,SIZE,TYPE,FSTYPE,PARTLABEL
 
-#. Example output:
+   Example output:
 
    .. code-block:: console
+      :emphasize-lines: 6,8,9,11
 
-      clrlinux@clr-live~ $ lsblk
-      NAME   MAJ:MIN RM   SIZE RO TYPE MOUNTPOINT
-      loop0    7:0    0   2.3G  1 loop
-      sda      8:0    0 335.4G  0 disk
-      ├─sda1   8:1    0   450M  0 part
-      ├─sda2   8:2    0   100M  0 part
-      ├─sda3   8:3    0    16M  0 part
-      ├─sda4   8:4    0   286G  0 part
-      ├─sda5   8:5    0   143M  0 part
-      ├─sda6   8:6    0   244M  0 part
-      └─sda7   8:7    0  48.5G  0 part
-      sdb      8:16   1     7G  0 disk
-      ├─sdb1   8:17   1   2.5G  0 part
-      └─sdb2   8:18   1   100M  0 part
+      clrlinux@clr-live~ $ lsblk -po NAME,SIZE,TYPE,FSTYPE,PARTLABEL
+      NAME          SIZE TYPE FSTYPE   PARTLABEL
+      /dev/loop0    2.3G loop squashfs 
+      /dev/sda    335.4G disk
+      ├─/dev/sda1   450M part ntfs     Basic data partition
+      ├─/dev/sda2   100M part vfat     EFI system partition
+      ├─/dev/sda3    16M part          Microsoft reserved partition
+      ├─/dev/sda4   286G part ntfs     Basic data partition
+      ├─/dev/sda5   143M part vfat     EFI
+      ├─/dev/sda6   244M part swap     linux-swap
+      └─/dev/sda7  48.5G part ext4     /
+      sdb             7G disk iso9660
+      ├─/dev/sdb1   2.7G part iso9660
+      └─/dev/sdb2   100M part vfat
 
-#. The example output shows:
+   The example output shows:
 
-   * /dev/sda2 is the EFI system partition created by Windows
+   * /dev/sda2 is the EFI system partition created by Windows 10 OS
    * /dev/sda4 is the primary Windows partition
-   * /dev/sda5 is the EFI system partition created by Clear Linux
-   * /dev/sda7 is the Clear Linux root partition
+   * /dev/sda5 is the EFI system partition created by |CL|
+   * /dev/sda7 is the |CL| root partition
+
+  .. note::
+
+     To help narrow down a partition even more, you add the ``PARTTYPE`` 
+     option to :command:`lsblk` and cross-reference against the 
+     `partition type GUIDs wiki`_.
 
 #. Create mount points.
 
@@ -237,6 +250,8 @@ If you prefer not to use your BIOS to load the :guilabel:`Boot Menu` and select
 #. You should be presented with the :command:`systemd-boot` menu, as shown
    below.
 
+   .. rst-class:: dropshadow
+
    .. figure:: ../../_figures/multi-boot/dual-boot-win-04.png
       :scale: 85%
       :alt: systemd-boot menu
@@ -244,3 +259,142 @@ If you prefer not to use your BIOS to load the :guilabel:`Boot Menu` and select
       Figure 5: systemd-boot menu
 
 
+Alternative: Install Windows 10 OS After |CL|
+*********************************************
+
+The following alternative guide shows how to install Windows 10 OS adjacent
+to an existing |CL| installation.
+
+Prerequisites
+*************
+
+* |CL| is already installed.  
+* There is unallocated disk space available. If the entire disk has been
+  allocated to |CL|, then shrink the root partition to make space for 
+  Windows 10 OS.
+
+Install Windows 10 OS
+=====================
+
+#. Start the Windows installer and follow the prompts.
+
+#. At the :guilabel:`What type of installation do you want?` screen, choose 
+   :guilabel:`Custom: Install Windows only (advanced)`. See Figure 6.
+
+   .. rst-class:: dropshadow
+
+   .. figure:: ../../_figures/multi-boot/dual-boot-win-06.png
+      :scale: 85%
+      :alt: Windows - Choose installation type
+
+      Figure 6: Windows - Choose installation type
+
+#. Select :guilabel:`Unallocated Space` and create a new partition of 
+   the desired size. For this example, we will use the entire unallocated 
+   space. See Figure 7.
+
+   .. rst-class:: dropshadow
+
+   .. figure:: ../../_figures/multi-boot/dual-boot-win-07.png
+      :scale: 85%
+      :alt: Windows - Create new partition
+
+      Figure 7: Windows - Create new partition
+
+   .. note::
+     
+      Normally, Windows creates its own 100MB EFI partition if none exists. 
+      In our case, where an EFI partition was created by |CL|, Windows will 
+      use the previously-created partition.
+
+#. Select the newly-created partition and follow the remaining prompts to 
+   complete the Windows installation. See Figure 8.
+
+   .. rst-class:: dropshadow
+
+   .. figure:: ../../_figures/multi-boot/dual-boot-win-08.png
+      :scale: 85%
+      :alt: Windows - Install on newly-created partition
+
+      Figure 8: Windows - Install on newly-created partition
+
+#. Finish the Windows out-of-box-experience process.
+
+#. Restore `systemd-boot` - the bootloader |CL| uses - and add Windows to 
+   its boot menu.
+
+   At this point, you cannot boot |CL| because Windows became the default 
+   bootloader after it was installed.  Follow these steps to restore 
+   `systemd-boot`.
+
+   a. Boot up a |CL| live image from a USB thumb drive. 
+
+   #. Open a terminal window. 
+
+   #. Find the location of the EFI partition. In this example, it is 
+      ``/dev/sda1``.
+
+      .. code-block:: bash
+
+         lsblk -po NAME,SIZE,TYPE,FSTYPE,PARTLABEL
+      
+      Example output:
+
+      .. code-block:: console
+         :emphasize-lines: 5
+
+         clrlinux@clr-live~ $ lsblk -po NAME,SIZE,TYPE,FSTYPE,PARTLABEL
+         NAME          SIZE TYPE FSTYPE   PARTLABEL
+         /dev/loop0    2.3G loop squashfs 
+         /dev/sda      100G disk
+         ├─/dev/sda1   150M part vfat     CLR_BOOT
+         ├─/dev/sda2   250M part swap     CLR_SWAP
+         ├─/dev/sda3     8G part ext4     CLR_ROOT
+         ├─/dev/sda4    16M part          Microsoft reserved partition
+         ├─/dev/sda5  91.6G part ntfs     Basic data partition
+         sdb             7G disk iso9660
+         ├─/dev/sdb1   2.7G part iso9660
+         └─/dev/sdb2   100M part vfat
+         
+      .. note::
+
+         To help narrow down a partition even more, you add the 
+         ``PARTTYPE`` option to :command:`lsblk` and 
+         cross-reference against the `partition type GUIDs wiki`_.
+
+   #. Make a mount point for |CL|.
+
+      .. code-block:: bash
+         
+         sudo mkdir /mnt/clearlinux
+
+   #. Mount the root and EFI partitions.
+
+      .. code-block:: bash
+
+         sudo mount /dev/sda3 /mnt/clearlinux
+         sudo mount /dev/sda1 /mnt/clearlinux/boot
+
+   #. Re-install systemd-boot to make it the default bootloader.
+      
+      .. code-block:: bash
+      
+         sudo bootctl install --esp-path=/mnt/clearlinux/boot
+
+   #. Add a timeout (for example: 25 seconds) to systemd-boot so that it 
+      will present the menu of bootable OSes and give you time to select 
+      the one you want to boot.
+
+      .. code-block:: bash
+
+         sudo clr-boot-manager set-timeout 25 --path=/mnt/clearlinux
+         sudo clr-boot-manager update --path=/mnt/clearlinux
+
+   #. Unmount the root and EFI partitions.
+
+      .. code-block:: bash
+      
+         sudo umount /mnt/clearlinux/boot
+         sudo umount /mnt/clearlinux
+
+.. _partition type GUIDs wiki: https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs

source/tutorials/redis.rst

@@ -216,7 +216,7 @@ Next Steps
 
 * Learn how to use :ref:`docker`.
 
-.. _try redis io: https://try.redis.io/
+.. _try redis io: http://try.redis.io/
 
 .. _Clear Linux Redis instance: https://hub.docker.com/r/clearlinux/redis
 

source/tutorials/vmware-workstation.rst

@@ -0,0 +1,141 @@
+
+.. _vmware-workstation:
+
+VMware\* Workstation Pro
+########################
+
+VMware Workstation Pro allows you to run multiple operating systems as
+:abbr:`VMs (virtual machines)` on a single host. It is a more advanced version
+of VMware Workstation Player.
+
+This tutorial shows how to do a manual installation of VMware Workstation
+Pro on a |CL-ATTR| host using the console plus the VMware Workstation Pro GUI.
+
+VMware Workstation Pro on Linux installs two major components:
+
+#. VMware hypervisor software
+#. VMware kernel modules
+
+.. note::
+
+   |CL| is not an officially supported host OS for VMware Workstation Pro. This
+   tutorial follows the generic Linux installation instructions with details
+   specific to a manual installation on |CL|.
+
+Prerequisites
+*************
+
+Enable virtualization in the BIOS before installing VMware Workstation Pro.
+
+Install VMware Workstation Pro
+******************************
+
+Use the console installer to install the VMware Workstation Pro hypervisor
+software:
+
+#. Download
+   `VMware Workstation Pro for Linux <https://www.vmware.com/products/workstation-pro/workstation-pro-evaluation.html>`_.
+
+   .. note::
+
+      The downloaded file is named with a :file:`.bundle` file extension but
+      this is not a |CL| :ref:`bundle <bundles-guide>`!
+
+#. In a terminal, :command:`cd` to the directory where the `.bundle` installation
+   file was saved.
+
+   .. code-block:: bash
+
+	    cd ~/Downloads/
+
+#. Make the `.bundle` installation file executable. Replace
+   [VMware-Workstation-xxxx-xxxx.architecture] with the actual file name.
+
+   .. code-block:: bash
+
+      chmod +x ./[VMware-Workstation-xxxx-xxxx.architecture].bundle
+
+#. Start the installation.
+
+   .. code-block:: bash
+
+      sudo ./VMware-Workstation-[xxxx-xxxx].architecture.bundle
+
+   .. code-block:: console
+
+	    Extracting VMware Installer...done.
+
+#. When prompted to specify the system service scripts directory, use the common
+   suggestion:
+
+   .. code-block:: console
+
+	    System service scripts directory (commonly /etc/init.d).: /etc/init.d
+
+   You will see output similar to the following:
+
+   .. code-block:: console
+
+	    Installing VMware VMX 15.5.0
+	        Configuring...No rc*.d style init script directories were given to the installer.
+	    You must manually add the necessary links to ensure that the vmware    ]  49%
+	    service at /etc/init.d/vmware is automatically started and stopped on
+	    Installing VMware Workstation 15.5.0
+	        Configuring...
+	    [######################################################################] 100%
+	    Installation was successful.
+
+   .. note::
+
+	  During installation you will get an error about "No rc*.d style init
+	  script directories" being given. This can safely be ignored as |CL| uses
+	  :command:`systemd`.
+
+Install VMware kernel modules
+*****************************
+
+After installing VMware Workstation Pro, additional VMware kernel modules must
+be compiled and installed. Before installing the VMware kernel modules, install
+DKMS, which will provide the necessary tools to add the VMware kernel modules.
+
+Install DKMS
+============
+
+.. include:: ../guides/kernel/kernel-modules-dkms.rst
+   :start-after: kernel-modules-dkms-install-begin:
+   :end-before: kernel-modules-dkms-install-end:
+
+Install kernel modules
+======================
+
+Launch the VMware Workstation Pro GUI to finish the installation and build the
+needed kernel modules.
+
+#. On the |CL| desktop, find the VMware Workstation Pro icon and click to launch.
+
+#. Click through the installation customization screens as directed in the
+   VMware Kernel Module Updater.
+
+#. On the last screen click :guilabel:`Finish`. VMware Workstation Pro will launch.
+
+#. Create and configure a new VM!
+
+Troubleshooting
+***************
+
+If problems occur during installation, the recommended first step is to identify
+which major component the issues are occurring in (hypervisor or kernel modules).
+This will help direct further troubleshooting.
+
+Troubleshooting tips:
+
+* If the issue is with compiling the kernel modules and you are running the native
+  kernel, try installing the LTS kernel instead.
+
+* If modules failed to install or load, check logs in :file:`/tmp/vmware-<username>/*.log`
+
+* Try re-installing all VMware modules with the following command:
+
+  .. code-block:: bash
+
+     sudo vmware-modconfig --console --install-all

source/tutorials/yubikey-u2f.rst

@@ -18,7 +18,7 @@ One-Time Password (OTP), Smart card, FIDO2, and Universal 2nd Factor (U2F).
 
 A list of `websites that accept U2F authentication with the YubiKey`_
 is available on the Yubico website. See the Yubico website to learn more about
-the Yubikey: https://www.yubico.com/getstarted/meet-the-yubikey/
+the Yubikey: https://www.yubico.com/getstarted/
 
 Prerequisites
 *************