diff --git a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst index 00c8cbe7..ca6bcde2 100644 --- a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst +++ b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst @@ -1,16 +1,19 @@ .. _bare-metal-install: -Install Clear Linux OS on bare metal (automatic) -################################################ +Install |CL-ATTR| on bare metal (automatic) +########################################### -These instructions guide you through the installation of |CLOSIA| +These instructions guide you through the installation of |CL-ATTR| on bare metal using a bootable USB drive. -Before you begin, run our :ref:`compatibility-check`. +Before you begin, check that your system meets the requirements to install |CL|: + +* :ref:`system-requirements` +* :ref:`compatibility-check` -Download the latest Clear Linux installer image -*********************************************** +Download the latest |CL| installer image +**************************************** Get the latest |CL| installer image from the `image`_ directory. Look for the :file:`clear-[version number]-installer.img.xz` file. You can also use this command: @@ -31,8 +34,8 @@ Once you have downloaded the image, verify and uncompress the file. .. _install-on-target: -Install Clear Linux on your target system -***************************************** +Install |CL| on your target system +********************************** We formatted the previously created USB drive as a UEFI boot device. Our target system has a hard drive installed containing a single primary @@ -54,25 +57,24 @@ Follow these steps to install |CL| on the target system: #. Reboot the target system. -#. The |CL| Installer menu will start as shown in Figure 1. +#. The |CL| boot menu will start as shown in figure 1. Select :guilabel:`Clear Linux OS for Intel Architecture` and press the :kbd:`Enter` key or wait five seconds to automatically select it. .. figure:: figures/bare-metal-install-1.png :scale: 50 % - :alt: Clear Linux boot menu + :alt: Boot menu - Figure 1: :guilabel:`Clear Linux boot menu` + Figure 1: :guilabel:`Boot menu` -#. This will take you into the :guilabel:`Clear Linux OS for Intel - Architecture Installer` menu as shown in figure 2 and explains how to +#. This will take you into the |CL| installer menu as shown in figure 2 and explains how to navigate through the |CL| installer setup menus. .. figure:: figures/bare-metal-install-2.png :scale: 50 % - :alt: Clear Linux OS for Intel Architecture Installer + :alt: Installer menu - Figure 2: :guilabel:`Clear Linux OS for Intel Architecture Installer` + Figure 2: :guilabel:`Installer menu` Press the :kbd:`Enter` key. @@ -97,7 +99,7 @@ The :guilabel:`Network Requirements` menu, the first step of the |CL| installer setup process, will attempt to connect to the |CL| update server where the installer image is located. Once the connection to the |CL| update server is established, you will see a screen similar to the one shown in -figure 4: +figure 4. .. figure:: figures/bare-metal-install-4.png :scale: 50 % @@ -134,11 +136,11 @@ Once the connection to the |CL| udpate server is established, use the :kbd:`Tab` key to advance to the :guilabel:`< Next >` button and press :kbd:`Enter` to advance to the next |CL| installer setup menu. -Choose Clear Linux installer action -=================================== +Choose |CL| installer action +============================ The :guilabel:`Choose Action` menu is where you can choose to install, repair, -open a shell, or exit the |CL| installer. This menu is shown in figure 5: +open a shell, or exit the |CL| installer. This menu is shown in figure 5. .. figure:: figures/bare-metal-install-5.png :scale: 50 % @@ -181,8 +183,8 @@ open a shell, or exit the |CL| installer. This menu is shown in figure 5: information is collected. Please visit our website to `learn more about telemetry.`_ -Choose Clear Linux installation type -************************************ +Choose |CL| installation type +***************************** Figure 7 shows the next step of the |CL| installer: :guilabel:`Choose installation Type`. Chose whether to install |CL| @@ -216,8 +218,8 @@ If you want to perform any of these additional tasks, select the :ref:`bare-metal-manual-install` to complete the |CL| manual installation process. Otherwise, you can follow the |CL| automatic installation steps. -Clear Linux automatic installation -********************************** +|CL| automatic installation +*************************** #. To install the minimum components for your |CL| implementation, select the :guilabel:`< Automatic >` menu item shown in figure 7 and press the diff --git a/source/clear-linux/get-started/bare-metal-install/bare-metal-manual-install.rst b/source/clear-linux/get-started/bare-metal-manual-install/bare-metal-manual-install.rst similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/bare-metal-manual-install.rst rename to source/clear-linux/get-started/bare-metal-manual-install/bare-metal-manual-install.rst diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-1.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-1.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-1.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-1.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-10.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-10.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-10.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-10.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-11.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-11.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-11.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-11.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-12.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-12.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-12.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-12.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-13.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-13.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-13.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-13.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-14.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-14.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-14.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-14.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-15.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-15.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-15.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-15.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-16.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-16.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-16.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-16.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-2.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-2.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-2.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-2.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-3.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-3.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-3.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-3.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-4.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-4.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-4.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-4.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-5.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-5.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-5.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-5.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-6.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-6.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-6.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-6.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-7.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-7.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-7.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-7.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-8.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-8.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-8.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-8.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-9.png b/source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-9.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/bare-metal-manual-install-9.png rename to source/clear-linux/get-started/bare-metal-manual-install/figures/bare-metal-manual-install-9.png diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst index 4767c26a..c481ce98 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst @@ -1,9 +1,9 @@ .. _bootable-usb-linux: -Create a bootable USB drive on Linux -#################################### +Create a bootable USB drive on Linux\* +###################################### -Follow these instructions to create a bootable |CLOSIA| USB drive. +Follow these instructions to create a bootable |CL-ATTR| USB drive. Use an **8GB** or larger USB drive. Download either a live image, ``clear--live.img.xz`` or an installer image, ``clear--installer.img.xz``, from our `image`_ download page. @@ -22,8 +22,8 @@ Instructions are also available for other operating systems: .. _copy-usb-linux: -Burn the Clear Linux image onto a USB drive -******************************************* +Burn the |CL| image onto a USB drive +************************************ .. caution:: diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst index 2aab17b2..5e52f436 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst @@ -3,7 +3,7 @@ Create a bootable USB drive on macOS #################################### -Follow these instructions to create a bootable |CLOSIA| USB drive. +Follow these instructions to create a bootable |CL-ATTR| USB drive. Use an **8GB** or larger USB drive. Download either a live image, ``clear--live.img.xz`` or an installer image, ``clear--installer.img.xz``, from our `image`_ download page. @@ -21,8 +21,8 @@ Instructions are also available for other operating systems: :start-after: verify-mac: -Burn the Clear Linux image onto a USB drive -******************************************* +Burn the |CL| image onto a USB drive +************************************ .. caution:: diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst index d4dbd75e..f0a28b5b 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst @@ -3,7 +3,7 @@ Create a bootable USB drive on Windows ###################################### -Follow these instructions to create a bootable |CLOSIA| USB drive. +Follow these instructions to create a bootable |CL-ATTR| USB drive. Use an **8GB** or larger USB drive. Download either a live image, ``clear--live.img.xz`` or an installer image, ``clear--installer.img.xz``, from our `image`_ download page. @@ -20,8 +20,8 @@ Instructions are also available for other operating systems: .. include:: ../../guides/maintenance/download-verify-uncompress-windows.rst :Start-after: verify-windows: -Burn the Clear Linux image onto a USB drive -******************************************* +Burn the |CL| image onto a USB drive +************************************ .. caution:: diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb.rst index 431e9e2f..4be76f94 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb.rst @@ -1,15 +1,15 @@ .. _bootable-usb: -Create a bootable Clear Linux USB drive -####################################### +Create a bootable |CL-ATTR| USB drive +##################################### -Instructions to create a |CLOSIA| USB drive vary depending on your operating +Instructions to create a |CL-ATTR| USB drive vary depending on your operating system. .. _download-usb-image: -Download the latest Clear Linux image -************************************* +Download the latest |CL| image +****************************** There are 2 types of |CL| images suitable for burning onto and running off a USB drive: @@ -17,7 +17,7 @@ off a USB drive: * Live image: :file:`clear-[version number]-live.img.xz` * Installer image: :file:`clear-[version number]-installer.img.xz` -Go to the Clear Linux `image`_ repository and download the desired type. +Go to the |CL| `image`_ repository and download the desired type. With the appropriate image downloaded, choose the step-by-step instructions applicable to your system: diff --git a/source/clear-linux/get-started/bare-metal-install/cgdisk-manual-install.rst b/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst old mode 100755 new mode 100644 similarity index 93% rename from source/clear-linux/get-started/bare-metal-install/cgdisk-manual-install.rst rename to source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst index 0c5eb624..73f78264 --- a/source/clear-linux/get-started/bare-metal-install/cgdisk-manual-install.rst +++ b/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst @@ -1,11 +1,11 @@ .. _cgdisk-manual-install: -Create partitions for Clear Linux\* using CGDISK -################################################ +Create partitions for |CL-ATTR| using CGDISK +############################################ -As part of the |CL| manual installation processThese instructions guide you through the initial setup of your hard drive -partitions using the :command:`cgdisk` utility . If you do not wish to continue creating your own -partitions, :ref:`return to the bare metal manual installation +These instructions guide you through the initial setup of your hard drive +partitions using the :command:`cgdisk` utility . If you do not wish to continue +creating your own partitions, :ref:`return to the bare metal manual installation `. Prerequisites @@ -278,7 +278,7 @@ partitions and select to format them. You have completed the process of manually partitioning your target system. Now, :ref:`return to the bare metal manual installation - ` to complete installation of Clear Linux. + ` to complete installation of |CL|. Continue at the section *Additional manual installer settings*. .. _`GPT fdisk tutorial`: diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-1.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-1.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-1.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-1.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-10.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-10.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-10.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-10.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-11.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-11.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-11.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-11.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-12.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-12.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-12.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-12.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-13.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-13.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-13.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-13.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-14.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-14.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-14.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-14.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-15.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-15.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-15.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-15.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-16.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-16.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-16.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-16.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-2.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-2.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-2.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-2.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-3.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-3.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-3.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-3.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-4.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-4.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-4.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-4.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-5.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-5.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-5.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-5.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-6.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-6.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-6.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-6.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-7.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-7.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-7.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-7.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-8.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-8.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-8.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-8.png diff --git a/source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-9.png b/source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-9.png similarity index 100% rename from source/clear-linux/get-started/bare-metal-install/figures/cgdisk-manual-install-9.png rename to source/clear-linux/get-started/cgdisk-manual-install/figures/cgdisk-manual-install-9.png diff --git a/source/clear-linux/get-started/compatibility-check.rst b/source/clear-linux/get-started/compatibility-check.rst index 0223bbe7..83fc720a 100644 --- a/source/clear-linux/get-started/compatibility-check.rst +++ b/source/clear-linux/get-started/compatibility-check.rst @@ -1,11 +1,11 @@ .. _compatibility-check: -Check processor and EFI firmware compatibility with Clear Linux\* -################################################################# +Check processor and EFI firmware compatibility with |CL-ATTR| +############################################################# -On a system that is currently running a Linux operating system, follow the +On a system that is currently running a Linux\* operating system, follow the instructions below to determine if your system's processor and EFI firmware is -capable of running |CLOSIA|. Otherwise, +capable of running |CL-ATTR|. Otherwise, :ref:`run Clear Linux as a Live image ` and then perform the steps below. diff --git a/source/clear-linux/get-started/get-started.rst b/source/clear-linux/get-started/get-started.rst index 75a0849f..1bbe2c15 100644 --- a/source/clear-linux/get-started/get-started.rst +++ b/source/clear-linux/get-started/get-started.rst @@ -3,21 +3,33 @@ Get started ########### -This section contains information about the installation of |CLOSIA|. +The Get Started section will get you up and running fast with |CL-ATTR|. Use +these step-by-step instructions to guide you through the installation of |CL| +from bare metal to a live image. + +Pre-install +*********** + +* :ref:`system-requirements` +* :ref:`compatibility-check` +* :ref:`bootable-usb` + +Install |CL| +************ + +* :ref:`bare-metal-install` +* :ref:`bare-metal-manual-install` +* :ref:`virtual-machine-install` +* :ref:`live-image` -The :ref:`get-started` section provides step-by-step instructions to download -and run |CL| on :ref:`bare metal `, under -a :ref:`virtual machine `, or by way of a -:ref:`live image `. Additionally, it provides useful pre-install -information and instructions on how to complete pre-install tasks. .. toctree:: :maxdepth: 2 + :hidden: - ../reference/system-requirements bare-metal-install/bare-metal-install - bare-metal-install/bare-metal-manual-install - bare-metal-install/cgdisk-manual-install + bare-metal-manual-install/bare-metal-manual-install + cgdisk-manual-install/cgdisk-manual-install virtual-machine-install/virtual-machine-install live-image compatibility-check diff --git a/source/clear-linux/get-started/live-image.rst b/source/clear-linux/get-started/live-image.rst index 79c480b1..05285773 100644 --- a/source/clear-linux/get-started/live-image.rst +++ b/source/clear-linux/get-started/live-image.rst @@ -1,12 +1,12 @@ .. _live-image: -Install Clear Linux as a live image -################################### +Install |CL-ATTR| as a live image +################################# -A live image contains the complete |CLOSIA| operating system and resides +A live image contains the complete |CL-ATTR| operating system and resides on a bootable media such as a USB drive or in a virtual machine -(see :ref:`virtual-machine-install`). This is a -great way to use |CL| without modifying your computer's hard disk. +(see :ref:`virtual-machine-install`). This is a great way to use |CL| +without modifying your computer's hard disk. To create a bootable USB drive with a live image, follow :ref:`our step-by-step instructions` and use the latest |CL| @@ -15,8 +15,8 @@ live image from the `image`_ directory. Look for the .. _boot-live-image: -Boot the Clear Linux live image -******************************* +Boot the |CL| live image +************************ #. Configure the BIOS/UEFI firmware settings of the target system: diff --git a/source/clear-linux/get-started/virtual-machine-install/hyper-v.rst b/source/clear-linux/get-started/virtual-machine-install/hyper-v.rst index f8da4baa..cd87daf3 100644 --- a/source/clear-linux/get-started/virtual-machine-install/hyper-v.rst +++ b/source/clear-linux/get-started/virtual-machine-install/hyper-v.rst @@ -3,7 +3,7 @@ Use Hyper-V\* ############# -This section explains how to run |CLOSIA| inside a +This section explains how to run |CL-ATTR| inside a `Windows Server Virtualization`_\* or **Hyper-V** environment. Please ensure you have enabled `IntelĀ® Virtualization Technology @@ -31,7 +31,7 @@ Create a virtual machine #. Download and uncompress the latest hyperv disk image :file:`clear-XXXXX-hyperv.img.gz`, where XXXXX is the latest - available version of |CLOSIA| from our `downloads`_ section. + available version of |CL| from our `downloads`_ section. #. Create a virtual machine using the **Hyper-V Manager**: @@ -41,7 +41,7 @@ Create a virtual machine c. When finished, open VM settings, select Firmware Section and in Secure Boot config, **uncheck** Enable Secure Boot. - .. note:: Currently, Clear Linux does not boot with `secure boot` + .. note:: Currently, |CL| does not boot with `secure boot` enabled. #. Connect to your new VM and start it. You should see a prompt: @@ -52,7 +52,7 @@ Create a virtual machine #. Set a root user password. -Your virtual machine running |CLOSIA| is ready! +Your virtual machine running |CL| is ready! .. _Windows Server Virtualization: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/about/ .. _Microsoft documentation: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v diff --git a/source/clear-linux/get-started/virtual-machine-install/kvm.rst b/source/clear-linux/get-started/virtual-machine-install/kvm.rst index 58a9f986..ce40001b 100644 --- a/source/clear-linux/get-started/virtual-machine-install/kvm.rst +++ b/source/clear-linux/get-started/virtual-machine-install/kvm.rst @@ -1,9 +1,9 @@ .. _kvm: -Run Clear Linux as a KVM guest OS -################################# +Run |CL-ATTR| as a KVM guest OS +############################### -This section explains how to run |CLOSIA| in a virtualized environment using +This section explains how to run |CL-ATTR| in a virtualized environment using :abbr:`KVM (Kernel-based Virtual Machine)`. Install QEMU-KVM diff --git a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst index 760f8500..f8474fe2 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst @@ -1,9 +1,9 @@ .. _virtual-machine-install: -Install Clear Linux in a virtual machine -######################################## +Install |CL-ATTR| in a virtual machine +###################################### -There are some considerations to make when installing |CL| in a VM. +There are some considerations to make when installing |CL-ATTR| in a VM. First, you need to decide which kernel to use. This document will walk you through the available kernel options to help this decision. At the end of this document, you will be able to select the set of installation @@ -12,7 +12,7 @@ steps most suitable to you and install |CL| under a VM. Compatible kernels ================== -The |CLOSIA| provides the following Linux kernels with a respective +The |CL| provides the following Linux kernels with a respective :ref:`bundle ` for VMs. Specific use cases these bundles serve are provided along with links to their source code. diff --git a/source/clear-linux/get-started/virtual-machine-install/vmw-player-preconf.rst b/source/clear-linux/get-started/virtual-machine-install/vmw-player-preconf.rst index d090222b..428c67c8 100644 --- a/source/clear-linux/get-started/virtual-machine-install/vmw-player-preconf.rst +++ b/source/clear-linux/get-started/virtual-machine-install/vmw-player-preconf.rst @@ -1,11 +1,11 @@ .. _vmw-player-preconf: -Run pre-configured Clear Linux image as a VMware\* Workstation Player guest OS +Run pre-configured |CL-ATTR| image as a VMware\* Workstation Player guest OS ############################################################################## `VMware Workstation 14 Player`_ is a type 2 hypervisor. It runs on top of another operating system such as Windows\* or Linux\*. With VMware ESXi, you -can create, configure, manage, and run |CLOSIA| :abbr:`VMs (Virtual Machines)` +can create, configure, manage, and run |CL-ATTR| :abbr:`VMs (Virtual Machines)` on your local system. This section shows how to deploy a pre-configured |CL| VMware image on @@ -61,14 +61,14 @@ Install the VMware Workstation Player hypervisor For additional help, see the `VMware Workstation Player guide`_. -Clear Linux image types -*********************** +|CL| image types +**************** .. include:: ../../reference/image-types.rst :Start-after: image-types-content: -Download the latest Clear Linux VMware image -******************************************** +Download the latest |CL| VMware image +************************************* Get the latest |CL| VMware image from the `image`_ repository. Look for :file:`clear-[version number]-vmware.vmdk.xz`. You can also use @@ -189,8 +189,8 @@ Create and configure a new VM #. Click the :guilabel:`Finish` button. -Attach the pre-configured Clear Linux VMware image -************************************************** +Attach the pre-configured |CL| VMware image +******************************************* #. Move the downloaded and uncompressed pre-configured |CL| VMware image file :file:`clear-[version number]-basic.vmdk` to the directory where your diff --git a/source/clear-linux/get-started/virtual-machine-install/vmw-player.rst b/source/clear-linux/get-started/virtual-machine-install/vmw-player.rst index 06dc38ee..9adb7033 100644 --- a/source/clear-linux/get-started/virtual-machine-install/vmw-player.rst +++ b/source/clear-linux/get-started/virtual-machine-install/vmw-player.rst @@ -1,11 +1,11 @@ .. _vmw-player: -Install Clear Linux as a VMware\* Workstation Player guest OS -############################################################# +Install |CL-ATTR| as a VMware\* Workstation Player guest OS +########################################################### `VMware Workstation 14 Player`_ is a type 2 hypervisor. It runs on top of another operating system such as Windows or Linux. With VMware ESXi, you can -create, configure, manage, and run |CLOSIA| :abbr:`VMs (Virtual Machines)` on +create, configure, manage, and run |CL-ATTR| :abbr:`VMs (Virtual Machines)` on your local system. This section shows how to create a new VM and install |CL| into it with the @@ -71,15 +71,15 @@ Install the VMware Workstation Player hypervisor For additional help, see the `VMware Workstation Player guide`_. -Clear Linux image types -*********************** +|CL| image types +**************** .. include:: ../../reference/image-types.rst :Start-after: image-types-content: -Download the latest Clear Linux installer ISO -********************************************* +Download the latest |CL| installer ISO +************************************** Get the latest |CL| installer ISO image from the `image`_ repository. Look for :file:`clear-[version number]-installer.iso.xz`. @@ -204,8 +204,8 @@ Create and configure a new VM #. Click the :guilabel:`Finish` button. -Install Clear Linux into the new VM -*********************************** +Install |CL| into the new VM +**************************** #. Select the newly-created VM and click the :guilabel:`Play virtual machine` button. See Figure 9. diff --git a/source/clear-linux/get-started/virtual-machine-install/vmware-esxi-install-cl.rst b/source/clear-linux/get-started/virtual-machine-install/vmware-esxi-install-cl.rst index 7e772a45..ec9bd142 100644 --- a/source/clear-linux/get-started/virtual-machine-install/vmware-esxi-install-cl.rst +++ b/source/clear-linux/get-started/virtual-machine-install/vmware-esxi-install-cl.rst @@ -1,11 +1,11 @@ .. _vmware-esxi-install-cl: -Install Clear Linux as a VMware\* ESXi guest OS -############################################### +Install |CL-ATTR| as a VMware\* ESXi guest OS +############################################# `VMware ESXi`_ is a type 1 bare-metal hypervisor which runs directly on top of server hardware. With VMware ESXi, you can create, configure, manage, and -run |CLOSIA| virtual machines in the cloud. +run |CL-ATTR| virtual machines in the cloud. This section shows you how to create a new :abbr:`VM (Virtual Machine)` and manually install |CL| into it with VMware ESXi 6.5. @@ -35,8 +35,8 @@ Install steps: :depth: 1 -Download the latest Clear Linux installer ISO -********************************************* +Download the latest |CL| installer ISO +************************************** Get the latest |CL| installer ISO image from the `image`_ repository. Look for :file:`clear-[version number]-installer.iso.xz`. @@ -50,8 +50,8 @@ For alternative instructions on other operating systems, see: * :ref:`download-verify-uncompress-mac` * :ref:`download-verify-uncompress-windows` -Upload the Clear Linux installer ISO to the VMware server -********************************************************* +Upload the |CL| installer ISO to the VMware server +************************************************** #. Connect to the VMware server and log into an account with sufficient permission to create and manage VMs. @@ -188,8 +188,8 @@ as drive size, number of CPUs, memory size, and then attach the |CL| installer I #. Click the :guilabel:`Next` button. #. Click the :guilabel:`Finish` button. -Install Clear Linux into the new VM -*********************************** +Install |CL| into the new VM +**************************** #. Power on the VM. @@ -211,8 +211,8 @@ Install Clear Linux into the new VM #. After the installation is complete, follow the |CL| instruction to reboot it. This will restart the installer again. -Reconfigure the VM's settings to boot the newly-installed Clear Linux -********************************************************************* +Reconfigure the VM's settings to boot the newly-installed |CL| +************************************************************** After |CL| has been installed using the installer ISO, it must be detached so it will not run again. Also, in order to boot the newly-installed |CL|, you must @@ -268,8 +268,8 @@ enable UEFI support. #. Click the :guilabel:`Save` button. -Power on the VM and boot Clear Linux -************************************ +Power on the VM and boot |CL| +***************************** After configuring the settings above, power on the VM. diff --git a/source/clear-linux/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst b/source/clear-linux/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst index c433ede7..d076d7d8 100644 --- a/source/clear-linux/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst +++ b/source/clear-linux/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst @@ -1,11 +1,11 @@ .. _vmware-esxi-preconfigured-cl-image: -Run preconfigured Clear Linux\* image as a VMware\* ESXi guest OS -################################################################# +Run preconfigured |CL-ATTR| image as a VMware\* ESXi guest OS +############################################################# `VMware ESXi`_ is a type 1 bare-metal hypervisor which runs directly on top of server hardware. With VMware ESXi, you can create, configure, manage, -and run |CLOSIA| virtual machines at scale. +and run |CL-ATTR| virtual machines at scale. This section shows you how to deploy a preconfigured |CL| VMware :abbr:`VM (Virtual Machine)` image on a VMware ESXi 6.5 host. @@ -28,8 +28,8 @@ Install steps: .. contents:: :local: :depth: 1 -Download the latest Clear Linux VMware image -******************************************** +Download the latest |CL| VMware image +************************************* Get the latest |CL| VMware prebuilt image from the `image`_ repository. Look for :file:`clear-[version number]-vmware.vmdk.xz`. You can also use @@ -48,8 +48,8 @@ For alternative instructions on other operating systems, see: * :ref:`download-verify-uncompress-mac` * :ref:`download-verify-uncompress-windows` -Upload the Clear Linux image to the VMware server -************************************************* +Upload the |CL| image to the VMware server +****************************************** Once the |CL| VMware prebuilt image has been downloaded and uncompressed on your local system, it must be uploaded to a datastore @@ -94,8 +94,8 @@ The steps in this section can also be referenced from the `VMware documentation #. Select the uncompressed |CL| VMware image file :file:`clear-[version number]-vmware.vmdk` and upload it. -Convert the Clear Linux image to an ESXi-supported format -********************************************************* +Convert the |CL| image to an ESXi-supported format +************************************************** Once the |CL| VMware prebuilt image has been uploaded to the VMware ESXi datastore, it must be converted to a format for usable with VMware's ESXi @@ -258,8 +258,8 @@ VMware image. Also, in order to boot |CL|, you must enable UEFI support. #. Click the :guilabel:`Next` button. #. Click the :guilabel:`Finish` button. -Power on the VM and boot Clear Linux -************************************ +Power on the VM and boot |CL| +***************************** After configuring the settings above, power on the VM.