Merge pull request #200 from intelkevinputnam/kp-jira-3406

Kp jira 3406
2026-08-27 10:55:48 +00:00 · 2018-07-25 17:05:01 -07:00
parent addd0961ba 5eab2ea6bf
commit 09d392ac95
26 changed files with 48 additions and 40 deletions
@@ -1,7 +1,7 @@
 .. _cgdisk-manual-install:

 Create partitions for Clear Linux\* 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
@@ -291,4 +291,4 @@ partitions and select to format them.
   https://clearlinux.org/features/software-update

 .. _`Linux partitioning scheme`:
-   https://wiki.archlinux.org/index.php/partitioning#Partition_scheme
+   https://wiki.archlinux.org/index.php/partitioning#Partition_scheme
@@ -13,9 +13,9 @@ Instructions are also available for other operating systems:
 * :ref:`bootable-usb-mac`
 * :ref:`bootable-usb-windows`

-.. include:: ../../guides/maintenance/image-types.rst
-   :start-after: for different platforms and environments. 
-   :end-before: Table 1 lists the currently available images.
+.. include:: ../../reference/image-types.rst
+   :start-after: incl-image-filename: 
+   :end-before: incl-image-filename-end:

 .. include:: ../../guides/maintenance/download-verify-uncompress-linux.rst
   :Start-after: verify-linux:
@@ -13,9 +13,9 @@ Instructions are also available for other operating systems:
 * :ref:`bootable-usb-linux`
 * :ref:`bootable-usb-windows`

-.. include:: ../../guides/maintenance/image-types.rst
-   :start-after: for different platforms and environments. 
-   :end-before: Table 1 lists the currently available images.
+.. include:: ../../reference/image-types.rst
+   :start-after: incl-image-filename: 
+   :end-before: incl-image-filename-end:

 .. include:: ../../guides/maintenance/download-verify-uncompress-mac.rst
   :start-after: verify-mac:
@@ -13,9 +13,9 @@ Instructions are also available for other operating systems:
 * :ref:`bootable-usb-mac`
 * :ref:`bootable-usb-linux`

-.. include:: ../../guides/maintenance/image-types.rst
-   :start-after: for different platforms and environments. 
-   :end-before: Table 1 lists the currently available images.
+.. include:: ../../reference/image-types.rst
+   :start-after: incl-image-filename: 
+   :end-before: incl-image-filename-end:

 .. include:: ../../guides/maintenance/download-verify-uncompress-windows.rst
   :Start-after: verify-windows:
@@ -64,7 +64,7 @@ For additional help, see the `VMware Workstation Player guide`_.
 Clear Linux image types
 ***********************

-.. include:: ../../guides/maintenance/image-types.rst
+.. include:: ../../reference/image-types.rst
   :Start-after: image-types-content:

 Download the latest Clear Linux VMware image
@@ -74,7 +74,7 @@ For additional help, see the `VMware Workstation Player guide`_.
 Clear Linux image types
 ***********************

-.. include:: ../../guides/maintenance/image-types.rst
+.. include:: ../../reference/image-types.rst
   :Start-after: image-types-content:


@@ -1,7 +1,7 @@
 .. _vmware-esxi-preconfigured-cl-image:

 Run preconfigured Clear Linux\* 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,
@@ -14,7 +14,7 @@ Instructions for other operating systems are available:
 Image types
 ***********

-.. include:: image-types.rst
+.. include:: ../../reference/image-types.rst
   :start-after: image-types-content:

 .. _verify-linux:
@@ -14,7 +14,7 @@ Instructions for other operating systems are available:
 Image types
 ***********

-.. include:: image-types.rst
+.. include:: ../../reference/image-types.rst
   :start-after: image-types-content:

 .. _verify-mac:
@@ -14,7 +14,7 @@ Instructions for other operating systems are available:
 Image types
 ***********

-.. include:: image-types.rst
+.. include:: ../../reference/image-types.rst
   :start-after: image-types-content:

 .. _verify-windows:
@@ -1,7 +1,7 @@
 .. _increase-virtual-disk-size:

 Increase virtual disk size of a Clear Linux\* image 
-#################################################
+###################################################

 |CLOSIA| prebuilt images come in different sizes, ranging from 300 MB to 20
 GB. This guide describes how to increase the size of your prebuilt |CL| image
@@ -10,7 +10,7 @@ if you need more capacity.
 .. contents:: This guide will cover:

 Determine the partition order and sizes of the prebuilt image 
-***************************************************
+*************************************************************

 There are two methods to find the order and sizes of partitions virtual disk 
 of your prebuilt |CL| image.
@@ -21,5 +21,4 @@ maintaining |CLOSIA| after :ref:`installation <get-started>` is completed.
   download-verify-uncompress-linux
   download-verify-uncompress-mac
   download-verify-uncompress-windows
-   image-types
   autospec
@@ -46,6 +46,7 @@ Current OS version and update server info:
   swupd info

 .. code-block:: console
+
   Installed version: 23330
   Version URL:       https://download.clearlinux.org/update/
   Content URL:       https://cdn.download.clearlinux.org/update/
@@ -674,12 +674,12 @@ For `Method 3`:

 Figure 7 shows two VNC sessions (5901 and 5905) accepting connections from
 any host as specified by the `0.0.0.0`'s.  This is before the `-localhost` option was used.  
- 
+
 .. figure:: figures/vnc/vnc-7.png
   :scale: 100 %
   :alt: VNC session accepting connection from any host

