From 777af9aa97899d8f5d425e9000c35f2a6fafadef Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Thu, 27 Sep 2018 13:15:21 -0700 Subject: [PATCH] - standardize Related topics heading, Next steps heading - Clean up heading markup (reST) Signed-off-by: Kristal Dale --- .../bare-metal-install/bare-metal-install.rst | 19 ++++++++----------- .../cgdisk-manual-install.rst | 4 ++-- .../virtual-machine-install/hyper-v.rst | 6 +++--- .../virtual-machine-install/kvm.rst | 9 +++++---- .../virtual-machine-install.rst | 6 +++--- .../virtual-machine-install/virtualbox.rst | 12 ++++++------ .../vmw-player-preconf.rst | 5 ++++- .../virtual-machine-install/vmw-player.rst | 3 +++ .../vmware-esxi-install-cl.rst | 4 ++-- .../vmware-esxi-preconfigured-cl-image.rst | 4 ++-- 10 files changed, 38 insertions(+), 34 deletions(-) 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 7e2fc5ec..a9cf2463 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 @@ -302,18 +302,15 @@ You have now set your root password and are logged in with root privileges. You have successfully installed |CL| on a bare metal system using the automatic installation method and set the password for the ``root`` user. -The automatic installation of |CL| is designed to install with minimal -software overhead. Therefore, some housekeeping and package installations -could be needed before you can take full advantage of the |CL| operating -system. These instructions are captured in the :ref:`enable-user-space`. +Next steps +********** -* Create a new user -* Update the OS to its most current version using `swupd`. -* Install the most common applications for system administrators and - developers using bundles. -* Setup a new user. -* Setup `sudo` privileges for that new user. -* Install a GUI using those `sudo` privileges. +The automatic installation of |CL| is designed to install with minimal +software overhead. Some housekeeping and package installations could be +needed before you can take full advantage of the |CL| operating system. + +See the :ref:`enable-user-space` guide for additional information and +instructions. .. _`information about stateless`: diff --git a/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst b/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst index 73f78264..653f83d0 100644 --- a/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst +++ b/source/clear-linux/get-started/cgdisk-manual-install/cgdisk-manual-install.rst @@ -67,7 +67,7 @@ installation. Figure 4: :guilabel:`cgdisk` -Linux Partition setup +Linux partition setup ********************* In order to properly set up the |CL| partitioning scheme, we create three @@ -173,7 +173,7 @@ about it, review `Rod Smith's Partitioning advice about alignment`_. Figure 9: :guilabel:`cgdisk - swap partition defined` Create the Linux filesystem partition -************************************* +===================================== Lastly, we must create the the Linux filesystem partition to use it as the root mount point for you |CL| installation. 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 cd87daf3..034e9749 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 @@ -13,13 +13,13 @@ Please ensure you have enabled `Intel® Virtualization Technology (Intel® VT-d) in your BIOS/UEFI firmware configuration. Enable Hyper-V -============== +************** Please refer to the `Microsoft documentation`_ to enable and configure *Hyper-V* on your machine. Create a virtual network -======================== +************************ 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 @@ -27,7 +27,7 @@ create a virtual network in the **Hyper-V Manager**. Refer to the a virtual network. Create a virtual machine -======================== +************************ #. Download and uncompress the latest hyperv disk image :file:`clear-XXXXX-hyperv.img.gz`, where XXXXX is the latest 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 75016454..ac192a9d 100644 --- a/source/clear-linux/get-started/virtual-machine-install/kvm.rst +++ b/source/clear-linux/get-started/virtual-machine-install/kvm.rst @@ -7,7 +7,7 @@ This section explains how to run |CL-ATTR| in a virtualized environment using :abbr:`KVM (Kernel-based Virtual Machine)`. Install QEMU-KVM -================ +**************** #. Enable the `Intel® Virtualization Technology`_ (Intel® VT) and the `Intel®Virtualization Technology for Directed I/O`_ (Intel® VT-d) in the @@ -47,7 +47,7 @@ Install QEMU-KVM dnf install qemu-kvm Download and launch the virtual machine -======================================= +*************************************** #. Download the latest pre-built |CL| KVM image file from the `image `_ directory. Look for @@ -87,7 +87,8 @@ Download and launch the virtual machine #. Log in as ``root`` user and set a new password. SSH access into the virtual machine -=================================== +*********************************** + To interact with the |CL| VM through SSH instead of the console it was launched from, follow these steps. @@ -107,7 +108,7 @@ launched from, follow these steps. ssh -p 10022 root@localhost Add the GNOME Display Manager (GDM) -=================================== +*********************************** To add :abbr:`GDM (GNOME Display Manager)` to the |CL| VM, follow these steps: 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 f8474fe2..7e9ae469 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 @@ -10,7 +10,7 @@ the end of this document, you will be able to select the set of installation steps most suitable to you and install |CL| under a VM. Compatible kernels -================== +****************** The |CL| provides the following Linux kernels with a respective :ref:`bundle ` for VMs. Specific use cases these bundles serve @@ -19,8 +19,8 @@ are provided along with links to their source code. .. include:: ../../reference/compatible-kernels.rst :Start-after: vm-kernels: -Next steps: -=========== +Next steps +********** Now that you have read about the |CL| compatible kernels, choose the appropriate set of step-by-step instructions to proceed. diff --git a/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst index 0fc7dfb4..3765aa8b 100644 --- a/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst @@ -6,14 +6,14 @@ Run pre-configured |CL-ATTR| as a VirtualBox\* guest OS This instruction explains how to deploy a pre-configured |CL-ATTR| image as a guest on the `VirtualBox hypervisor`_ . Download VirtualBox -=================== +******************* VirtualBox\* is a type 2 hypervisor from Oracle. Download and use **version 5.0 or greater** from the `official VirtualBox website`_. .. _create_vm_vbox: Prerequisites -============= +************* The instruction assumes that you have: @@ -29,7 +29,7 @@ The instruction assumes that you have: If you have not completed the above steps, do so before continuing. Create a virtual machine in VirtualBox -====================================== +************************************** #. Log in to your host and open a terminal emulator. @@ -103,7 +103,7 @@ Create a virtual machine in VirtualBox Run your new VM -=============== +*************** |CL| supports VirtualBox kernel modules used by the Linux kernel 4.14 :abbr:`LTS (Long Term Support)` @@ -147,7 +147,7 @@ To install the VirtualBox kernel modules, here are the steps: clr-boot-manager update Install Guest Additions ------------------------ +======================= The kernel modules are shipped with the ``kernel-lts`` bundle. Insert Guest Additions CD image using *Devices* menu you'll need to install the *user* @@ -170,7 +170,7 @@ follow these steps: Troubleshooting ---------------- +=============== On Windows OS, *VirtualBox* cannot do a **Hardware Virtualization** when *Hyper-V* is enabled. 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 8421f358..fa16dd5c 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,7 +1,7 @@ .. _vmw-player-preconf: 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 @@ -294,6 +294,9 @@ After configuring the settings above, power on your |CL| virtual machine. #. Click :guilabel:`Play virtual machine`. +Related topics +************** + For other guides on using the VMWare Player and ESXi, see: * :ref:`vmw-player` 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 e8617d71..5ca3eebb 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 @@ -280,6 +280,9 @@ After configuring the settings above, power on your |CL| virtual machine. #. Click :guilabel:`Play virtual machine`. +Related topics +************** + For other guides on using the VMWare Player and ESXi, see: * :ref:`vmw-player-preconf` 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 e056191f..2adb6a67 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 @@ -283,8 +283,8 @@ After configuring the settings above, power on the VM. Figure 16: VMware ESXi - Navigator > Virtual Machines > Power on VM -See Also: -========= +Related topics +************** * :ref:`vmware-esxi-preconfigured-cl-image` 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 709e5503..9ba10c56 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 @@ -277,8 +277,8 @@ After configuring the settings above, power on the VM. Figure 13: VMware ESXi - Navigator > Virtual Machines > Power on VM -See Also: -========= +Related topics +************** * :ref:`vmware-esxi-install-cl`