From 0eea7ed0618e532cbcc2e1876f63bf0b5d25d53a Mon Sep 17 00:00:00 2001 From: ihutchin Date: Thu, 22 Jun 2017 20:21:31 -0500 Subject: [PATCH 1/4] Restructures Getting Started guide. Removes outdated files and re-arrages doc-tree to clearly display 3 means of installation: VM, BM, and Live image. --- .../getting-started/bootable-usb.rst | 76 ------------------- .../getting-started/clear-host.rst | 32 -------- .../getting-started/getting-started.rst | 12 +-- .../getting-started/installation-options.rst | 3 +- 4 files changed, 7 insertions(+), 116 deletions(-) delete mode 100644 source/clear-linux/getting-started/bootable-usb.rst delete mode 100644 source/clear-linux/getting-started/clear-host.rst diff --git a/source/clear-linux/getting-started/bootable-usb.rst b/source/clear-linux/getting-started/bootable-usb.rst deleted file mode 100644 index 6ce2a285..00000000 --- a/source/clear-linux/getting-started/bootable-usb.rst +++ /dev/null @@ -1,76 +0,0 @@ -.. _bootable-usb: - -Creating a bootable USB to install the OS -########################################## - -Here's how to create a USB drive that initiates the process for -:ref:`clear-host`. Alternatively, you can test the -OS by :ref:`kvm`. - - -What you need -============= - -* A USB stick, formatted as ``ext4``. Remember that the process of - flashing data to a USB completely deletes the contents of the - drive; as always, run ``dd`` with caution. -* A Clear Linux* OS for Intel® Architecture image; the most current - release versions can be found at the following link: - `https://download.clearlinux.org/image `_ -* Older versions can be found on our `downloads page`_. - - -Download and checksum -===================== - -:: - - $ wget https://download.clearlinux.org/image/clear-[release_number]-installer.img.xz - $ sha512sum clear-[release_number]-installer.img.xz - - -Confirm the mount point on the USB drive -======================================== - -Using ``$ lsblk`` is helpful to show the block-level devices; -a USB drive usually shows up under ``/sdb`` or ``/sdc`` (almost never -under ``/sda``), and should indicate disk space approximately the -size of the USB drive:: - - $ lsblk /dev/sdb - NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT - ?? sdb 8:16 1 14.9G 0 - ?? sdb1 8:17 1 14.9G 0 part - -Make sure the drive isn't already mounted. The easiest way is with -``umount`` or - -:: - - # df - - -Flash the image to the USB -========================== - -Flash the image with the following command. This may need to be done as root or with sudo:: - - # xzcat clear-[release_number]-installer.img.xz | dd of=/dev/sdb - - -Wait for the final confirmation -=============================== - -This example shows ``clear-9130-installer.img.xz`` flashed to a 16GB -USB drive mounted on ``/sdb``. - -.. image:: ./figures/confirmation-screen.png - :align: center - :alt: confirmation - -Success! Your USB stick is now ready to boot and initiate the process for -:ref:`clear-host`. - - - -.. _downloads page: https://download.clearlinux.org diff --git a/source/clear-linux/getting-started/clear-host.rst b/source/clear-linux/getting-started/clear-host.rst deleted file mode 100644 index 86c8ca76..00000000 --- a/source/clear-linux/getting-started/clear-host.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _clear-host: - -Installing the OS as host -######################### - -Running Clear Linux\* OS for Intel® Architecture natively on a system is -easy with the installer image. To get started you'll need the following: - -* A USB stick flashed with the `installer image`_. For instructions on how - to do this, see :ref:`bootable-usb`. -* A host machine running :ref:`supported-hardware`. -* Network access via DHCP. - -Installing Clear Linux OS for Intel Architecture to a target system -=================================================================== - -#. Configure the BIOS; this may involve changing the priority of the boot - device to boot from USB port first. -#. Insert the USB device that is flashed with the - `installer image`_ into the target system, then reboot. -#. The installer user interface will appear. Once all appropriate - configuration options have been chosen, the installer will install the OS. - -The entire installation should take no more than a few minutes. - -For feedback on installation or other topics, please feel free to write in to -our `mailing list`_. - -Note: You can also try :ref:`kvm`. - -.. _installer image: http://download.clearlinux.org/image -.. _mailing list: https://lists.clearlinux.org/mailman/listinfo/dev diff --git a/source/clear-linux/getting-started/getting-started.rst b/source/clear-linux/getting-started/getting-started.rst index 590ea51d..d84abaf7 100644 --- a/source/clear-linux/getting-started/getting-started.rst +++ b/source/clear-linux/getting-started/getting-started.rst @@ -1,13 +1,13 @@ Getting started ############### +There are a number of options available for downloading and running Clear +Linux\* OS for Intel® Architecture. You can install |CL| under Virtual +Machines or containers, on Bare metal, or by way of Live image. + .. toctree:: :maxdepth: 2 - installation-options - supported-hardware - bootable-usb - clear-host kernels - - + supported-hardware + installation-options \ No newline at end of file diff --git a/source/clear-linux/getting-started/installation-options.rst b/source/clear-linux/getting-started/installation-options.rst index c58adf9b..de8eb8f9 100644 --- a/source/clear-linux/getting-started/installation-options.rst +++ b/source/clear-linux/getting-started/installation-options.rst @@ -3,8 +3,7 @@ Installation options #################### -There are a number of options available for downloading and running Clear -Linux\* OS for Intel® Architecture. You can check your system hardware +You can check your system hardware capabilities against the list of :ref:`supported processors `; alternatively, download and run the `clear-linux-check-config`_ script to check the hardware From d8f515448b01686e420fd9eb8e2e8298ec0b1cb5 Mon Sep 17 00:00:00 2001 From: Ianeta Hutchinson Date: Fri, 23 Jun 2017 09:34:52 -0500 Subject: [PATCH 2/4] Update getting-started.rst --- source/clear-linux/getting-started/getting-started.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/clear-linux/getting-started/getting-started.rst b/source/clear-linux/getting-started/getting-started.rst index d84abaf7..1b4083ec 100644 --- a/source/clear-linux/getting-started/getting-started.rst +++ b/source/clear-linux/getting-started/getting-started.rst @@ -2,12 +2,12 @@ Getting started ############### There are a number of options available for downloading and running Clear -Linux\* OS for Intel® Architecture. You can install |CL| under Virtual -Machines or containers, on Bare metal, or by way of Live image. +Linux\* OS for Intel® Architecture. You can install |CL| under virtual +machines or containers, on bare metal, or by way of live image. .. toctree:: :maxdepth: 2 kernels supported-hardware - installation-options \ No newline at end of file + installation-options From 0ef30fc1eb355c736d09ac67c7dd8ba7b59b4a27 Mon Sep 17 00:00:00 2001 From: Ianeta Hutchinson Date: Fri, 23 Jun 2017 09:37:46 -0500 Subject: [PATCH 3/4] Update getting-started.rst --- source/clear-linux/getting-started/getting-started.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/source/clear-linux/getting-started/getting-started.rst b/source/clear-linux/getting-started/getting-started.rst index 1b4083ec..2690d5e0 100644 --- a/source/clear-linux/getting-started/getting-started.rst +++ b/source/clear-linux/getting-started/getting-started.rst @@ -1,9 +1,9 @@ Getting started ############### -There are a number of options available for downloading and running Clear -Linux\* OS for Intel® Architecture. You can install |CL| under virtual -machines or containers, on bare metal, or by way of live image. +There are a number of options available for downloading and running +|CLOSIA|. You can install |CL| under virtual machines or containers, +on bare metal, or by way of live image. .. toctree:: :maxdepth: 2 @@ -11,3 +11,4 @@ machines or containers, on bare metal, or by way of live image. kernels supported-hardware installation-options + From 0ef78a2210c84236a5d2cfcee72c183a34e21562 Mon Sep 17 00:00:00 2001 From: Ianeta Hutchinson Date: Fri, 23 Jun 2017 10:36:55 -0500 Subject: [PATCH 4/4] Update installation-options.rst Removing cross-reference to deleted file. --- source/clear-linux/getting-started/installation-options.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/clear-linux/getting-started/installation-options.rst b/source/clear-linux/getting-started/installation-options.rst index de8eb8f9..9ebb7563 100644 --- a/source/clear-linux/getting-started/installation-options.rst +++ b/source/clear-linux/getting-started/installation-options.rst @@ -49,9 +49,9 @@ natively, download the `clear-linux-check-config`_ script and run:: * **Installer Image** -- The installer image allows you to manipulate and target partitions, and to set other OS configuration features (hostname, administrative user) commonly found in Linux installers. Find the - ``clear-[version_number]-installer.img.xz`` in our `current`_ directory and - see :ref:`clear-host`. This `blog post`_ contains more detail - about the evolution of our installer. + ``clear-[version_number]-installer.img.xz`` in our `current`_ directory. + This `blog post`_ contains more detail about the evolution of our + installer. * **Provisioning Image** -- This image is intended to be used in a provioning environment. Find the ``clear-[version_number]-provision.img.xz`` image in