From bc2bd3537caf23c739239f2b9231c873c601a541 Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Tue, 6 Aug 2019 17:17:57 -0700 Subject: [PATCH] Minor grammatical updates requested in support of upcoming translated content. Signed-off-by: Kristal Dale --- .../bare-metal-install-desktop.rst | 2 +- source/get-started/bootable-usb.rst | 19 ++++++++++++------- .../virtual-machine-install/gce.rst | 2 +- .../virtual-machine-install/hyper-v.rst | 2 +- .../virtualbox-cl-installer.rst | 8 ++++---- .../vmware-esxi-install-cl.rst | 2 +- .../vmware-esxi-preconfigured-cl-image.rst | 16 ++++++++-------- source/guides/clear/autospec.rst | 4 ++-- source/guides/clear/ister.rst | 2 +- source/guides/clear/telemetrics.rst | 4 ++-- source/substitutions.txt | 9 --------- source/tutorials/docker.rst | 2 +- 12 files changed, 34 insertions(+), 38 deletions(-) diff --git a/source/get-started/bare-metal-install-desktop.rst b/source/get-started/bare-metal-install-desktop.rst index 5ba5f841..cc3d1744 100644 --- a/source/get-started/bare-metal-install-desktop.rst +++ b/source/get-started/bare-metal-install-desktop.rst @@ -522,7 +522,7 @@ Create partitions per requirements in Table 1. - Mount Point - Default size - * - **VFAT(FAT32)** + * - **VFAT (FAT32)** - boot - /boot - 150MB diff --git a/source/get-started/bootable-usb.rst b/source/get-started/bootable-usb.rst index 3a209495..02ba502a 100644 --- a/source/get-started/bootable-usb.rst +++ b/source/get-started/bootable-usb.rst @@ -22,7 +22,7 @@ Prerequisites Create a bootable USB drive on Linux\* ************************************** -Make sure you have have completed all `Prerequisites`_. +Make sure you have completed all `Prerequisites`_. Before burning the image onto your USB drive, :ref:`verify and decompress your image `. @@ -32,7 +32,8 @@ Burn the |CL| image onto a USB drive .. caution:: - |CAUTION-BACKUP-USB| + Burning an image formats the USB drive, and will destroy all pre-existing + content. Back up your data before proceeding. #. Open a terminal emulator and get root privilege. @@ -98,14 +99,16 @@ Burn the |CL| image onto a USB drive .. caution:: - |CAUTION-UNMOUNT-USB-PARTITIONS| + Not fully unmounting the USB drive before burning an image could cause + file system checksum errors in it. If this happens, burn the image again, + ensuring all the USB drive partitions are unmounted first. .. _bootable-usb-mac: Create a bootable USB drive on macOS\* ************************************** -Make sure you have have completed all `Prerequisites`_. +Make sure you have completed all `Prerequisites`_. Before burning the image onto your USB drive, :ref:`verify and decompress your image `. @@ -115,7 +118,8 @@ Burn the |CL| image onto a USB drive .. caution:: - |CAUTION-BACKUP-USB| + Burning an image formats the USB drive, and will destroy all pre-existing + content. Back up your data before proceeding. #. Launch the Terminal app. @@ -164,7 +168,7 @@ Burn the |CL| image onto a USB drive Create a bootable USB drive on Windows\* **************************************** -Make sure you have have completed all `Prerequisites`_. +Make sure you have completed all `Prerequisites`_. Before burning the image onto your USB drive, :ref:`verify and decompress your image `. @@ -174,7 +178,8 @@ Burn the |CL| image onto a USB drive .. caution:: - |CAUTION-BACKUP-USB| + Burning an image formats the USB drive, and will destroy all pre-existing + content. Back up your data before proceeding. #. Download the `Rufus`_ utility to burn the image onto a USB drive. We use Rufus 3.5 here. **Only use the latest version of Rufus**. diff --git a/source/get-started/virtual-machine-install/gce.rst b/source/get-started/virtual-machine-install/gce.rst index c94913b0..aa42c418 100644 --- a/source/get-started/virtual-machine-install/gce.rst +++ b/source/get-started/virtual-machine-install/gce.rst @@ -53,7 +53,7 @@ Setup |CL| VM on GCP * Click the :guilabel:`Navigation menu` icon on the upper left screen menu. - * Select the :menuselection:`Storage` item from the side bar on the left. You + * Select the :menuselection:`Storage` item from the sidebar on the left. You will be sent to the Storage Browser tool or the Cloud Storage overview page. .. figure:: figures/gce/01-cloud-storage.png diff --git a/source/get-started/virtual-machine-install/hyper-v.rst b/source/get-started/virtual-machine-install/hyper-v.rst index 45e00741..e89c52b7 100644 --- a/source/get-started/virtual-machine-install/hyper-v.rst +++ b/source/get-started/virtual-machine-install/hyper-v.rst @@ -27,7 +27,7 @@ Please refer to `Install Hyper-V on Windows 10`_ to enable and configure Create a virtual network ************************ -Once *Hyper-V* has been enabled on your Windows system you will need to +Once *Hyper-V* has been enabled on your Windows system, you will need to create a virtual network in the **Hyper-V Manager**. Refer to the `Create a virtual network`_ documentation to create and configure a virtual network. diff --git a/source/get-started/virtual-machine-install/virtualbox-cl-installer.rst b/source/get-started/virtual-machine-install/virtualbox-cl-installer.rst index 2a25674d..5e41e688 100644 --- a/source/get-started/virtual-machine-install/virtualbox-cl-installer.rst +++ b/source/get-started/virtual-machine-install/virtualbox-cl-installer.rst @@ -17,7 +17,7 @@ Prerequisites #. Enable virtualization, such as `Intel® Virtualization Technology`_ (Intel® VT), on the host system from EFI/BIOS. -#. Download and install |VB| **version 6.0 or greater** from +#. Download and install |VB| **version 6.0 or later** from `VirtualBox`_ using the `VirtualBox Installation Instructions`_ for your platform. @@ -32,7 +32,7 @@ Download and extract the |CL| installer ISO #. Decompress the downloaded image. - - On Windows you can use `7zip`_ to extract the file by right-clicking the + - On Windows, you can use `7zip`_ to extract the file by right-clicking the file to *Extract Here* (in the same directory) .. figure:: figures/vbox/virtualbox-cl-installer-01.png @@ -87,7 +87,7 @@ details about using different settings are available in the VirtualBox manual se - **File location** - **File size**: **32.00 GB**. Adjust size to your needs. - **Hard disk file type**: `VDI (VirtualBox Disk Image)` - - **Storage on physical hard disk**:`Dynamically allocated` + - **Storage on physical hard disk**: `Dynamically allocated` .. figure:: figures/vbox/virtualbox-cl-installer-03.png :scale: 100% @@ -224,7 +224,7 @@ virtual hard disk. labeled :guilabel:`clear--live-server.iso` under the :guilabel:`Controller: IDE`. -#. From the :guilabel:`Attributes` column at right, in :guilabel:`Optical Drive`, +#. From the :guilabel:`Attributes` column on the right, in :guilabel:`Optical Drive`, select the blue CD icon beside and click :guilabel:`Remove Disk from Virtual Drive`. diff --git a/source/get-started/virtual-machine-install/vmware-esxi-install-cl.rst b/source/get-started/virtual-machine-install/vmware-esxi-install-cl.rst index 902548a4..5b54d5a2 100644 --- a/source/get-started/virtual-machine-install/vmware-esxi-install-cl.rst +++ b/source/get-started/virtual-machine-install/vmware-esxi-install-cl.rst @@ -21,7 +21,7 @@ Manually installing |CL| on a new VM gives additional configuration flexibility during installation. For example: alternate disk sizes, number of partitions, pre-installed bundles, etc. -If you prefer to use a preconfigured |CL| VMware image instead, refer to +If you prefer to use a pre-configured |CL| VMware image instead, refer to :ref:`vmware-esxi-preconfigured-cl-image`. .. note:: diff --git a/source/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst b/source/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst index f19165d5..33ef1e23 100644 --- a/source/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst +++ b/source/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst @@ -1,9 +1,9 @@ .. _vmware-esxi-preconfigured-cl-image: -Run preconfigured |CL-ATTR| image as a VMware\* ESXi guest OS -############################################################# +Run pre-configured |CL-ATTR| image as a VMware\* ESXi guest OS +############################################################## -This page explains how to deploy a preconfigured |CL| VMware +This page explains how to deploy a pre-configured |CL| VMware :abbr:`VM (Virtual Machine)` image on a VMware ESXi 6.5 host. .. contents:: @@ -17,7 +17,7 @@ Overview of server hardware. With VMware ESXi, you can create, configure, manage, and run |CL-ATTR| virtual machines at scale. -We provide a preconfigured |CL| VMware image that can be run on a VMware ESXi +We provide a pre-configured |CL| VMware image that can be run on a VMware ESXi 6.5 host. If manuall installation is preferred, refer to :ref:`vmware-esxi-install-cl`. @@ -95,7 +95,7 @@ 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 +datastore, it must be converted to a format for use with VMware's ESXi hypervisor. The steps in this section can also be referenced from the VMware documentation on `Cloning and converting virtual machine disks with vmkfstools`_ @@ -107,7 +107,7 @@ The steps in this section can also be referenced from the VMware documentation o If there is no :abbr:`vMA (vSphere Management Assistant)` appliance or :abbr:`vCLI (vSphere CLI)` configured and available, you can temporarily enable SSH directly on the ESXi host by following the - steps described in `Enable the Secure Shell (SSH) in the VMware Host Client`_ . + steps described in `Enable the Secure Shell (SSH) in the VMware Host Client`_. As a security best practice, remember to disable SSH access after following the steps in this section. @@ -205,7 +205,7 @@ VMware image. Also, in order to boot |CL|, you must enable UEFI support. Figure 8: VMware ESXi - Remove hard drive - #. Since a preconfigured image will be used, + #. Since a pre-configured image will be used, the :guilabel:`CD/DVD Drive 1` setting will not be needed. Disable it by unchecking the :guilabel:`Connect` checkbox. See Figure 9. @@ -216,7 +216,7 @@ VMware image. Also, in order to boot |CL|, you must enable UEFI support. Figure 9: VMware ESXi - Disconnect the CD/DVD drive #. Attach the :file:`clear-[version number]-esxi.vmdk` file that was - converted from the preconfigured |CL| VMware image. + converted from the pre-configured |CL| VMware image. #. Click the :guilabel:`Add hard disk` button and select the :guilabel:`Existing hard drive` option. See Figure 10. diff --git a/source/guides/clear/autospec.rst b/source/guides/clear/autospec.rst index ed3c2c90..84f70bed 100644 --- a/source/guides/clear/autospec.rst +++ b/source/guides/clear/autospec.rst @@ -26,7 +26,7 @@ autospec uses **mock** as a sandbox to run the builds. Visit the `mock wiki`_ fo additional information on using mock. For a general understanding of how an RPM works, visit -the `rpm website`_ or the `RPM Packaging Guide`_ . +the `rpm website`_ or the `RPM Packaging Guide`_. How it works ************ @@ -392,7 +392,7 @@ To test an autospec-created package inside a VM: sudo ./start_qemu.sh clear.img #. A new |CL| VM will launch in the console. Log into the VM as *root* and set - a new pasword for the VM. + a new password for the VM. #. Check that the software is installed in the |CL| VM as expected and perform any relevant tests. diff --git a/source/guides/clear/ister.rst b/source/guides/clear/ister.rst index c877b700..b71aa8cc 100644 --- a/source/guides/clear/ister.rst +++ b/source/guides/clear/ister.rst @@ -15,7 +15,7 @@ Description *********** |CL| is a rolling release and produces an average of 10 releases per week using the -ister tool. With each release we produce multiple +ister tool. With each release, we produce multiple :ref:`image types for different environments ` and use cases such as installers, Hyper-V, KVM, or VMWare. diff --git a/source/guides/clear/telemetrics.rst b/source/guides/clear/telemetrics.rst index 1e302ed2..a2a41395 100644 --- a/source/guides/clear/telemetrics.rst +++ b/source/guides/clear/telemetrics.rst @@ -545,8 +545,8 @@ will install the header file that matches your |CL| version. Classification: Type: char array Value: It should have the form, DOMAIN/PROBENAME/REST: DOMAIN is the - reverse domain to use as a namespace for the probe (e.g. org.clearlinux); - PROBENAME is the name of the probe; and REST is an arbitrary value that + reverse domain to use as a namespace for the probe (e.g. org.clearlinux), + PROBENAME is the name of the probe, and REST is an arbitrary value that the probe should use to classify the record. The maximum length for the classification string is 122 bytes. Each sub-category may be no longer than 40 bytes long. Two / delimiters are required. diff --git a/source/substitutions.txt b/source/substitutions.txt index 1f1d049d..e1a2e622 100644 --- a/source/substitutions.txt +++ b/source/substitutions.txt @@ -6,15 +6,6 @@ .. |CC| replace:: Clear Containers -.. |CAUTION-BACKUP-USB| replace:: - Burning an image formats the USB drive, and will destroy all pre-existing - content. Back up your data before proceeding. - -.. |CAUTION-UNMOUNT-USB-PARTITIONS| replace:: - Not fully unmounting the USB drive before burning an image could cause - file system checksum errors in it. If this happens, burn the image again - ensuring all the USB drive partitions are unmounted first. - .. |VB| replace:: VirtualBox .. |VBM| replace:: VirtualBox Manager diff --git a/source/tutorials/docker.rst b/source/tutorials/docker.rst index 8d646c2c..95eb49dc 100644 --- a/source/tutorials/docker.rst +++ b/source/tutorials/docker.rst @@ -147,7 +147,7 @@ Pulling and running an image from Docker Hub ******************************************** `Docker Hub`_ is a publically available container image repository which -comes preconfigured with Docker. In the example below we will pull and run +comes pre-configured with Docker. In the example below we will pull and run an the official Docker image for nginx\*, an open source reverse proxy server. #. First, pull a container image from Docker Hub using the