From 622b8c0a3eaade5f1c51b11d22f7dba88cf30369 Mon Sep 17 00:00:00 2001 From: ihutchin Date: Tue, 29 Aug 2017 13:18:21 -0700 Subject: [PATCH 1/7] Restructures Clear Linux documentation to have five main sections Content files are moved, renamed, and relabeled to fit into get started, concepts, guides, tutorials, and reference sections. Toc-trees were changed where apropriate and section descriptions were provided. Signed-off-by: ihutchin --- source/clear-linux/bundles/bundles.rst | 10 ---- source/clear-linux/clear-linux.rst | 11 ++-- source/clear-linux/concepts/bundles-about.rst | 31 ++++++++++ source/clear-linux/concepts/concepts.rst | 13 ++++ .../about.rst => concepts/swupd-about.rst} | 11 +++- .../bare-metal-install/bare-metal-install.rst | 6 +- .../bare-metal-install/figures/gnomedt.png | Bin .../compatibility-check.rst | 2 +- .../clear-linux/get-started/get-started.rst | 23 +++++++ .../live-image.rst | 4 +- .../figures/7zipwin.png | Bin .../figures/confirmation-screen.png | Bin .../figures/vbox-cd.png | Bin .../figures/vbox-convert-image.png | Bin .../figures/vbox-create-vm.png | Bin .../figures/vbox-efi.png | Bin .../figures/vbox-hdisk.png | Bin .../figures/vbox-memory-size.png | Bin .../figures/vbox-no-vtx.png | Bin .../figures/vbox-x.png | Bin .../virtual-machine-install}/hyper-v.rst | 28 ++++----- .../virtual-machine-install}/kvm.rst | 4 +- .../virtual-machine-install.rst | 36 +++++++++++ .../virtual-machine-install}/virtualbox.rst | 4 +- .../virtual-machine-install}/vmware-esxi.rst | 4 +- .../vmware-player.rst | 4 +- .../getting-started/getting-started.rst | 17 ------ source/clear-linux/guides/guides.rst | 13 ++++ .../maintenance/bulk-provision.rst} | 8 +-- .../figures/bulk-provision-flow.png | Bin .../guides/maintenance/maintenance.rst | 12 ++++ .../{how-to => guides/maintenance}/mixer.rst | 4 +- .../run.rst => guides/maintenance/update.rst} | 6 +- .../maintenance}/validate-signatures.rst | 4 +- .../clear-linux/{ => guides}/network/dpdk.rst | 4 +- .../network/figures/network-boot-flow.png | Bin .../network/figures/network-boot-setup.png | Bin .../network/figures/pktgen_lw3fd.png | Bin .../network/figures/pyshical_net.png | Bin .../{ => guides}/network/figures/use-case.png | Bin .../{ => guides}/network/network-bonding.rst | 4 +- .../{ => guides}/network/network-boot.rst | 4 +- .../{ => guides}/network/network.rst | 6 +- .../{ => guides}/network/ovs-dpdk.rst | 4 +- source/clear-linux/how-to/how-to.rst | 14 ----- .../clear-linux/reference/bundle-commands.rst | 22 +++++++ .../bundles/available-bundles.rst} | 56 +++++------------- .../bundles/containers-basic.rst | 0 .../bundles/openssh-server.rst | 0 .../{ => reference}/bundles/os-core.rst | 0 .../compatible-kernels.rst} | 25 ++++---- source/clear-linux/reference/reference.rst | 15 +++++ .../supported-hardware.rst | 2 +- .../{how-to => tutorials}/azure.rst | 0 source/clear-linux/tutorials/tutorials.rst | 10 ++-- source/clear-linux/tutorials/wordpress.rst | 2 +- .../tutorials/wp-install/wp-install.rst | 4 +- .../virtual-environments.rst | 13 ---- 58 files changed, 263 insertions(+), 177 deletions(-) delete mode 100644 source/clear-linux/bundles/bundles.rst create mode 100644 source/clear-linux/concepts/bundles-about.rst create mode 100644 source/clear-linux/concepts/concepts.rst rename source/clear-linux/{how-to/swupd/about.rst => concepts/swupd-about.rst} (97%) rename source/clear-linux/{getting-started => get-started}/bare-metal-install/bare-metal-install.rst (98%) rename source/clear-linux/{getting-started => get-started}/bare-metal-install/figures/gnomedt.png (100%) rename source/clear-linux/{getting-started => get-started}/compatibility-check.rst (98%) create mode 100644 source/clear-linux/get-started/get-started.rst rename source/clear-linux/{getting-started => get-started}/live-image.rst (94%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/7zipwin.png (100%) rename source/clear-linux/{getting-started => get-started/virtual-machine-install}/figures/confirmation-screen.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/vbox-cd.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/vbox-convert-image.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/vbox-create-vm.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/vbox-efi.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/vbox-hdisk.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/vbox-memory-size.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/vbox-no-vtx.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/figures/vbox-x.png (100%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/hyper-v.rst (61%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/kvm.rst (98%) create mode 100644 source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/virtualbox.rst (99%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/vmware-esxi.rst (98%) rename source/clear-linux/{virtual-environments => get-started/virtual-machine-install}/vmware-player.rst (98%) delete mode 100644 source/clear-linux/getting-started/getting-started.rst create mode 100644 source/clear-linux/guides/guides.rst rename source/clear-linux/{how-to/bulk-provisioning.rst => guides/maintenance/bulk-provision.rst} (98%) rename source/clear-linux/{how-to => guides/maintenance}/figures/bulk-provision-flow.png (100%) create mode 100644 source/clear-linux/guides/maintenance/maintenance.rst rename source/clear-linux/{how-to => guides/maintenance}/mixer.rst (99%) rename source/clear-linux/{how-to/swupd/run.rst => guides/maintenance/update.rst} (95%) rename source/clear-linux/{how-to => guides/maintenance}/validate-signatures.rst (99%) rename source/clear-linux/{ => guides}/network/dpdk.rst (99%) rename source/clear-linux/{ => guides}/network/figures/network-boot-flow.png (100%) rename source/clear-linux/{ => guides}/network/figures/network-boot-setup.png (100%) rename source/clear-linux/{ => guides}/network/figures/pktgen_lw3fd.png (100%) rename source/clear-linux/{ => guides}/network/figures/pyshical_net.png (100%) rename source/clear-linux/{ => guides}/network/figures/use-case.png (100%) rename source/clear-linux/{ => guides}/network/network-bonding.rst (98%) rename source/clear-linux/{ => guides}/network/network-boot.rst (99%) rename source/clear-linux/{ => guides}/network/network.rst (52%) rename source/clear-linux/{ => guides}/network/ovs-dpdk.rst (99%) delete mode 100644 source/clear-linux/how-to/how-to.rst create mode 100644 source/clear-linux/reference/bundle-commands.rst rename source/clear-linux/{bundles/overview.rst => reference/bundles/available-bundles.rst} (97%) rename source/clear-linux/{ => reference}/bundles/containers-basic.rst (100%) rename source/clear-linux/{ => reference}/bundles/openssh-server.rst (100%) rename source/clear-linux/{ => reference}/bundles/os-core.rst (100%) rename source/clear-linux/{getting-started/kernels.rst => reference/compatible-kernels.rst} (97%) create mode 100644 source/clear-linux/reference/reference.rst rename source/clear-linux/{getting-started => reference}/supported-hardware.rst (96%) rename source/clear-linux/{how-to => tutorials}/azure.rst (100%) delete mode 100644 source/clear-linux/virtual-environments/virtual-environments.rst diff --git a/source/clear-linux/bundles/bundles.rst b/source/clear-linux/bundles/bundles.rst deleted file mode 100644 index 98b0416a..00000000 --- a/source/clear-linux/bundles/bundles.rst +++ /dev/null @@ -1,10 +0,0 @@ -Bundles -####### - -.. toctree:: - :maxdepth: 2 - - overview - containers-basic - openssh-server - os-core diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index 82ade7b6..c270b683 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -6,9 +6,8 @@ Clear Linux\* Project for Intel® Architecture .. toctree:: :maxdepth: 2 - getting-started/getting-started - bundles/bundles - how-to/how-to - network/network - virtual-environments/virtual-environments - tutorials/tutorials \ No newline at end of file + get-started/get-started + concepts/concepts + guides/guides + tutorials/tutorials + reference/reference \ No newline at end of file diff --git a/source/clear-linux/concepts/bundles-about.rst b/source/clear-linux/concepts/bundles-about.rst new file mode 100644 index 00000000..f1f5645a --- /dev/null +++ b/source/clear-linux/concepts/bundles-about.rst @@ -0,0 +1,31 @@ +.. _bundles-about: + +Bundles +####### + +Linux-based operating systems contain the code of several hundred, if +not thousands, of open source projects. To make this manageable, +distributions use a concept called "packages" to configure and compile +the source code of these projects into binaries. + +Many distributions then split the content of these compiled packages +into so-called sub-packages, which are the granularity at which these +distributions deploy their software. With those kinds of distributions, +system administrators can then install and update sub-packages +individually or as a set, using tools such as "yum" and "apt-get." + +The Clear Linux\* OS for Intel® Architecture takes a slightly different +approach. While we also use the concept of packages to manage compiling +source code into binaries, we do not use the package concept to deploy +software. Instead, we provide "bundles" that  provide a set of functionality +to the system administrator, independent of how many and which pieces of +the upstream open source projects are needed for this functionality. + +Next steps +========== + +To put this concept into practice, see the following resources: + +* :ref:`available-bundles` +* :ref:`bundle-commands` +* :ref:`compatible-kernels` \ No newline at end of file diff --git a/source/clear-linux/concepts/concepts.rst b/source/clear-linux/concepts/concepts.rst new file mode 100644 index 00000000..dd8e9b4d --- /dev/null +++ b/source/clear-linux/concepts/concepts.rst @@ -0,0 +1,13 @@ +.. _concepts: + +Concepts +######## + +Get a deep understanding of how |CLOSIA| works. Read through concepts that are +unique to |CL|. + +.. toctree:: + :maxdepth: 1 + + swupd-about + bundles-about \ No newline at end of file diff --git a/source/clear-linux/how-to/swupd/about.rst b/source/clear-linux/concepts/swupd-about.rst similarity index 97% rename from source/clear-linux/how-to/swupd/about.rst rename to source/clear-linux/concepts/swupd-about.rst index ee6a7260..341b55de 100644 --- a/source/clear-linux/how-to/swupd/about.rst +++ b/source/clear-linux/concepts/swupd-about.rst @@ -1,7 +1,7 @@ .. _swupd-about: -About software update -##################### +Software update +############### The traditional way =================== @@ -129,6 +129,13 @@ system and its updates as the basis. Using this tool, system administrators can focus on the custom pieces their deployments require while staying on a controlled update stream. +Next steps +========== + +To put this concept into practice, we have the following step-by-step +instruction: + +* :ref:`update` .. [1] The software update technology for Clear Linux* OS for Intel Architecture was first presented at the Linux Plumbers conference in 2012. diff --git a/source/clear-linux/getting-started/bare-metal-install/bare-metal-install.rst b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst similarity index 98% rename from source/clear-linux/getting-started/bare-metal-install/bare-metal-install.rst rename to source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst index e7d6ea56..be13c8b9 100644 --- a/source/clear-linux/getting-started/bare-metal-install/bare-metal-install.rst +++ b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst @@ -1,6 +1,6 @@ .. _bare-metal-install: -Clear Linux host OS install on bare metal +Install Clear Linux host OS on bare metal ######################################### These instructions will guide you through the installation of |CL| on bare @@ -8,7 +8,7 @@ metal using a :ref:`bootable USB drive`. Verify your system hardware is supported by |CLOSIA|. Review the :ref:`list of supported processors ` and -:ref:`instructions to run a compatibility check `. +:ref:`instructions to run a compatibility check `. .. note:: @@ -337,7 +337,7 @@ Next steps With your system now running |CL| many paths are open for you. -Visit our :ref:`tutorials ` page for examples on using your |CL| +Visit our :ref:`tutorials` page for examples on using your |CL| system. .. _`NUC6i5SYH product page`: diff --git a/source/clear-linux/getting-started/bare-metal-install/figures/gnomedt.png b/source/clear-linux/get-started/bare-metal-install/figures/gnomedt.png similarity index 100% rename from source/clear-linux/getting-started/bare-metal-install/figures/gnomedt.png rename to source/clear-linux/get-started/bare-metal-install/figures/gnomedt.png diff --git a/source/clear-linux/getting-started/compatibility-check.rst b/source/clear-linux/get-started/compatibility-check.rst similarity index 98% rename from source/clear-linux/getting-started/compatibility-check.rst rename to source/clear-linux/get-started/compatibility-check.rst index 23930e36..bd2700e4 100644 --- a/source/clear-linux/getting-started/compatibility-check.rst +++ b/source/clear-linux/get-started/compatibility-check.rst @@ -1,4 +1,4 @@ -.. _check-compatibility: +.. _compatibility-check: Check system compatibility with Clear Linux OS for Intel® Architecture ###################################################################### diff --git a/source/clear-linux/get-started/get-started.rst b/source/clear-linux/get-started/get-started.rst new file mode 100644 index 00000000..24cbd016 --- /dev/null +++ b/source/clear-linux/get-started/get-started.rst @@ -0,0 +1,23 @@ +.. _get-started: + +Get started +########### + +This section is where you will find documentation to do with the +installation of |CL|. + +The :ref:`get-started` section provides end to end instructions for +downloading and running |CL| on :ref:`bare metal `, under +a :ref:`virtual machine `, or by way of :ref:`live image `. +It is also home to single task instructions and other useful information +related to tasks preceding the installation of |CL|. + +.. toctree:: + :maxdepth: 1 + + bare-metal-install/bare-metal-install + virtual-machine-install/virtual-machine-install + live-image + compatibility-check + ../reference/supported-hardware + diff --git a/source/clear-linux/getting-started/live-image.rst b/source/clear-linux/get-started/live-image.rst similarity index 94% rename from source/clear-linux/getting-started/live-image.rst rename to source/clear-linux/get-started/live-image.rst index 45fb3477..3d3e19cd 100644 --- a/source/clear-linux/getting-started/live-image.rst +++ b/source/clear-linux/get-started/live-image.rst @@ -1,7 +1,7 @@ .. _live-image: -Live Image Installation -####################### +Install Clear Linux from a live image +##################################### This option is a great way to try a live |CL| environment without writing to your computer's hard disk. diff --git a/source/clear-linux/virtual-environments/figures/7zipwin.png b/source/clear-linux/get-started/virtual-machine-install/figures/7zipwin.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/7zipwin.png rename to source/clear-linux/get-started/virtual-machine-install/figures/7zipwin.png diff --git a/source/clear-linux/getting-started/figures/confirmation-screen.png b/source/clear-linux/get-started/virtual-machine-install/figures/confirmation-screen.png similarity index 100% rename from source/clear-linux/getting-started/figures/confirmation-screen.png rename to source/clear-linux/get-started/virtual-machine-install/figures/confirmation-screen.png diff --git a/source/clear-linux/virtual-environments/figures/vbox-cd.png b/source/clear-linux/get-started/virtual-machine-install/figures/vbox-cd.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/vbox-cd.png rename to source/clear-linux/get-started/virtual-machine-install/figures/vbox-cd.png diff --git a/source/clear-linux/virtual-environments/figures/vbox-convert-image.png b/source/clear-linux/get-started/virtual-machine-install/figures/vbox-convert-image.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/vbox-convert-image.png rename to source/clear-linux/get-started/virtual-machine-install/figures/vbox-convert-image.png diff --git a/source/clear-linux/virtual-environments/figures/vbox-create-vm.png b/source/clear-linux/get-started/virtual-machine-install/figures/vbox-create-vm.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/vbox-create-vm.png rename to source/clear-linux/get-started/virtual-machine-install/figures/vbox-create-vm.png diff --git a/source/clear-linux/virtual-environments/figures/vbox-efi.png b/source/clear-linux/get-started/virtual-machine-install/figures/vbox-efi.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/vbox-efi.png rename to source/clear-linux/get-started/virtual-machine-install/figures/vbox-efi.png diff --git a/source/clear-linux/virtual-environments/figures/vbox-hdisk.png b/source/clear-linux/get-started/virtual-machine-install/figures/vbox-hdisk.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/vbox-hdisk.png rename to source/clear-linux/get-started/virtual-machine-install/figures/vbox-hdisk.png diff --git a/source/clear-linux/virtual-environments/figures/vbox-memory-size.png b/source/clear-linux/get-started/virtual-machine-install/figures/vbox-memory-size.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/vbox-memory-size.png rename to source/clear-linux/get-started/virtual-machine-install/figures/vbox-memory-size.png diff --git a/source/clear-linux/virtual-environments/figures/vbox-no-vtx.png b/source/clear-linux/get-started/virtual-machine-install/figures/vbox-no-vtx.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/vbox-no-vtx.png rename to source/clear-linux/get-started/virtual-machine-install/figures/vbox-no-vtx.png diff --git a/source/clear-linux/virtual-environments/figures/vbox-x.png b/source/clear-linux/get-started/virtual-machine-install/figures/vbox-x.png similarity index 100% rename from source/clear-linux/virtual-environments/figures/vbox-x.png rename to source/clear-linux/get-started/virtual-machine-install/figures/vbox-x.png diff --git a/source/clear-linux/virtual-environments/hyper-v.rst b/source/clear-linux/get-started/virtual-machine-install/hyper-v.rst similarity index 61% rename from source/clear-linux/virtual-environments/hyper-v.rst rename to source/clear-linux/get-started/virtual-machine-install/hyper-v.rst index 1facf2ec..69ac209f 100644 --- a/source/clear-linux/virtual-environments/hyper-v.rst +++ b/source/clear-linux/get-started/virtual-machine-install/hyper-v.rst @@ -1,7 +1,7 @@ .. _hyper-v: -Using Hyper-V\* -############### +Use Hyper-V\* +############# This section explains how to run |CLOSIA| inside a `Windows Server Virtualization`_\* or **Hyper-V** environment. @@ -12,26 +12,19 @@ Please ensure you have enabled `Intel® Virtualization Technology `_ (Intel® VT-d) in your BIOS/UEFI firmware configuration. -Enable Hyper-V -============== +Install Hyper-V +================ -Please refer to the `Microsoft documentation`_ to enable and configure +Please refer to the `Microsoft documentation`_ to install 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 -`Create a Virtual Network documentation`_ to create and configure -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 - available version of |CLOSIA| from our `downloads`_ section. + :file:`clear-XXXX-hyperv.img.gz`, where XXXX is the latest + available version of |CLOSIA| from our `downloads`_ + section. #. Create a virtual machine using the **Hyper-V Manager**: @@ -54,8 +47,7 @@ Create a virtual machine Your virtual machine running |CLOSIA| is ready! -.. _Windows Server Virtualization: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/about/ -.. _Microsoft documentation: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v -.. _Create A Virtual Network documentation: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network +.. _Windows Server Virtualization: https://www.microsoft.com/en-us/server-cloud/solutions/virtualization.aspx +.. _Microsoft documentation: https://www.microsoft.com/en-us/server-cloud/solutions/virtualization.aspx .. _downloads: https://download.clearlinux.org/image/ diff --git a/source/clear-linux/virtual-environments/kvm.rst b/source/clear-linux/get-started/virtual-machine-install/kvm.rst similarity index 98% rename from source/clear-linux/virtual-environments/kvm.rst rename to source/clear-linux/get-started/virtual-machine-install/kvm.rst index 2384609a..c72bf307 100644 --- a/source/clear-linux/virtual-environments/kvm.rst +++ b/source/clear-linux/get-started/virtual-machine-install/kvm.rst @@ -1,7 +1,7 @@ .. _kvm: -Using KVM -######### +Use KVM +####### The easiest way to get started in a virtualized environment is to download a recent KVM image from the `images`_ directory. Here you'll find a kvm 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 new file mode 100644 index 00000000..f5ad370b --- /dev/null +++ b/source/clear-linux/get-started/virtual-machine-install/virtual-machine-install.rst @@ -0,0 +1,36 @@ +.. _virtual-machine-install: + +Install Clear Linux under a Virtual Machine +########################################### + +There are some considerations to make when installing |CL| under a VM. +First, you need to decide which kernel to use. This document +will walk you through the available kernel options to help this decision. At +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 |CLOSIA| provides the following Linux kernels with a respective +:ref:`bundle ` for VMs. Specific use cases these bundles serve +are provided along with links to their source code. + +.. include:: ../../reference/compatible-kernels.rst + :Start-after: vm-kernels: + +Next steps: +=========== + +Now that you have read about the |CL| compatible kernels, choose the +appropriate set of step by step instructions to proceed. + +.. toctree:: + :maxdepth: 1 + + kvm + virtualbox + vmware-esxi + vmware-player + hyper-v + diff --git a/source/clear-linux/virtual-environments/virtualbox.rst b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst similarity index 99% rename from source/clear-linux/virtual-environments/virtualbox.rst rename to source/clear-linux/get-started/virtual-machine-install/virtualbox.rst index 44a98f73..3b0bbe98 100644 --- a/source/clear-linux/virtual-environments/virtualbox.rst +++ b/source/clear-linux/get-started/virtual-machine-install/virtualbox.rst @@ -1,7 +1,7 @@ .. _virtualbox: -Using VirtualBox\* -################## +Use VirtualBox\* +################ This section explains how to run |CLOSIA| inside a `VirtualBox environment`_. diff --git a/source/clear-linux/virtual-environments/vmware-esxi.rst b/source/clear-linux/get-started/virtual-machine-install/vmware-esxi.rst similarity index 98% rename from source/clear-linux/virtual-environments/vmware-esxi.rst rename to source/clear-linux/get-started/virtual-machine-install/vmware-esxi.rst index df4681ef..1ee967e4 100644 --- a/source/clear-linux/virtual-environments/vmware-esxi.rst +++ b/source/clear-linux/get-started/virtual-machine-install/vmware-esxi.rst @@ -1,7 +1,7 @@ .. _vmware-esxi: -Using VMware\* ESXi guest -########################## +Use VMware\* ESXi guest +####################### This section is based on *VMware vSphere 6* and explains how to use |CLOSIA| diff --git a/source/clear-linux/virtual-environments/vmware-player.rst b/source/clear-linux/get-started/virtual-machine-install/vmware-player.rst similarity index 98% rename from source/clear-linux/virtual-environments/vmware-player.rst rename to source/clear-linux/get-started/virtual-machine-install/vmware-player.rst index 983dbe5c..b2d36417 100644 --- a/source/clear-linux/virtual-environments/vmware-player.rst +++ b/source/clear-linux/get-started/virtual-machine-install/vmware-player.rst @@ -1,7 +1,7 @@ .. _vmware-player: -Using VMware\* Player -##################### +Use VMware\* Player +################### This section explains how to run Clear Linux OS for Intel® Architecture within a `VMware Player`_ environment. diff --git a/source/clear-linux/getting-started/getting-started.rst b/source/clear-linux/getting-started/getting-started.rst deleted file mode 100644 index f44584f8..00000000 --- a/source/clear-linux/getting-started/getting-started.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _getting-started: - -Getting started -############### - -There are a number of options available for downloading and running -|CLOSIA|. Using different kernels, you can install |CL| under virtual -machines, containers, on bare metal, or by way of live image. - -.. toctree:: - :maxdepth: 2 - - kernels - bare-metal-install/bare-metal-install - supported-hardware - check-compatibility - live-image diff --git a/source/clear-linux/guides/guides.rst b/source/clear-linux/guides/guides.rst new file mode 100644 index 00000000..0e614850 --- /dev/null +++ b/source/clear-linux/guides/guides.rst @@ -0,0 +1,13 @@ +.. _guides: + +Guides +###### + +The following guides provide step by step instruction for all tasks that come +after |CL| :ref:`installation `. + +.. toctree:: + :maxdepth: 2 + + maintenance/maintenance + network/network diff --git a/source/clear-linux/how-to/bulk-provisioning.rst b/source/clear-linux/guides/maintenance/bulk-provision.rst similarity index 98% rename from source/clear-linux/how-to/bulk-provisioning.rst rename to source/clear-linux/guides/maintenance/bulk-provision.rst index 6f14fec1..b44095bc 100644 --- a/source/clear-linux/how-to/bulk-provisioning.rst +++ b/source/clear-linux/guides/maintenance/bulk-provision.rst @@ -1,7 +1,7 @@ -.. _bulk-provisioning: +.. _bulk-provision: -Bulk Provisioning -################# +Bulk Provision +############## The |CLOSIA| can be automatically provisioned in bulk using a combination of the |CL| installer, **Ister**, and :abbr:`ICIS (Ister Cloud Init Service)`. @@ -49,7 +49,7 @@ Configuration with the steps it needs to perform an installation. The file outlines what partitions, file systems, and mount points **Ister** should set up. Lastly, the file outlines which bundles to install. See our - :ref:`overview` for the list of available bundles. The + :ref:`available-bundles` document for the list of available bundles. The following example shows the contents of an Ister installation file: .. code-block:: json diff --git a/source/clear-linux/how-to/figures/bulk-provision-flow.png b/source/clear-linux/guides/maintenance/figures/bulk-provision-flow.png similarity index 100% rename from source/clear-linux/how-to/figures/bulk-provision-flow.png rename to source/clear-linux/guides/maintenance/figures/bulk-provision-flow.png diff --git a/source/clear-linux/guides/maintenance/maintenance.rst b/source/clear-linux/guides/maintenance/maintenance.rst new file mode 100644 index 00000000..4a2cbc6c --- /dev/null +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -0,0 +1,12 @@ +.. _maintenance: + +Maintenance guide +################# + +.. toctree:: + :maxdepth: 2 + + update + bulk-provision + mixer + validate-signatures diff --git a/source/clear-linux/how-to/mixer.rst b/source/clear-linux/guides/maintenance/mixer.rst similarity index 99% rename from source/clear-linux/how-to/mixer.rst rename to source/clear-linux/guides/maintenance/mixer.rst index 97429769..be802d11 100644 --- a/source/clear-linux/how-to/mixer.rst +++ b/source/clear-linux/guides/maintenance/mixer.rst @@ -1,7 +1,7 @@ .. _mixer: -Mixer tool -########## +Use mixer tool +############## *Mixing* refers to composing an operating system for specific use cases. While the default Clear Linux\* OS for Intel® Architecture provides options to diff --git a/source/clear-linux/how-to/swupd/run.rst b/source/clear-linux/guides/maintenance/update.rst similarity index 95% rename from source/clear-linux/how-to/swupd/run.rst rename to source/clear-linux/guides/maintenance/update.rst index 067d0515..5705fda3 100644 --- a/source/clear-linux/how-to/swupd/run.rst +++ b/source/clear-linux/guides/maintenance/update.rst @@ -1,7 +1,7 @@ -.. _swupd-run: +.. _update: -How to update Clear Linux -######################### +Update Clear Linux +################## This section describes how to update |CLOSIA|. diff --git a/source/clear-linux/how-to/validate-signatures.rst b/source/clear-linux/guides/maintenance/validate-signatures.rst similarity index 99% rename from source/clear-linux/how-to/validate-signatures.rst rename to source/clear-linux/guides/maintenance/validate-signatures.rst index 07a24175..190e4f59 100644 --- a/source/clear-linux/how-to/validate-signatures.rst +++ b/source/clear-linux/guides/maintenance/validate-signatures.rst @@ -1,7 +1,7 @@ .. _validate-signatures: -Validating signatures -##################### +Validate signatures +################### |CLOSIA| offers a way to validate the content of an image or an update. All validation of content works by creating and signing a hash. A valid signature diff --git a/source/clear-linux/network/dpdk.rst b/source/clear-linux/guides/network/dpdk.rst similarity index 99% rename from source/clear-linux/network/dpdk.rst rename to source/clear-linux/guides/network/dpdk.rst index cdb86748..9c339ced 100644 --- a/source/clear-linux/network/dpdk.rst +++ b/source/clear-linux/guides/network/dpdk.rst @@ -1,7 +1,7 @@ .. _dpdk: -DPDK -#### +Send packages between platforms +############################### :abbr:`Data Plane Development Kit (DPDK)` is a set of libraries and drivers for fast packet processing. This document describes how to run a basic use diff --git a/source/clear-linux/network/figures/network-boot-flow.png b/source/clear-linux/guides/network/figures/network-boot-flow.png similarity index 100% rename from source/clear-linux/network/figures/network-boot-flow.png rename to source/clear-linux/guides/network/figures/network-boot-flow.png diff --git a/source/clear-linux/network/figures/network-boot-setup.png b/source/clear-linux/guides/network/figures/network-boot-setup.png similarity index 100% rename from source/clear-linux/network/figures/network-boot-setup.png rename to source/clear-linux/guides/network/figures/network-boot-setup.png diff --git a/source/clear-linux/network/figures/pktgen_lw3fd.png b/source/clear-linux/guides/network/figures/pktgen_lw3fd.png similarity index 100% rename from source/clear-linux/network/figures/pktgen_lw3fd.png rename to source/clear-linux/guides/network/figures/pktgen_lw3fd.png diff --git a/source/clear-linux/network/figures/pyshical_net.png b/source/clear-linux/guides/network/figures/pyshical_net.png similarity index 100% rename from source/clear-linux/network/figures/pyshical_net.png rename to source/clear-linux/guides/network/figures/pyshical_net.png diff --git a/source/clear-linux/network/figures/use-case.png b/source/clear-linux/guides/network/figures/use-case.png similarity index 100% rename from source/clear-linux/network/figures/use-case.png rename to source/clear-linux/guides/network/figures/use-case.png diff --git a/source/clear-linux/network/network-bonding.rst b/source/clear-linux/guides/network/network-bonding.rst similarity index 98% rename from source/clear-linux/network/network-bonding.rst rename to source/clear-linux/guides/network/network-bonding.rst index dca71fa5..6b562280 100644 --- a/source/clear-linux/network/network-bonding.rst +++ b/source/clear-linux/guides/network/network-bonding.rst @@ -1,7 +1,7 @@ .. _network-bonding: -Network Bonding -############### +Combine multiple interfaces +########################### Network bonding is a technique for combining multiple network interfaces into a single, logical interface, providing some redundancy and bandwidth diff --git a/source/clear-linux/network/network-boot.rst b/source/clear-linux/guides/network/network-boot.rst similarity index 99% rename from source/clear-linux/network/network-boot.rst rename to source/clear-linux/guides/network/network-boot.rst index 03e78e22..62de3eec 100644 --- a/source/clear-linux/network/network-boot.rst +++ b/source/clear-linux/guides/network/network-boot.rst @@ -1,7 +1,7 @@ .. _network-boot: -Network Booting -############### +Boot from PXE +############# |CLOSIA| can boot from a :abbr:`PXE (pre-boot execution environment)`. PXE is an industry standard which describes the client-server interaction to diff --git a/source/clear-linux/network/network.rst b/source/clear-linux/guides/network/network.rst similarity index 52% rename from source/clear-linux/network/network.rst rename to source/clear-linux/guides/network/network.rst index 2545276b..6a62a3f9 100644 --- a/source/clear-linux/network/network.rst +++ b/source/clear-linux/guides/network/network.rst @@ -1,10 +1,10 @@ .. _network: -Clear Linux\* OS Network guides -############################### +Network guide +############# .. toctree:: - :maxdepth: 2 + :maxdepth: 1 network-boot dpdk diff --git a/source/clear-linux/network/ovs-dpdk.rst b/source/clear-linux/guides/network/ovs-dpdk.rst similarity index 99% rename from source/clear-linux/network/ovs-dpdk.rst rename to source/clear-linux/guides/network/ovs-dpdk.rst index e61fc814..3f56cfa7 100644 --- a/source/clear-linux/network/ovs-dpdk.rst +++ b/source/clear-linux/guides/network/ovs-dpdk.rst @@ -1,7 +1,7 @@ .. _ovs-dpdk: -OpenvSwitch and DPDK -#################### +Enable DPDK support on OpenvSwitch +################################## Enabling `DPDK`_ support on the `OpenvSwitch`_ project can yield significant network performance improvements. To illustrate one such example, we'll cover diff --git a/source/clear-linux/how-to/how-to.rst b/source/clear-linux/how-to/how-to.rst deleted file mode 100644 index 97601d62..00000000 --- a/source/clear-linux/how-to/how-to.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _how-to: - -Clear Linux\* OS How to guides -############################## - -.. toctree:: - :maxdepth: 2 - - azure - swupd/about - swupd/run - bulk-provisioning - mixer - validate-signatures diff --git a/source/clear-linux/reference/bundle-commands.rst b/source/clear-linux/reference/bundle-commands.rst new file mode 100644 index 00000000..40ddf99f --- /dev/null +++ b/source/clear-linux/reference/bundle-commands.rst @@ -0,0 +1,22 @@ +.. _bundle-commands: + +Useful bundle commands +###################### + +To see a list of currently-installed bundles, enter: + +.. code-block:: console + + # swupd bundle-list + +To see the list of all available bundles, enter: + +.. code-block:: console + + # swupd bundle-list --all + +To add a bundle, enter: + +.. code-block:: console + + # swupd bundle-add [bundle name] \ No newline at end of file diff --git a/source/clear-linux/bundles/overview.rst b/source/clear-linux/reference/bundles/available-bundles.rst similarity index 97% rename from source/clear-linux/bundles/overview.rst rename to source/clear-linux/reference/bundles/available-bundles.rst index e22316f3..e643cef1 100644 --- a/source/clear-linux/bundles/overview.rst +++ b/source/clear-linux/reference/bundles/available-bundles.rst @@ -1,51 +1,22 @@ -.. _overview: +.. _available-bundles: -Bundles overview -################ +Available bundles +################# -Linux-based operating systems contain the code of several hundred, if -not thousands, of open source projects. To make this manageable, -distributions use a concept called "packages" to configure and compile -the source code of these projects into binaries. +This document provides a current list of available `bundles`_ as of +``[[24 April 2017]]``. -Many distributions then split the content of these compiled packages -into so-called sub-packages, which are the granularity at which these -distributions deploy their software. With those kinds of distributions, -system administrators can then install and update sub-packages -individually or as a set, using tools such as ``yum`` and ``apt-get``. +See in depth descriptions of the following bundles: -The |CLOSIA| takes a slightly different -approach. While we also use the concept of packages to manage compiling -source code into binaries, we do not use the package concept to deploy -software. Instead, we provide "bundles" that  provide a set of functionality -to the system administrator, independent of how many and which pieces of -the upstream open source projects are needed for this functionality. +.. toctree:: + :maxdepth: 1 -Useful bundle commands -====================== + containers-basic + openssh-server + os-core.rst -To see a list of currently-installed bundles, enter: - -.. code-block:: console - - # swupd bundle-list - -To see the list of all available bundles, enter: - -.. code-block:: console - - # swupd bundle-list --all - -To add a bundle, enter: - -.. code-block:: console - - # swupd bundle-add [bundle name] - -Bundle overview table -===================== - -Current list of available bundles as of ``[[24 April 2017]]``. +Bundle list +=========== .. raw:: html @@ -1040,3 +1011,4 @@ Current list of available bundles as of ``[[24 April 2017]]``. +.. _bundles: https://github.com/clearlinux/clr-bundles diff --git a/source/clear-linux/bundles/containers-basic.rst b/source/clear-linux/reference/bundles/containers-basic.rst similarity index 100% rename from source/clear-linux/bundles/containers-basic.rst rename to source/clear-linux/reference/bundles/containers-basic.rst diff --git a/source/clear-linux/bundles/openssh-server.rst b/source/clear-linux/reference/bundles/openssh-server.rst similarity index 100% rename from source/clear-linux/bundles/openssh-server.rst rename to source/clear-linux/reference/bundles/openssh-server.rst diff --git a/source/clear-linux/bundles/os-core.rst b/source/clear-linux/reference/bundles/os-core.rst similarity index 100% rename from source/clear-linux/bundles/os-core.rst rename to source/clear-linux/reference/bundles/os-core.rst diff --git a/source/clear-linux/getting-started/kernels.rst b/source/clear-linux/reference/compatible-kernels.rst similarity index 97% rename from source/clear-linux/getting-started/kernels.rst rename to source/clear-linux/reference/compatible-kernels.rst index 7aeb5329..ccf9c26d 100644 --- a/source/clear-linux/getting-started/kernels.rst +++ b/source/clear-linux/reference/compatible-kernels.rst @@ -1,7 +1,7 @@ -.. _kernels: +.. _compatible-kernels: -Compatible |CL| 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 @@ -15,6 +15,17 @@ optimized for fast booting and performs best on the Intel® architectures described on the :ref:`supported hardware list`. The optimization patches are found in our `Linux`_ GitHub\* repo. +Kernel Container +================ + +The *kernel-container* bundle contains the kernel used by the +`Intel® Clear Containers`_ project. This kernel is optimized for +fast booting and performs best on |CC| running on the Intel® architectures +described on the :ref:`supported hardware list`. +The optimization patches are found in our `Linux-Container`_ GitHub repo. + +.. _vm-kernels: + Kernel LTS ========== @@ -67,14 +78,6 @@ alone Linux VM, see our :ref:`instructions on using Hyper-V` for more information. The optimization patches are found in our `Linux-HyperV-LTS`_ GitHub repo. -Kernel Container -================ - -The *kernel-container* bundle contains the kernel used by the -`Intel® Clear Containers`_ project. This kernel is optimized for -fast booting and performs best on |CC| running on the Intel® architectures -described on the :ref:`supported hardware list`. -The optimization patches are found in our `Linux-Container`_ GitHub repo. .. _Linux: https://github.com/clearlinux-pkgs/linux .. _Linux-LTS: https://github.com/clearlinux-pkgs/linux-lts diff --git a/source/clear-linux/reference/reference.rst b/source/clear-linux/reference/reference.rst new file mode 100644 index 00000000..49de0990 --- /dev/null +++ b/source/clear-linux/reference/reference.rst @@ -0,0 +1,15 @@ +.. _reference: + +Reference +######### + +This section contains all content which provides additional information +regarding the |CL| project and it's features. + +.. toctree:: + :maxdepth: 2 + + bundle-commands + bundles/available-bundles + compatible-kernels + supported-hardware \ No newline at end of file diff --git a/source/clear-linux/getting-started/supported-hardware.rst b/source/clear-linux/reference/supported-hardware.rst similarity index 96% rename from source/clear-linux/getting-started/supported-hardware.rst rename to source/clear-linux/reference/supported-hardware.rst index f733a27c..89b138fb 100644 --- a/source/clear-linux/getting-started/supported-hardware.rst +++ b/source/clear-linux/reference/supported-hardware.rst @@ -23,7 +23,7 @@ system to determine whether it will work with the latest release: .. toctree:: :maxdepth: 1 - compatibility-check.rst + ../get-started/compatibility-check.rst .. note:: diff --git a/source/clear-linux/how-to/azure.rst b/source/clear-linux/tutorials/azure.rst similarity index 100% rename from source/clear-linux/how-to/azure.rst rename to source/clear-linux/tutorials/azure.rst diff --git a/source/clear-linux/tutorials/tutorials.rst b/source/clear-linux/tutorials/tutorials.rst index 8141c7af..babc586e 100644 --- a/source/clear-linux/tutorials/tutorials.rst +++ b/source/clear-linux/tutorials/tutorials.rst @@ -3,12 +3,14 @@ Tutorials ######### +This section provides instruction to walk you through completing |CL| use +cases. + .. toctree:: :maxdepth: 2 - wordpress.rst - flatpak/flatpak.rst + wordpress + flatpak/flatpak machine-learning/machine-learning + azure multi-boot/multi-boot - - diff --git a/source/clear-linux/tutorials/wordpress.rst b/source/clear-linux/tutorials/wordpress.rst index 72035aeb..f66bb1f6 100644 --- a/source/clear-linux/tutorials/wordpress.rst +++ b/source/clear-linux/tutorials/wordpress.rst @@ -9,7 +9,7 @@ to guide you to a fully realized WordPress website using |CLOSIA|. In this tutorial we assume your system is already running |CL|. For instructions on how to install |CL| on bare metal, see the :ref:`bare metal install` page from our -:ref:`getting started` guide. For your convenience, we have +:ref:`get-started` guide. For your convenience, we have split this tutorial in two different sections. If you already have a |CL| based :abbr:`LAMP (Linux, Apache, MySQL, PHP)` web server you can skip ahead to the WordPress tutorial. diff --git a/source/clear-linux/tutorials/wp-install/wp-install.rst b/source/clear-linux/tutorials/wp-install/wp-install.rst index 5a0f06f0..bc2274ea 100644 --- a/source/clear-linux/tutorials/wp-install/wp-install.rst +++ b/source/clear-linux/tutorials/wp-install/wp-install.rst @@ -1,7 +1,7 @@ .. _wp-install: -Creating a Clear Linux WordPress* server -######################################## +Creating a Clear Linux WordPress\* server +######################################### Prerequisites ============= diff --git a/source/clear-linux/virtual-environments/virtual-environments.rst b/source/clear-linux/virtual-environments/virtual-environments.rst deleted file mode 100644 index 216b5994..00000000 --- a/source/clear-linux/virtual-environments/virtual-environments.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _virtual-environments: - -Running in virtual environments -############################### - -.. toctree:: - :maxdepth: 2 - - kvm - virtualbox - vmware-esxi - vmware-player - hyper-v \ No newline at end of file From 7cb9cb0720cfd73d4e77f489defef55e74a44dd0 Mon Sep 17 00:00:00 2001 From: ihutchin Date: Tue, 29 Aug 2017 18:39:53 -0700 Subject: [PATCH 2/7] Updated file titles and descriptions to improve readability. Signed-off-by: ihutchin --- source/clear-linux/clear-linux.rst | 11 +++++++++++ source/clear-linux/concepts/concepts.rst | 5 +++-- source/clear-linux/concepts/swupd-about.rst | 8 +------- source/clear-linux/get-started/get-started.rst | 16 +++++++--------- source/clear-linux/get-started/live-image.rst | 4 ++-- .../virtual-machine-install.rst | 6 +++--- source/clear-linux/guides/guides.rst | 4 ++-- .../guides/maintenance/bulk-provision.rst | 2 +- .../guides/maintenance/maintenance.rst | 3 +++ source/clear-linux/guides/network/network.rst | 3 +++ source/clear-linux/reference/reference.rst | 4 ++-- source/clear-linux/tutorials/tutorials.rst | 4 ++-- .../tutorials/wp-install/wp-install.rst | 4 ++-- 13 files changed, 42 insertions(+), 32 deletions(-) diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index c270b683..a1083a19 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -3,6 +3,17 @@ Clear Linux\* Project for Intel® Architecture ############################################# +Welcome to the |CLOSIA| documentation pages. Our documentation is split into +five sections: Get started, Concepts, Guides, Tutorials, and Reference. +Under :ref:`Get started`, you can find information about installing |CL| on +bare metal, in a virtual environment, or as a live image on a USB stick. Under +the :ref:`Concepts` section, you can find detailed technical information about +the |CL| features. The :ref:`Guides` section contains step-by-step +instructions to complete common tasks. The :ref:`Tutorials` section contains +step-by-step instructions to complete the installation and configuration of +tools needed for a specific use case. Lastly, the :ref:`Reference` section +contains information providing additional context or details. + .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/concepts/concepts.rst b/source/clear-linux/concepts/concepts.rst index dd8e9b4d..06094655 100644 --- a/source/clear-linux/concepts/concepts.rst +++ b/source/clear-linux/concepts/concepts.rst @@ -3,8 +3,9 @@ Concepts ######## -Get a deep understanding of how |CLOSIA| works. Read through concepts that are -unique to |CL|. +The concepts section provides content for a deeper understanding of the +features of |CLOSIA|. These concepts attempt to provide all the technical +details relevant to the |CL| features. .. toctree:: :maxdepth: 1 diff --git a/source/clear-linux/concepts/swupd-about.rst b/source/clear-linux/concepts/swupd-about.rst index 341b55de..77b9ffaf 100644 --- a/source/clear-linux/concepts/swupd-about.rst +++ b/source/clear-linux/concepts/swupd-about.rst @@ -129,13 +129,7 @@ system and its updates as the basis. Using this tool, system administrators can focus on the custom pieces their deployments require while staying on a controlled update stream. -Next steps -========== - -To put this concept into practice, we have the following step-by-step -instruction: - -* :ref:`update` +To learn how to run an update of your system, visit our :ref:`update` page. .. [1] The software update technology for Clear Linux* OS for Intel Architecture was first presented at the Linux Plumbers conference in 2012. diff --git a/source/clear-linux/get-started/get-started.rst b/source/clear-linux/get-started/get-started.rst index 24cbd016..e7af0759 100644 --- a/source/clear-linux/get-started/get-started.rst +++ b/source/clear-linux/get-started/get-started.rst @@ -3,14 +3,13 @@ Get started ########### -This section is where you will find documentation to do with the -installation of |CL|. +This section contains information about the installation of |CLOSIA|. -The :ref:`get-started` section provides end to end instructions for -downloading and running |CL| on :ref:`bare metal `, under -a :ref:`virtual machine `, or by way of :ref:`live image `. -It is also home to single task instructions and other useful information -related to tasks preceding the installation of |CL|. +The :ref:`get-started` section provides step-by-step instructions to download +and run |CL| on :ref:`bare metal `, under +a :ref:`virtual machine `, or by way of a +:ref:`live image `. Additionally, it provides useful pre-install +information and instructions on how to complete pre-install tasks. .. toctree:: :maxdepth: 1 @@ -19,5 +18,4 @@ related to tasks preceding the installation of |CL|. virtual-machine-install/virtual-machine-install live-image compatibility-check - ../reference/supported-hardware - + ../reference/supported-hardware \ No newline at end of file diff --git a/source/clear-linux/get-started/live-image.rst b/source/clear-linux/get-started/live-image.rst index 3d3e19cd..bdfb37c0 100644 --- a/source/clear-linux/get-started/live-image.rst +++ b/source/clear-linux/get-started/live-image.rst @@ -1,7 +1,7 @@ .. _live-image: -Install Clear Linux from a live image -##################################### +Install Clear Linux as a live image +################################### This option is a great way to try a live |CL| environment without writing to your computer's hard disk. 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 f5ad370b..4dfe9614 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 @@ -1,9 +1,9 @@ .. _virtual-machine-install: -Install Clear Linux under a Virtual Machine -########################################### +Install Clear Linux in a virtual machine +######################################## -There are some considerations to make when installing |CL| under a VM. +There are some considerations to make when installing |CL| in a VM. First, you need to decide which kernel to use. This document will walk you through the available kernel options to help this decision. At the end of this document, you will be able to select the set of installation diff --git a/source/clear-linux/guides/guides.rst b/source/clear-linux/guides/guides.rst index 0e614850..c45065fb 100644 --- a/source/clear-linux/guides/guides.rst +++ b/source/clear-linux/guides/guides.rst @@ -3,8 +3,8 @@ Guides ###### -The following guides provide step by step instruction for all tasks that come -after |CL| :ref:`installation `. +The following guides provide step-by-step instructions for tasks that come +after completing the |CL| :ref:`installation `. .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/guides/maintenance/bulk-provision.rst b/source/clear-linux/guides/maintenance/bulk-provision.rst index b44095bc..4d2aa4f1 100644 --- a/source/clear-linux/guides/maintenance/bulk-provision.rst +++ b/source/clear-linux/guides/maintenance/bulk-provision.rst @@ -1,6 +1,6 @@ .. _bulk-provision: -Bulk Provision +Bulk provision ############## The |CLOSIA| can be automatically provisioned in bulk using a combination of diff --git a/source/clear-linux/guides/maintenance/maintenance.rst b/source/clear-linux/guides/maintenance/maintenance.rst index 4a2cbc6c..8d4f0c4b 100644 --- a/source/clear-linux/guides/maintenance/maintenance.rst +++ b/source/clear-linux/guides/maintenance/maintenance.rst @@ -3,6 +3,9 @@ Maintenance guide ################# +This guide provides step-by-step instructions for common tasks associated with +maintaining |CLOSIA| after :ref:`installation ` is completed. + .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/guides/network/network.rst b/source/clear-linux/guides/network/network.rst index 6a62a3f9..3b5f0ff8 100644 --- a/source/clear-linux/guides/network/network.rst +++ b/source/clear-linux/guides/network/network.rst @@ -3,6 +3,9 @@ Network guide ############# +This guide provides step-by-step instructions for common tasks associated with +the configuration and administration of networking for |CLOSIA|. + .. toctree:: :maxdepth: 1 diff --git a/source/clear-linux/reference/reference.rst b/source/clear-linux/reference/reference.rst index 49de0990..f1a8ba8c 100644 --- a/source/clear-linux/reference/reference.rst +++ b/source/clear-linux/reference/reference.rst @@ -3,8 +3,8 @@ Reference ######### -This section contains all content which provides additional information -regarding the |CL| project and it's features. +This section contains content which provides additional information +regarding the |CL| project and the |CL| features. .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/tutorials/tutorials.rst b/source/clear-linux/tutorials/tutorials.rst index babc586e..f0cef09f 100644 --- a/source/clear-linux/tutorials/tutorials.rst +++ b/source/clear-linux/tutorials/tutorials.rst @@ -3,8 +3,8 @@ Tutorials ######### -This section provides instruction to walk you through completing |CL| use -cases. +This section provides detailed instructions to guide you through completing +specific |CLOSIA| use cases. .. toctree:: :maxdepth: 2 diff --git a/source/clear-linux/tutorials/wp-install/wp-install.rst b/source/clear-linux/tutorials/wp-install/wp-install.rst index bc2274ea..7112c3aa 100644 --- a/source/clear-linux/tutorials/wp-install/wp-install.rst +++ b/source/clear-linux/tutorials/wp-install/wp-install.rst @@ -1,7 +1,7 @@ .. _wp-install: -Creating a Clear Linux WordPress\* server -######################################### +Create a Clear Linux WordPress\* server +####################################### Prerequisites ============= From 55cbf61297490a40e17e6a45cc96f7e97e14fd6b Mon Sep 17 00:00:00 2001 From: Ianeta Hutchinson Date: Tue, 29 Aug 2017 18:54:01 -0700 Subject: [PATCH 3/7] fix typos in clear linux documentation home --- source/clear-linux/clear-linux.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/clear-linux/clear-linux.rst b/source/clear-linux/clear-linux.rst index a1083a19..2c4ffe42 100644 --- a/source/clear-linux/clear-linux.rst +++ b/source/clear-linux/clear-linux.rst @@ -5,13 +5,13 @@ Clear Linux\* Project for Intel® Architecture Welcome to the |CLOSIA| documentation pages. Our documentation is split into five sections: Get started, Concepts, Guides, Tutorials, and Reference. -Under :ref:`Get started`, you can find information about installing |CL| on +Under :ref:`get-started`, you can find information about installing |CL| on bare metal, in a virtual environment, or as a live image on a USB stick. Under -the :ref:`Concepts` section, you can find detailed technical information about -the |CL| features. The :ref:`Guides` section contains step-by-step -instructions to complete common tasks. The :ref:`Tutorials` section contains +the :ref:`concepts` section, you can find detailed technical information about +the |CL| features. The :ref:`guides` section contains step-by-step +instructions to complete common tasks. The :ref:`tutorials` section contains step-by-step instructions to complete the installation and configuration of -tools needed for a specific use case. Lastly, the :ref:`Reference` section +tools needed for a specific use case. Lastly, the :ref:`reference` section contains information providing additional context or details. .. toctree:: @@ -21,4 +21,4 @@ contains information providing additional context or details. concepts/concepts guides/guides tutorials/tutorials - reference/reference \ No newline at end of file + reference/reference From 9de655405f54853150bb1ff763026edda3e54556 Mon Sep 17 00:00:00 2001 From: ihutchin Date: Wed, 30 Aug 2017 09:06:31 -0700 Subject: [PATCH 4/7] Fixes two language issues Signed-off-by: ihutchin --- .../virtual-machine-install/virtual-machine-install.rst | 2 +- source/clear-linux/guides/network/network.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) 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 4dfe9614..ce59a7f1 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 @@ -23,7 +23,7 @@ Next steps: =========== Now that you have read about the |CL| compatible kernels, choose the -appropriate set of step by step instructions to proceed. +appropriate set of step-by-step instructions to proceed. .. toctree:: :maxdepth: 1 diff --git a/source/clear-linux/guides/network/network.rst b/source/clear-linux/guides/network/network.rst index 3b5f0ff8..6b49a1ab 100644 --- a/source/clear-linux/guides/network/network.rst +++ b/source/clear-linux/guides/network/network.rst @@ -4,7 +4,7 @@ Network guide ############# This guide provides step-by-step instructions for common tasks associated with -the configuration and administration of networking for |CLOSIA|. +the configuration, administration, and use of networks in the |CLOSIA|. .. toctree:: :maxdepth: 1 From 8b1b1a59654772517f39d2871a139f1f11b09088 Mon Sep 17 00:00:00 2001 From: Ianeta Hutchinson Date: Wed, 30 Aug 2017 12:11:52 -0700 Subject: [PATCH 5/7] reverting unneccesary changes --- .../virtual-machine-install/hyper-v.rst | 25 ++++++++++++------- 1 file changed, 16 insertions(+), 9 deletions(-) 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 69ac209f..f8da4baa 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 @@ -12,19 +12,26 @@ Please ensure you have enabled `Intel® Virtualization Technology `_ (Intel® VT-d) in your BIOS/UEFI firmware configuration. -Install Hyper-V -================ +Enable Hyper-V +============== -Please refer to the `Microsoft documentation`_ to install and configure +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 +`Create a Virtual Network documentation`_ to create and configure +a virtual network. + Create a virtual machine ======================== #. Download and uncompress the latest hyperv disk image - :file:`clear-XXXX-hyperv.img.gz`, where XXXX is the latest - available version of |CLOSIA| from our `downloads`_ - section. + :file:`clear-XXXXX-hyperv.img.gz`, where XXXXX is the latest + available version of |CLOSIA| from our `downloads`_ section. #. Create a virtual machine using the **Hyper-V Manager**: @@ -47,7 +54,7 @@ Create a virtual machine Your virtual machine running |CLOSIA| is ready! -.. _Windows Server Virtualization: https://www.microsoft.com/en-us/server-cloud/solutions/virtualization.aspx -.. _Microsoft documentation: https://www.microsoft.com/en-us/server-cloud/solutions/virtualization.aspx +.. _Windows Server Virtualization: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/about/ +.. _Microsoft documentation: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v +.. _Create A Virtual Network documentation: https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/connect-to-network .. _downloads: https://download.clearlinux.org/image/ - From 26912ddda13e3f2920d8dae7d0e4763588710575 Mon Sep 17 00:00:00 2001 From: Ianeta Hutchinson Date: Wed, 30 Aug 2017 13:30:57 -0700 Subject: [PATCH 6/7] Improves sentence clarity --- source/clear-linux/concepts/bundles-about.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/clear-linux/concepts/bundles-about.rst b/source/clear-linux/concepts/bundles-about.rst index f1f5645a..4b58311f 100644 --- a/source/clear-linux/concepts/bundles-about.rst +++ b/source/clear-linux/concepts/bundles-about.rst @@ -17,9 +17,9 @@ individually or as a set, using tools such as "yum" and "apt-get." The Clear Linux\* OS for Intel® Architecture takes a slightly different approach. While we also use the concept of packages to manage compiling source code into binaries, we do not use the package concept to deploy -software. Instead, we provide "bundles" that  provide a set of functionality -to the system administrator, independent of how many and which pieces of -the upstream open source projects are needed for this functionality. +software. Instead, we provide "bundles" that provide a set of +functionality to the administrator. A bundle contains as many or as +few open source projects needed to provide a complete functionality. Next steps ========== @@ -28,4 +28,4 @@ To put this concept into practice, see the following resources: * :ref:`available-bundles` * :ref:`bundle-commands` -* :ref:`compatible-kernels` \ No newline at end of file +* :ref:`compatible-kernels` From 8058630a526a1eb8acee85c365a9b64e00daf418 Mon Sep 17 00:00:00 2001 From: Ianeta Hutchinson Date: Thu, 31 Aug 2017 09:30:25 -0700 Subject: [PATCH 7/7] Applies substitution and clarifies sentence --- source/clear-linux/concepts/bundles-about.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/source/clear-linux/concepts/bundles-about.rst b/source/clear-linux/concepts/bundles-about.rst index 4b58311f..f6cccf3b 100644 --- a/source/clear-linux/concepts/bundles-about.rst +++ b/source/clear-linux/concepts/bundles-about.rst @@ -14,12 +14,12 @@ distributions deploy their software. With those kinds of distributions, system administrators can then install and update sub-packages individually or as a set, using tools such as "yum" and "apt-get." -The Clear Linux\* OS for Intel® Architecture takes a slightly different -approach. While we also use the concept of packages to manage compiling -source code into binaries, we do not use the package concept to deploy -software. Instead, we provide "bundles" that provide a set of -functionality to the administrator. A bundle contains as many or as -few open source projects needed to provide a complete functionality. +The |CLOSIA| takes a slightly different approach. While we also use the +concept of packages to manage compiling source code into binaries, we do not +use the package concept to deploy software. Instead, we provide software +"bundles" that are installed and managed using :ref:`swupd`. Each +bundle contains as many or as few open source projects needed to provide a +complete functionality. Next steps ==========