From 65bdc30ad1b1cd5f9205608be9a961eea370bd01 Mon Sep 17 00:00:00 2001 From: MCamp859 Date: Thu, 26 Apr 2018 14:31:07 -0400 Subject: [PATCH] Copy edit of 4 interlinked files in Maint Guide. Files: image types; download verify uncompress for Linux, macOS, and Windows Edits for branding and format. Removed $ prompts. Signed-off-by: MCamp859 --- .../download-verify-uncompress-linux.rst | 46 ++++++++++--------- .../download-verify-uncompress-mac.rst | 45 +++++++++--------- .../download-verify-uncompress-windows.rst | 46 ++++++++++--------- .../guides/maintenance/image-types.rst | 28 +++++------ 4 files changed, 85 insertions(+), 80 deletions(-) diff --git a/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst b/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst index 0a123cb9..c1191065 100644 --- a/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-linux.rst @@ -3,14 +3,17 @@ Download, verify, and uncompress a Clear Linux image on Linux ############################################################# -This section explains the types of |CLOSIA| images available, where to download +This guide describes the types of |CLOSIA| images available, where to download them, how to verify the integrity of an image, and how to uncompress it. -We also provide instructions for other operating systems: +Instructions for other operating systems are available: * :ref:`download-verify-uncompress-mac` * :ref:`download-verify-uncompress-windows` +Image types +*********** + .. include:: image-types.rst :start-after: image-types-content: @@ -19,45 +22,44 @@ We also provide instructions for other operating systems: Verify the integrity of the Clear Linux image ********************************************* -Before you use a downloaded |CL| image, verify its integrity. Thus, you -eliminate the small chance of a corrupted image due to download issues. -To support verification, we accompany each released |CL| image with an official -SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. +Before you use a downloaded |CL| image, verify its integrity. This action +eliminates the small chance of a corrupted image due to download issues. To +support verification, each released |CL| image has a corresponding SHA512 +checksum file designated with the suffix `-SHA512SUMS`. -#. Download the official corresponding SHA512 checksum file of your - downloaded |CL| image. +#. Download the corresponding SHA512 checksum file of your |CL| image. #. Start a terminal emulator. #. Go to the directory with the downloaded image and checksum files. #. Verify the integrity of the image and compare it to its original checksum - by entering: + with the command: - .. code-block:: console + .. code-block:: bash - $ sha512sum -c ./clear-[version number]-[image type].[compression type]-SHA512SUMS + sha512sum -c ./clear-[version number]-[image type].[compression type]-SHA512SUMS If the checksum of the downloaded image is different than the original -checksum, a warning will be displayed with a message indicating the computed -checksum does **not** match. Otherwise, the name of the image will be printed on +checksum, a warning is displayed with a message indicating the computed +checksum does **not** match. Otherwise, the name of the image is printed on the screen followed by `OK`. Uncompress the Clear Linux image ******************************** -We compress all released |CL| images by default with either GNU zip -(`.gz`) or XZ (`.xz`). The compression type we use depends on the target -platform or environment of the image. To uncompress the image, follow these steps: +Released |CL| images are compressed with either GNU zip (*.gz*) or XZ +(*.xz*). The compression type depends on the target platform or image +environment. To uncompress the image, follow these steps: #. Start a terminal emulator. #. Go to the directory with the downloaded image. - To uncompress an XZ image, enter: + To uncompress an XZ image, enter: - .. code-block:: console + .. code-block:: bash - $ unxz clear-[version number]-[image type].xz + unxz clear-[version number]-[image type].xz - To uncompress a GZ image, enter: + To uncompress a GZ image, enter: - .. code-block:: console + .. code-block:: bash - $ gunzip clear-[version number]-[image type].gz + gunzip clear-[version number]-[image type].gz diff --git a/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst b/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst index 3c3eb766..fa9773b5 100644 --- a/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-mac.rst @@ -1,16 +1,19 @@ .. _download-verify-uncompress-mac: -Download, verify, and uncompress a Clear Linux image on macOS -############################################################# +Download, verify, and uncompress a Clear Linux image on macOS\* +############################################################### -This section explains the types of |CLOSIA| images available, where to download +This guide describes the types of |CLOSIA| images available, where to download them, how to verify the integrity of an image, and how to uncompress it. -We also provide instructions for other operating systems: +Instructions for other operating systems are available: * :ref:`download-verify-uncompress-linux` * :ref:`download-verify-uncompress-windows` +Image types +*********** + .. include:: image-types.rst :start-after: image-types-content: @@ -19,39 +22,37 @@ We also provide instructions for other operating systems: Verify the integrity of the Clear Linux image ********************************************* -Before you use a downloaded |CL| image, verify its integrity. Thus, you -eliminate the small chance of a corrupted image due to download issues. -To support verification, we accompany each released |CL| image with an official -SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. +Before you use a downloaded |CL| image, verify its integrity. This action +eliminates the small chance of a corrupted image due to download issues. To +support verification, each released |CL| image has a corresponding SHA512 +checksum file designated with the suffix `-SHA512SUMS`. -#. Download the official corresponding SHA512 checksum file of your - downloaded |CL| image. +#. Download the corresponding SHA512 checksum file of your |CL| image. #. Start the Terminal app. #. Go to the directory with the downloaded image and checksum files. #. Verify the integrity of the image and compare it to its original checksum - by entering: + with the command: - .. code-block:: console + .. code-block:: bash - $ shasum -a512 ./clear-[version number]-[image type].[compression type] | diff ./clear-[version number]-[image type].[compression type]-SHA512SUMS - + shasum -a512 ./clear-[version number]-[image type].[compression type] | diff ./clear-[version number]-[image type].[compression type]-SHA512SUMS - If the checksum of the downloaded image is different than the original -checksum, the differences will displayed. Otherwise, an empty output indicates +checksum, the differences are displayed. Otherwise, an empty output indicates a match and your downloaded image is good. Uncompress the Clear Linux image ******************************** -We compress all released |CL| images by default with either GNU zip -(`.gz`) or XZ (`.xz`). The compression type we use depends on the target -platform or environment of the image. To uncompress the image, follow these steps: +Released |CL| images are compressed with either GNU zip (*.gz*) or XZ +(*.xz*). The compression type depends on the target platform or image +environment. To uncompress the image, follow these steps: #. Start the Terminal app. #. Go to the directory with the downloaded image. -#. You can use the `gunzip` command to uncompress both types of compression - formats. For examples: +#. Use the :command:`gunzip` command to uncompress either compression type. For example: - .. code-block:: console + .. code-block:: bash - $ gunzip clear-[version number]-[image type].xz - $ gunzip clear-[version number]-[image type].gz + gunzip clear-[version number]-[image type].xz + gunzip clear-[version number]-[image type].gz diff --git a/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst b/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst index e222d6b2..6a63122b 100644 --- a/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst +++ b/source/clear-linux/guides/maintenance/download-verify-uncompress-windows.rst @@ -1,16 +1,19 @@ .. _download-verify-uncompress-windows: -Download, verify, and uncompress a Clear Linux image on Windows -############################################################### +Download, verify, and uncompress a Clear Linux image on Windows\* +################################################################# -This section explains the types of |CLOSIA| images available, where to download +This guide describes the types of |CLOSIA| images available, where to download them, how to verify the integrity of an image, and how to uncompress it. -We also provide instructions for other operating systems: +Instructions for other operating systems are available: * :ref:`download-verify-uncompress-linux` * :ref:`download-verify-uncompress-mac` +Image types +*********** + .. include:: image-types.rst :start-after: image-types-content: @@ -19,20 +22,19 @@ We also provide instructions for other operating systems: Verify the integrity of the Clear Linux image ********************************************* -Before you use a downloaded |CL| image, verify its integrity. Thus, you -eliminate the small chance of a corrupted image due to download issues. -To support verification, we accompany each released |CL| image with an official -SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. +Before you use a downloaded |CL| image, verify its integrity. This action +eliminates the small chance of a corrupted image due to download issues. To +support verification, each released |CL| image has a corresponding SHA512 +checksum file designated with the suffix `-SHA512SUMS`. -#. Download the official corresponding SHA512 checksum file of your - downloaded |CL| image. -#. Start Command-Prompt. +#. Download the corresponding SHA512 checksum file of your |CL| image. +#. Start Command Prompt. #. Go to the directory with the downloaded image and checksum files. -#. Get the SHA512 checksum of the image by entering: +#. Get the SHA512 checksum of the image with the command: - .. code-block:: console + .. code-block:: bash - C:\> CertUtil -hashfile ./clear-[version number]-[image type].[compression type] sha512 + CertUtil -hashfile ./clear-[version number]-[image type].[compression type] sha512 #. Manually compare the output with the original checksum value shown in the downloaded checksum file and make sure they match. @@ -40,19 +42,19 @@ SHA512 checksum file, which is designated with the suffix `-SHA512SUMS`. Uncompress the Clear Linux image ******************************** -We compress all released |CL| images by default with either GNU zip -(`.gz`) or XZ (`.xz`). The compression type we use depends on the target -platform or environment of the image. To uncompress the image, follow these steps: +Released |CL| images are compressed with either GNU zip (*.gz*) or XZ +(*.xz*). The compression type depends on the target platform or image +environment. To uncompress the image, follow these steps: -#. Download and install `7zip`_. -#. Locate the |CL| image and right-click it. +#. Download and install `7-Zip`_. +#. Go to the directory with the downloaded image and right-click it. #. From the pop-up menu, select :guilabel:`7-Zip` and select - :guilabel:`Extract here`. + :guilabel:`Extract Here` as shown in Figure 1. .. figure:: figures/download-verify-uncompress-windows-fig-1.png :scale: 80 % :alt: 7-Zip extract file - Figure 1: Windows - 7-Zip extract file + Figure 1: Windows 7-Zip extract file. -.. _7zip: http://www.7-zip.org/ +.. _7-Zip: http://www.7-zip.org/ diff --git a/source/clear-linux/guides/maintenance/image-types.rst b/source/clear-linux/guides/maintenance/image-types.rst index bf32eb3f..e3a119f5 100644 --- a/source/clear-linux/guides/maintenance/image-types.rst +++ b/source/clear-linux/guides/maintenance/image-types.rst @@ -5,13 +5,13 @@ Clear Linux image types .. _image-types-content: -|CL| offers many types of `images`_ for different platforms and environments. +|CLOSIA| offers many types of `images`_ for different platforms and environments. The naming convention of a |CL| image filename is: .. code-block:: console - clear-[version number]-[image type].[compression type] + clear-[version number]-[image type].[compression type] The *[version number]* field specifies the version number. @@ -19,9 +19,9 @@ The *[image type]* field specifies the type of image and its corresponding file format. The *[compression type]* field specifies the compression type. Two types of -compressions are used, namely GNU zip (*.gz*) and XZ (*.xz*). +compressions are used: GNU\* zip (*.gz*) and XZ (*.xz*). -The current list of available images: +Table 1 lists the currently available images. .. list-table:: Table 1: Types of Clear Linux images :widths: 20, 60 @@ -30,29 +30,29 @@ The current list of available images: * - Image Type - Description * - azure.vhd - - Image for Microsoft Azure + - Image for Microsoft\* Azure\* * - azure-docker.vhd - - Image with the Docker installed for Microsoft Azure + - Image with Docker\* installed for Microsoft Azure * - azure-machine-learning.vhd - Image with the `machine-learning-basic` bundle installed for Microsoft Azure * - cloud.img - - Image for cloud deployment such as OpenStack, etc. + - Image for cloud deployment such as OpenStack\* * - containers.img - - An optimized image utilized by Clear Containers runtime + - Optimized image used by Clear Containers runtime * - hyperv.vhdx - - Image for Microsoft HyperV + - Image for Microsoft Hyper-V\* * - hyperv-mini.vhdx - - A minimal image with fewer bundles for Microsoft HyperV + - Minimal image with fewer bundles for Microsoft Hyper-V * - installer.img - - An interactive installer image for installing Clear Linux + - Interactive installer image * - installer.iso - - An ISO of the interactive installer image for installing Clear Linux + - ISO of the interactive installer image * - kvm.img - Image for booting in a simple VM with start_qemu.sh * - live.img - - A live boot image of Clear Linux + - Live boot image * - vmware.vmdk - - Image for VMware + - Image for VMware\* .. _images: https://download.clearlinux.org/image