Additional proposed fixes to organization for RTD site.

Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
This commit is contained in:
Kevin Putnam
2019-06-07 08:47:45 -07:00
parent 8a07199ef0
commit 7caea349e3
8 changed files with 117 additions and 136 deletions
@@ -251,6 +251,7 @@ th,td {
line-height: 100px;
}
/*Adds a bit of spacing after the last paragraph in a bulleted list*/
.wy-plain-list-disc li p:last-child, .rst-content .section ul li p:last-child, .rst-content .toctree-wrapper ul li p:last-child, article ul li p:last-child {
margin-bottom: 10px;
}
+2 -1
View File
@@ -133,7 +133,8 @@ html_context = {
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'style_nav_header_background': '#8e6db6'
'style_nav_header_background': '#8e6db6',
'navigation_depth': 4
}
# Add any paths that contain custom themes here, relative to this directory.
+23 -3
View File
@@ -10,20 +10,40 @@ from a live desktop or to a virtual machine.
Pre-install
***********
There are a couple of things to take care of before you install.
* :ref:`system-requirements`
* :ref:`compatibility-check`
* :ref:`bootable-usb`
.. toctree::
:maxdepth: 1
:hidden:
compatibility-check
bootable-usb/bootable-usb
Install |CL|
************
Install
*******
.. toctree::
:maxdepth: 1
bare-metal-install-desktop/bare-metal-install-desktop
bare-metal-install-server/bare-metal-install-server
virtual-machine-install/virtual-machine-install
.. _virtual-machine-install:
Install in a virtual machine
****************************
When installing |CL-ATTR| in a VM, consider which kernel to use.
* :ref:`Compatible VM kernels <vm-kernels>`
.. toctree::
:maxdepth: 1
:glob:
virtual-machine-install/*
../../guides/maintenance/increase-virtual-disk-size.rst
@@ -1,38 +0,0 @@
.. _virtual-machine-install:
Install |CL-ATTR| in a virtual machine
######################################
When installing |CL-ATTR| in a VM, consider which kernel to use. This
document walks you through the available kernel options to help this
decision. At the end of this document, select the type of installation most
suitable to your use case.
Compatible kernels
******************
The |CL| provides the following Linux kernels with a respective
:ref:`bundle <bundles-about>` 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
gce
kvm
virtualbox-cl-installer
vmware-esxi-install-cl
vmware-esxi-preconfigured-cl-image
vmw-player
vmw-player-preconf
hyper-v
../../guides/maintenance/increase-virtual-disk-size.rst
-92
View File
@@ -1,92 +0,0 @@
.. _compatible-kernels:
Compatible kernels
##################
The |CL-ATTR| provides the following Linux kernels with a respective bundle.
This document describes the specific use cases these `bundles`_ serve
and provides links to their source code.
Kernel native
=============
The *kernel-native* bundle focuses on the bare metal platforms. It is
optimized for fast booting and performs best on the Intel® architectures
described on the :ref:`supported hardware list<system-requirements>`. 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<system-requirements>`.
The optimization patches are found in our `Linux-Container`_ GitHub repo.
.. _vm-kernels:
Kernel LTS
==========
The *kernel-lts* bundle focuses on the bare metal platforms but uses the
latest :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for fast
booting and performs best on the Intel® architectures described on the
:ref:`supported hardware list<system-requirements>`. Additionally, this
kernel includes the VirtualBox\* kernel modules, see our
:ref:`instructions on using Virtualbox<virtualbox-cl-installer>` for more
information. The optimization patches are found in our `Linux-LTS`_ GitHub
repo.
Kernel KVM
==========
The *kernel-kvm* bundle focuses on the Linux
:abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast booting
and performs best on Virtual Machines running on the Intel® architectures
described on the :ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS on top of *qemu/kvm*. Use
this kernel with **cloud orchestrators** using *qemu/kvm* internally as
their **hypervisor**. This kernel can be used as a standalone |CL| VM, see
our :ref:`instructions on using KVM<kvm>` for more information. The
optimization patches are found in our `Linux-KVM`_ GitHub repo.
Kernel Hyper-V\*
================
The *kernel-hyperv* bundle focuses on running Linux on Microsoft\*
Hyper-V. It is optimized for fast booting and performs best on Virtual
Machines running on the Intel® architectures described on the
:ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
projects such as Microsoft `Azure`_\*. This kernel can be used in a
standalone |CL| VM, see our :ref:`instructions on using Hyper-V<hyper-v>` for
more information. The optimization patches are found in our `Linux-HyperV`_
GitHub repo.
Kernel Hyper-V LTS
==================
The *kernel-hyperv-lts* bundle focuses on running Linux on Microsoft
Hyper-V but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel. It
is optimized for fast booting and performs best on Virtual
Machines running on the Intel® architectures described on the
:ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
projects such as Microsoft `Azure`_. This kernel can be used in a standalone
|CL| VM, see our :ref:`instructions on using Hyper-V<hyper-v>` for
more information. The optimization patches are found in our
`Linux-HyperV-LTS`_ GitHub repo.
.. _Linux: https://github.com/clearlinux-pkgs/linux
.. _Linux-LTS: https://github.com/clearlinux-pkgs/linux-lts
.. _Linux-KVM: https://github.com/clearlinux-pkgs/linux-kvm
.. _Linux-HyperV: https://github.com/clearlinux-pkgs/linux-hyperv
.. _Linux-HyperV-LTS: https://github.com/clearlinux-pkgs/linux-hyperv-lts
.. _Linux-Container: https://github.com/clearlinux-pkgs/linux-container
.. _bundles: https://github.com/clearlinux/clr-bundles
.. _CIAO: https://github.com/01org/ciao
.. _Azure:
https://azuremarketplace.microsoft.com/en-us/marketplace/apps/clear-linux-project.clear-linux-os
-1
View File
@@ -15,7 +15,6 @@ features.
bundles/openssh-server
how-to-clear-overview
collaboration/collaboration
compatible-kernels
system-requirements
image-types
+90
View File
@@ -0,0 +1,90 @@
.. _compatible-kernels:
Kernels
#######
The |CL-ATTR| provides the following Linux kernels with a respective bundle.
This document describes the specific use cases these `bundles`_ serve
and provides links to their source code.
Bare metal only
***************
Kernel native
The *kernel-native* bundle focuses on the bare metal platforms. It is
optimized for fast booting and performs best on the Intel® architectures
described on the :ref:`supported hardware list<system-requirements>`. 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<system-requirements>`.
The optimization patches are found in our `Linux-Container`_ GitHub repo.
.. _vm-kernels:
Also compatible with VMs
************************
Kernel LTS
The *kernel-lts* bundle focuses on the bare metal platforms but uses the
latest :abbr:`LTS (Long Term Support)` Linux kernel. It is optimized for
fast booting and performs best on the Intel® architectures described on the
:ref:`supported hardware list<system-requirements>`. Additionally, this
kernel includes the VirtualBox\* kernel modules, see our
:ref:`instructions on using Virtualbox<virtualbox-cl-installer>` for more
information. The optimization patches are found in our `Linux-LTS`_ GitHub
repo.
VM only
*******
Kernel KVM
The *kernel-kvm* bundle focuses on the Linux
:abbr:`KVM (Kernel-based Virtual Machine)`. It is optimized for fast
booting and performs best on Virtual Machines running on the Intel®
architectures described on the
:ref:`supported hardware list<system-requirements>`. Use this kernel when
running |CL| as the guest OS on top of *qemu/kvm*. Use this kernel with
**cloud orchestrators** using *qemu/kvm* internally as their **hypervisor**
. This kernel can be used as a standalone |CL| VM, see our
:ref:`instructions on using KVM<kvm>` for more information. The
optimization patches are found in our `Linux-KVM`_ GitHub repo.
Kernel Hyper-V\*
The *kernel-hyperv* bundle focuses on running Linux on Microsoft\*
Hyper-V. It is optimized for fast booting and performs best on Virtual
Machines running on the Intel® architectures described on the
:ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
projects such as Microsoft `Azure`_\*. This kernel can be used in a
standalone |CL| VM, see our :ref:`instructions on using Hyper-V<hyper-v>`
for more information. The optimization patches are found in our
`Linux-HyperV`_ GitHub repo.
Kernel Hyper-V LTS
The *kernel-hyperv-lts* bundle focuses on running Linux on Microsoft
Hyper-V but uses the latest :abbr:`LTS (Long Term Support)` Linux kernel.
It is optimized for fast booting and performs best on Virtual
Machines running on the Intel® architectures described on the
:ref:`supported hardware list<system-requirements>`.
Use this kernel when running |CL| as the guest OS of **Cloud Instances** in
projects such as Microsoft `Azure`_. This kernel can be used in a
standalone |CL| VM, see our :ref:`instructions on using Hyper-V<hyper-v>`
for more information. The optimization patches are found in our
`Linux-HyperV-LTS`_ GitHub repo.
.. _Linux: https://github.com/clearlinux-pkgs/linux
.. _Linux-LTS: https://github.com/clearlinux-pkgs/linux-lts
.. _Linux-KVM: https://github.com/clearlinux-pkgs/linux-kvm
.. _Linux-HyperV: https://github.com/clearlinux-pkgs/linux-hyperv
.. _Linux-HyperV-LTS: https://github.com/clearlinux-pkgs/linux-hyperv-lts
.. _Linux-Container: https://github.com/clearlinux-pkgs/linux-container
.. _bundles: https://github.com/clearlinux/clr-bundles
.. _CIAO: https://github.com/01org/ciao
.. _Azure:
https://azuremarketplace.microsoft.com/en-us/marketplace/apps/clear-linux-project.clear-linux-os
+1 -1
View File
@@ -3,7 +3,7 @@
Tooling
#######
Clear Linux is a little different from other distros. Here are some important tools and concept for managing your install.
Clear Linux is a little different from other distros. Here are some important tools and concepts for managing your install.
.. toctree::
:maxdepth: 1