-	Figure 7: VNC sessions (5901 and 5905) accepting connections from any host
+   Figure 7: VNC sessions (5901 and 5905) accepting connections from any host

 Figure 8 shows two VNC sessions (5901 and 5905) only accepting connections from localhost as specified by `127.0.0.1`'s. This is after the `-localhost` option was used.  
 
@@ -28,7 +28,7 @@ Clear Linux Guide Example
 *************************

 Introduction
-=========
+============

 Step-by-Step
 ============
@@ -18,7 +18,7 @@ Follow these general guidelines:
  it is not rendered.

 * Only create a table if the body of the table contains six or more cells,
-which is a minimum table size of at least 2x3 or 3x2.
+  which is a minimum table size of at least 2x3 or 3x2.

 ReST supports several types of tables. |CL| uses grid and
 :abbr:`CSV-tables (Comma Separated Values tables)`. Grid tables are only
@@ -1,7 +1,7 @@
 .. _compatible-kernels:

 Compatible Clear Linux\* kernels
-##############################
+################################

 The |CLOSIA| provides the following Linux kernels with a respective bundle.
 This document describes the specific use cases these `bundles`_ serve
@@ -1,12 +1,14 @@
 .. _image-types:

 Clear Linux\* image types
-#######################
+#########################

 .. _image-types-content:

 |CLOSIA| offers many types of `images`_ for different platforms and environments.

+.. _incl-image-filename:
+
 The naming convention of a |CL| image filename is:

 .. code-block:: console
@@ -21,6 +23,8 @@ The naming convention of a |CL| image filename is:
 * The *[compression type]* field specifies the compression type. Two types of
  compressions are used: GNU\* zip (*.gz*) and XZ (*.xz*).

+.. _incl-image-filename-end:
+
 Table 1 lists the currently available images that are platform independent.
 Table 2 lists the currently available images that are platform specific.

@@ -18,9 +18,11 @@ Prerequisites
 *************

 This tutorial assumes the following statements are true:
+
 * You are using a linux-based system to access AWS and can run :command:`SSH`
  to access the remote |CL| AWS image.
-* Your browser puts downloaded files in the :file:`$HOME/Downloads` directory.
+* Your browser puts downloaded files in the :file:`$HOME/Downloads`
+  directory.
 * You have already set up an AWS user account and logged into the AWS
  console.
  
@@ -1,7 +1,7 @@
  .. _kata:

 Install Kata Containers\*
-#######################
+#########################

 This tutorial describes how to install, configure and run Kata Containers\* on
 |CLOSIA|. Kata Containers is an open source project dedicated to the
@@ -73,9 +73,9 @@ Table notes:


 .. [#] The EFI partition holds the kernel and boot information for |CL| and
-   other operating systems. The partition size is dependent on    the number
-   of operating systems to be installed. In general, allocate about 100 MB per
-   operating system. For this tutorial, we used 1 GB.
+   other operating systems. The partition size is dependent on the number
+   of operating systems to be installed. In general, allocate about 100 MB
+   per operating system. For this tutorial, we used 1 GB.



@@ -72,7 +72,7 @@ Configure Apache Spark
   with your localhost IP address. View your IP address using the
   :command:`hostname -I` command.

-   .. code-block::
+   .. code-block:: bash

      SPARK_MASTER_HOST="10.300.200.100"

@@ -82,7 +82,7 @@ Configure Apache Spark
 #. Edit the :file:`/etc/spark/spark-defaults.conf` file and update the
   `spark.master` variable with the `SPARK_MASTER_HOST` address and port `7077`.

-   .. code-block::
+   .. code-block:: bash

      spark.master    spark://10.300.200.100:7077

@@ -105,7 +105,7 @@ Start the master server and a worker daemon
 #. Open an internet browser and view the worker daemon information using
   the master's IP address and port `8080`:

-   .. code-block::
+   .. code-block:: bash

      http://10.300.200.100:8080

@@ -122,7 +122,7 @@ Run the Spark wordcount example
 #. Open an internet browser and view the application information using
   the master's IP address and port `8080`:

-   .. code-block::
+   .. code-block:: bash

      http://10.300.200.100:8080

@@ -67,6 +67,7 @@ to clone the :guilabel:`telemetrics-backend` repository into the
   git clone https://github.com/clearlinux/telemetrics-backend

 .. note::
+
   You may need to set up the :envvar:`https_proxy` environment variable
   if you have issues reaching github.com.

@@ -109,10 +110,11 @@ following actions:
 * :option:`restart` - restart the nginx and uWSGI services.
 * :option:`uninstall` - uninstall all packages.

-  ..note::
+  .. note::
  
-  The :option:`uninstall` option does not perform any actions if the distro is
-  set to |CL| and will only uninstall packages if the distro is Ubuntu
+     The :option:`uninstall` option does not perform any actions if the 
+     distro is set to |CL| and will only uninstall packages if the distro is
+     Ubuntu

 Next, we install the telemetrics backend server with the following options:

@@ -1,7 +1,7 @@
 .. _web-server-install:

 Create a Clear Linux\* based web server
-#####################################
+#######################################

 This tutorial shows you how to create a LAMP server using |CLOSIA| and how to use phpMyAdmin\* to manage an associated database.

@@ -153,7 +153,7 @@ Once the installation is complete, you can name your blog and create a Wordpress
    `Figure 6: The WordPress login screen.`

 #. Enter your WordPress username and password.
-#. Check :guilabel:`Remember me`to save your credentials.
+#. Check :guilabel:`Remember me` to save your credentials.
 #. Click :guilabel:`Log in`.

 Figure 7 shows the WordPress dashboard after a successful login: