mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-05-14 02:43:43 +00:00
1480 lines
110 KiB
HTML
1480 lines
110 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
||
<title>Structure and formatting — Documentation for Clear Linux* project</title>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="../../_static/js/modernizr.min.js"></script>
|
||
|
||
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||
<script type="text/javascript" src="../../_static/jquery.js"></script>
|
||
<script type="text/javascript" src="../../_static/underscore.js"></script>
|
||
<script type="text/javascript" src="../../_static/doctools.js"></script>
|
||
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
||
|
||
<script type="text/javascript" src="../../_static/js/theme.js"></script>
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||
<link rel="author" title="About these documents" href="../../about.html" />
|
||
<link rel="index" title="Index" href="../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../search.html" />
|
||
<link rel="next" title="Recommended minimum system requirements" href="../system-requirements.html" />
|
||
<link rel="prev" title="Writing guide" href="writing-guide.html" />
|
||
|
||
<link rel="stylesheet" href="../../_static/tcs_theme.css" type="text/css" />
|
||
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
|
||
|
||
<div class="wy-grid-for-nav">
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" style="background: #007ab2" >
|
||
|
||
|
||
|
||
<a href="../../index.html" class="icon icon-home"> Clear Linux* Project Docs
|
||
|
||
|
||
|
||
|
||
<img src="../../_static/clearlinux.png" class="logo" alt="Logo"/>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
||
|
||
|
||
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
|
||
<span class="rst-current-version" data-toggle="rst-current-version">
|
||
<span class="fa fa-book"> Clear Linux</span>
|
||
v: latest
|
||
<span class="fa fa-caret-down"></span>
|
||
</span>
|
||
<div class="rst-other-versions">
|
||
<dl>
|
||
<dt>Language Versions</dt>
|
||
|
||
<dd><a href="/clearlinux/latest/reference/collaboration/structure-formatting.html">English</a></dd>
|
||
|
||
<dd><a href="/clearlinux/latest/zh_CN/reference/collaboration/structure-formatting.html">Chinese</a></dd>
|
||
|
||
</dl>
|
||
<dl>
|
||
<dt>Document Versions</dt>
|
||
|
||
<dd><a href="/clearlinux/latest/reference/collaboration/structure-formatting.html">latest</a></dd>
|
||
|
||
<dd><a href="/clearlinux/L19.01/reference/collaboration/structure-formatting.html">L19.01</a></dd>
|
||
|
||
</dl>
|
||
<dl>
|
||
<dt>clearlinux.org links</dt>
|
||
<dd>
|
||
<a href="https://www.clearlinux.org/">Project Home</a>
|
||
</dd>
|
||
<dd>
|
||
<a href="https://github.com/clearlinux/clear-linux-documentation">GitHub</a>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="../../get-started/get-started.html">Get started</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../get-started/get-started.html#pre-install">Pre-install</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/compatibility-check.html">Check processor and EFI firmware compatibility</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/compatibility-check.html#check-compatibility">Check compatibility</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/bootable-usb/bootable-usb.html">Create a bootable USB drive</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bootable-usb/bootable-usb.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bootable-usb/bootable-usb.html#create-a-bootable-usb-drive-on-linux">Create a bootable USB drive on Linux*</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bootable-usb/bootable-usb.html#create-a-bootable-usb-drive-on-macos">Create a bootable USB drive on macOS*</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bootable-usb/bootable-usb.html#create-a-bootable-usb-drive-on-windows">Create a bootable USB drive on Windows*</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../get-started/get-started.html#install">Install</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html">Install Clear Linux* OS from the live desktop</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#system-requirements">System requirements</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#preliminary-steps">Preliminary steps</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#install-from-live-image">Install from live image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#minimum-installation-requirements">Minimum installation requirements</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#cl-desktop-installer">Clear Linux OS Desktop Installer</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#navigation">Navigation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#required-options">Required options</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#advanced-options">Advanced options</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-desktop/bare-metal-install-desktop.html#finish-installation">Finish installation</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html">Install Clear Linux* OS on bare metal with live server</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#system-requirements">System requirements</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#download-the-latest-cl-live-server-image">Download the latest Clear Linux OS live server image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#install-cl-on-your-target-system">Install Clear Linux OS on your target system</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#launch-the-cl-installer">Launch the Clear Linux OS Installer</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#minimum-installation-requirements">Minimum installation requirements</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#main-menu">Main Menu</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#navigation">Navigation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#required-options">Required options</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#recommended-options">Recommended options</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#advanced-options">Advanced options</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#finish-installation">Finish installation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/bare-metal-install-server/bare-metal-install-server.html#troubleshooting">Troubleshooting</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/install-configfile.html">Install using clr-installer and a configuration file</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/install-configfile.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/install-configfile.html#process">Process</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/install-configfile.html#references">References</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../get-started/get-started.html#install-in-a-virtual-machine">Install in a virtual machine</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/virtual-machine-install/gce.html">Launch Clear Linux* OS Compute Engine on Google Cloud Platform*</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/gce.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/gce.html#setup-cl-vm-on-gcp">Setup Clear Linux OS VM on GCP</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/gce.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/virtual-machine-install/hyper-v.html">Use Hyper-V*</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/hyper-v.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/hyper-v.html#enable-hyper-v">Enable Hyper-V</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/hyper-v.html#create-a-virtual-network">Create a virtual network</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/hyper-v.html#create-a-virtual-machine">Create a virtual machine</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/virtual-machine-install/kvm.html">Run Clear Linux* OS as a KVM guest OS</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/kvm.html#install-qemu-kvm">Install QEMU-KVM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/kvm.html#download-and-launch-the-virtual-machine">Download and launch the virtual machine</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/kvm.html#ssh-access-into-the-virtual-machine">SSH access into the virtual machine</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/kvm.html#optional-add-the-gnome-display-manager-gdm">Optional: Add the GNOME Display Manager (GDM)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/virtual-machine-install/virtualbox-cl-installer.html">Install a Clear Linux* OS VM in VirtualBox*</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/virtualbox-cl-installer.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/virtualbox-cl-installer.html#download-and-extract-the-cl-installer-iso">Download and extract the Clear Linux OS installer ISO</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/virtualbox-cl-installer.html#create-a-new-vb-virtual-machine">Create a new VirtualBox virtual machine</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/virtualbox-cl-installer.html#install-cl-on-the-vb-vm">Install Clear Linux OS on the VirtualBox VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/virtualbox-cl-installer.html#troubleshooting">Troubleshooting</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html">Install Clear Linux* OS as a VMware* Workstation Player guest OS</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html#install-the-vmware-workstation-player-hypervisor">Install the VMware Workstation Player hypervisor</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html#download-the-latest-cl-installer">Download the latest Clear Linux OS installer</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html#create-and-configure-a-new-vm">Create and configure a new VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html#install-cl-into-the-new-vm">Install Clear Linux OS into the new VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html#detach-the-cl-installer-iso-from-the-vm">Detach the Clear Linux OS installer ISO from the VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html#enable-uefi-boot-support">Enable UEFI boot support</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html">Run pre-configured Clear Linux* OS image as a VMware* Workstation Player guest OS</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#install-the-vmware-workstation-player-hypervisor">Install the VMware Workstation Player hypervisor</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#download-the-latest-cl-vmware-image">Download the latest Clear Linux OS VMware image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#image-types">Image types</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#create-and-configure-a-new-vm">Create and configure a new VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#attach-the-pre-configured-cl-vmware-image">Attach the pre-configured Clear Linux OS VMware image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#enable-uefi-boot-support">Enable UEFI boot support</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#power-on-the-vm">Power on the VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmw-player-preconf.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html">Install Clear Linux* OS as a VMware* ESXi guest OS</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html#download-the-latest-cl-installer-iso">Download the latest Clear Linux OS installer ISO</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html#upload-the-cl-installer-iso-to-the-vmware-server">Upload the Clear Linux OS installer ISO to the VMware server</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html#create-and-configure-a-new-vm">Create and configure a new VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html#install-cl-into-the-new-vm">Install Clear Linux OS into the new VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html#reconfigure-the-vm-s-settings-to-boot-the-newly-installed-cl">Reconfigure the VM’s settings to boot the newly-installed Clear Linux OS</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html#power-on-the-vm-and-boot-cl">Power on the VM and boot Clear Linux OS</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-install-cl.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.html">Run preconfigured Clear Linux* OS image as a VMware* ESXi guest OS</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.html#download-the-latest-cl-vmware-image">Download the latest Clear Linux OS VMware image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.html#upload-the-cl-image-to-the-vmware-server">Upload the Clear Linux OS image to the VMware server</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.html#convert-the-cl-image-to-an-esxi-supported-format">Convert the Clear Linux OS image to an ESXi-supported format</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.html#create-and-configure-a-new-vm">Create and configure a new VM</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.html#power-on-the-vm-and-boot-cl">Power on the VM and boot Clear Linux OS</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/increase-virtual-disk-size.html">Increase virtual disk size of an image</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/increase-virtual-disk-size.html#determine-the-partition-order-and-sizes-of-the-prebuilt-image">Determine the partition order and sizes of the prebuilt image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/increase-virtual-disk-size.html#id1">Increase virtual disk size</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../about.html">About</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../about.html#training">Training</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../guides/guides.html">Guides</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../guides/guides.html#clear-linux">Clear Linux</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/autoproxy.html">Autoproxy</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/autoproxy.html#description">Description</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/autoproxy.html#how-it-works">How it works</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/autospec.html">autospec</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/autospec.html#description">Description</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/autospec.html#how-it-works">How it works</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/autospec.html#examples">Examples</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/autospec.html#test-packaged-software">Test packaged software</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/autospec.html#references">References</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/autospec.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/compatible-kernels.html">Kernels</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/compatible-kernels.html#bare-metal-only">Bare metal only</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/compatible-kernels.html#also-compatible-with-vms">Also compatible with VMs</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/compatible-kernels.html#vm-only">VM only</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/debug.html">Debug system</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/debug.html#background">Background</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/debug.html#usage">Usage</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/debug.html#implementation">Implementation</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/ister.html">ister.py image builder</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/ister.html#description">Description</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/ister.html#examples">Examples</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/ister.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/mixer.html">mixer</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/mixer.html#description">Description</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/mixer.html#how-it-works">How it works</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/mixer.html#examples">Examples</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/mixer.html#references">References</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/mixer.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/security.html">OS Security</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/security.html#security-in-updates">Security in updates</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/security.html#security-in-software">Security in software</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/security.html#security-in-system-design">Security in system design</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/stateless.html">Stateless</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/stateless.html#file-level-separation">File-level separation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/stateless.html#software-configuration">Software configuration</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/stateless.html#system-reset">System reset</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/stateless.html#additional-information">Additional information</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/swupd-guide.html">swupd</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/swupd-guide.html#description">Description</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/swupd-guide.html#how-it-works">How it works</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/swupd-guide.html#examples">Examples</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/swupd-guide.html#quick-reference">Quick reference</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/swupd-guide.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/telemetrics/telem-guide.html">Telemetrics</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/telemetrics/telem-guide.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/telemetrics/telem-guide.html#how-to-use">How to use</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/telemetrics/telem-guide.html#examples">Examples</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/telemetrics/telem-guide.html#reference">Reference</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../guides/guides.html#maintenance">Maintenance</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/architect-lifecycle.html">Architect the life-cycle of Clear Linux* OS</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/architect-lifecycle.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/architect-lifecycle.html#description">Description</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/architect-lifecycle.html#content-workflow">Content Workflow</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/architect-lifecycle.html#release-workflow">Release Workflow</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/architect-lifecycle.html#implementation">Implementation</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/assign-static-ip.html">Assign a static IP address</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/assign-static-ip.html#identify-which-program-is-managing-the-interface">Identify which program is managing the interface</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/assign-static-ip.html#using-networkmanager">Using NetworkManager</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/assign-static-ip.html#using-systemd-networkd">Using systemd-networkd</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/bulk-provision.html">Bulk provision</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/bulk-provision.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/bulk-provision.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/bulk-provision.html#configuration">Configuration</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/cpu-performance.html">CPU Power and Performance</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/cpu-performance.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/cpu-performance.html#cpu-power-saving-mechanisms">CPU power saving mechanisms</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/cpu-performance.html#linux-cpu-clock-frequency-scaling">Linux CPU clock frequency scaling</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/cpu-performance.html#thermal-management">Thermal management</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/developer-workstation.html">Developer Workstation</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/developer-workstation.html#workstation-setup">Workstation Setup</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/developer-workstation.html#swupd-search">swupd search</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/developer-workstation.html#core-concepts">Core Concepts</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/download-verify-decompress.html">Download, verify, and decompress a Clear Linux* OS image</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/download-verify-decompress.html#linux-os-steps">Linux OS steps</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/download-verify-decompress.html#macos-steps">macOS* steps</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/download-verify-decompress.html#windows-os-steps">Windows* OS steps</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/download-verify-decompress.html#image-types">Image types</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/enable-user-space.html">Create and enable a new user space</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/enable-user-space.html#create-a-new-user">Create a new user</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/enable-user-space.html#add-the-new-user-to-the-wheel-group">Add the new user to the <em>wheel</em> group</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/enable-user-space.html#install-and-update-the-os-software-to-its-current-version">Install and update the OS software to its current version</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/enable-user-space.html#add-a-bundle">Add a bundle</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/enable-user-space.html#next-steps">Next steps</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/fix-broken-install.html">Fix a broken installation</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/fix-broken-install.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/fix-broken-install.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/fix-broken-install.html#boot-a-live-desktop-image-to-fix-target-system">Boot a live desktop image to fix target system</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/fix-broken-install.html#install-from-live-image">Install from live image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/fix-broken-install.html#mount-root-partition-verify-and-fix">Mount root partition, verify, and fix</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/hostname.html">Modify hostname</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/hostname.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/hostname.html#set-your-hostname">Set your hostname</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/hostname.html#view-your-hostname">View your hostname</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/increase-virtual-disk-size.html">Increase virtual disk size of an image</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/increase-virtual-disk-size.html#determine-the-partition-order-and-sizes-of-the-prebuilt-image">Determine the partition order and sizes of the prebuilt image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/increase-virtual-disk-size.html#id1">Increase virtual disk size</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/query-upstream.html">Query package info from upstream repository</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/query-upstream.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/query-upstream.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/query-upstream.html#configure-dnf">Configure DNF</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/query-upstream.html#dnf-command-usage-examples">DNF command usage examples</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/resource-limits.html">Resource limits</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/resource-limits.html#system-wide-limits">System-wide limits</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/resource-limits.html#per-user-limits">Per-user limits</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/resource-limits.html#service-limits">Service limits</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/restart.html">Restart system services after an OS update</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/restart.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/restart.html#how-it-works">How it works</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/restart.html#basic-options">Basic options</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/restart.html#monitor-options">Monitor options</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/restart.html#example">Example</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/restart.html#telemetry">Telemetry</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/restart.html#conclusion">Conclusion</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/time.html">Set the time</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/maintenance/validate-signatures.html">Validate signatures</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/validate-signatures.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/validate-signatures.html#image-content-validation">Image content validation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/maintenance/validate-signatures.html#update-content-validation">Update content validation</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/deploy-at-scale.html">Deploy at Scale</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/deploy-at-scale.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/deploy-at-scale.html#pick-a-usage-and-update-strategy">Pick a usage and update strategy</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/deploy-at-scale.html#pick-an-image-distribution-strategy">Pick an image distribution strategy</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/deploy-at-scale.html#considerations-with-stateless-systems">Considerations with stateless systems</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../guides/guides.html#network">Network</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/network/custom-clear-container.html">Build a custom Clear Linux* OS based Docker container image</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/custom-clear-container.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/custom-clear-container.html#build-the-base-container-image">Build the base container image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/custom-clear-container.html#manage-bundles-in-a-container">Manage bundles in a container</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/network/dpdk.html">Use DPDK to send packets between platforms</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#install-dpdk-and-build-l3fwd-example-platform-b">Install dpdk and build l3fwd example (Platform B)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#build-pktgen-platform-a">Build pktgen (Platform A)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#bind-nics-to-dpdk-kernel-drivers-platforms-a-and-b">Bind NICs to DPDK kernel drivers (Platforms A and B)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#set-hugepages-platforms-a-and-b">Set hugepages (Platforms A and B)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#set-up-the-physical-environment-platforms-a-and-b">Set up the physical environment (Platforms A and B)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#run-l3fwd-application-platform-b">Run l3fwd application (Platform B)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#run-pktgen-application-platform-a">Run pktgen application (Platform A)</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/dpdk.html#appendix-a-use-pass-through-for-virtual-machines">Appendix A: Use pass-through for virtual machines</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/network/ipxe-install.html">Install over the network with iPXE</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/ipxe-install.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/ipxe-install.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/ipxe-install.html#configuration">Configuration</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/network/network-bonding.html">Combine multiple interfaces with network bonding</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/network/vnc.html">Remote-desktop to a host using VNC</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/vnc.html#install-the-vnc-server-and-misc-components-on-your-host">Install the VNC server and misc. components on your host</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/vnc.html#configure-a-vnc-server-start-method-on-your-host">Configure a VNC-server-start method on your host</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/vnc.html#install-a-vnc-viewer-app-and-an-ssh-client-on-your-client-system">Install a VNC viewer app and an SSH client on your client system</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/vnc.html#establish-a-vnc-connection-to-your-host">Establish a VNC connection to your host</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/vnc.html#terminate-a-vnc-connection-to-your-host">Terminate a VNC connection to your host</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/network/vnc.html#encrypt-vnc-traffic-through-an-ssh-tunnel">Encrypt VNC traffic through an SSH tunnel</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../guides/guides.html#kernel">Kernel</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/kernel/kernel-development.html">Kernel development</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-development.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-development.html#request-changes-be-included-with-the-cl-kernel">Request changes be included with the Clear Linux OS kernel</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-development.html#set-up-kernel-development-environment">Set up kernel development environment</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-development.html#customize-the-linux-kernel-source">Customize the Linux kernel source</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-development.html#build-and-install-the-kernel">Build and install the kernel</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-development.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/kernel/kernel-modules.html">Add kernel modules manually</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules.html#description">Description</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules.html#kernel-module-availability">Kernel module availability</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules.html#build-install-and-load-an-out-of-tree-module">Build, install, and load an out-of-tree module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules.html#examples">Examples</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules.html#related-topic">Related topic</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/kernel/kernel-modules-dkms.html">Add kernel modules with DKMS</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules-dkms.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules-dkms.html#description">Description</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules-dkms.html#kernel-module-availability">Kernel module availability</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules-dkms.html#install-dkms">Install DKMS</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules-dkms.html#build-install-and-load-an-out-of-tree-module">Build, install, and load an out-of-tree module</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules-dkms.html#examples">Examples</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/kernel/kernel-modules-dkms.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../guides/guides.html#stacks">Stacks</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/stacks/dars.html">Data Analytics Reference Stack</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dars.html#the-data-analytics-reference-stack-release">The Data Analytics Reference Stack release</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dars.html#using-the-docker-images">Using the Docker images</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dars.html#building-dars-images">Building DARS images</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/stacks/greengrass.html">Enable AWS Greengrass* and OpenVINO™ toolkit</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/greengrass.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/greengrass.html#supported-platforms">Supported platforms</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/greengrass.html#install-the-os-on-the-edge-device">Install the OS on the edge device</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/greengrass.html#configure-aws-greengrass-group">Configure AWS Greengrass group</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/greengrass.html#create-and-package-lambda-function">Create and package Lambda function</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/greengrass.html#configure-lambda-function">Configure Lambda function</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/greengrass.html#deploy-lambda-function">Deploy Lambda function</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/greengrass.html#references">References</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/stacks/dlrs/dlrs.html">Deep Learning Reference Stack</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dlrs/dlrs.html#overview">Overview</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dlrs/dlrs.html#tensorflow-single-and-multi-node-benchmarks">TensorFlow single and multi-node benchmarks</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dlrs/dlrs.html#pytorch-single-and-multi-node-benchmarks">PyTorch single and multi-node benchmarks</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dlrs/dlrs.html#kubeflow-multi-node-benchmarks">Kubeflow multi-node benchmarks</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dlrs/dlrs.html#use-jupyter-notebook">Use Jupyter Notebook</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dlrs/dlrs.html#uninstallation">Uninstallation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/stacks/dlrs/dlrs.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../tutorials/tutorials.html">Tutorials</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/wordpress/wordpress.html">WordPress* on Clear Linux* OS</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/wordpress/web-server-install.html">Set up a LAMP web server on Clear Linux* OS</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/web-server-install.html#install-apache">Install Apache</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/web-server-install.html#change-the-default-configuration-and-data-directory">Change the default configuration and data directory</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/web-server-install.html#install-php">Install PHP</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/web-server-install.html#install-mariadb">Install MariaDB</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/web-server-install.html#install-phpmyadmin">Install phpMyAdmin</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/web-server-install.html#use-phpmyadmin-to-manage-a-database">Use phpMyAdmin to manage a database</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/web-server-install.html#next-steps">Next steps</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/wordpress/wp-install.html">Set up WordPress* on a LAMP web server</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/wp-install.html#before-you-begin">Before you begin</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/wordpress/wp-install.html#create-a-wordpress-server">Create a WordPress server</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/flatpak/flatpak.html">Use Flatpak* to install applications on Clear Linux* OS</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/flatpak/flatpak.html#before-you-begin">Before you begin</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/flatpak/flatpak.html#install-flatpak-on-your-host-system">Install Flatpak on your host system</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/flatpak/flatpak.html#install-and-run-the-libreoffice-flatpak-image">Install and run the LibreOffice Flatpak image</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/flatpak/flatpak.html#launch-libreoffice">Launch LibreOffice</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/machine-learning/machine-learning.html">TensorFlow* machine learning on Clear Linux* OS</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/machine-learning/machine-learning.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/machine-learning/machine-learning.html#set-up-a-jupyter-notebook">Set up a Jupyter notebook</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/machine-learning/machine-learning.html#run-the-jupyter-machine-learning-example-code">Run the Jupyter machine learning example code</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/machine-learning/machine-learning.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/docker/docker.html">Run Docker* on Clear Linux* OS</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/docker/docker.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/docker/docker.html#install-the-containers-basic-bundle">Install the containers-basic bundle</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/docker/docker.html#integration-with-kata-containers-optional">Integration with Kata Containers* (optional)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/docker/docker.html#additional-docker-configuration">Additional Docker configuration</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/docker/docker.html#pulling-and-running-an-image-from-docker-hub">Pulling and running an image from Docker Hub</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/docker/docker.html#creating-a-docker-swarm-cluster">Creating a Docker swarm cluster</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/docker/docker.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/azure.html">Run Clear Linux* OS using Microsoft Azure CLI 2.0</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/azure.html#install-ms-azure-cli-2-0-on-cl">Install MS Azure CLI 2.0 on Clear Linux OS</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/azure.html#log-into-your-microsoft-azure-account">Log into your Microsoft Azure account</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/azure.html#create-a-ms-azure-resource-group">Create a MS Azure resource group</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/azure.html#create-and-log-into-the-cl-virtual-machine">Create and log into the Clear Linux OS virtual machine</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/azure.html#stop-and-deallocate-the-cl-vm-and-resources">Stop and deallocate the Clear Linux OS VM and resources</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/azure.html#next-steps">Next steps</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/hadoop.html">Set up a single node cluster with Hadoop*</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/hadoop.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/hadoop.html#install-apache-hadoop">Install Apache Hadoop</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/hadoop.html#configure-apache-hadoop">Configure Apache Hadoop</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/hadoop.html#configure-your-ssh-key">Configure your SSH key</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/hadoop.html#run-the-hadoop-daemons">Run the Hadoop daemons</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/hadoop.html#run-the-mapreduce-wordcount-example">Run the MapReduce wordcount example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/fmv.html">Use the function multi-version patch generator</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/fmv.html#install-and-configure-a-cl-host-on-bare-metal">Install and configure a Clear Linux OS host on bare metal</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/fmv.html#detect-loop-vectorization-candidates">Detect loop vectorization candidates</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/fmv.html#generate-the-fmv-patch">Generate the FMV patch</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/fmv.html#fft-project-example-using-fftw">FFT project example using FFTW</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/aws-web/aws-web.html">Create and launch Clear Linux* OS from Amazon Web Services</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/aws-web/aws-web.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/aws-web/aws-web.html#locate-select-and-launch-the-cl-basic-ami">Locate, select, and launch the Clear Linux OS Basic AMI</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/aws-web/aws-web.html#connect-to-your-clear-linux-os-basic-instance">Connect to your Clear Linux OS Basic instance</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/aws-web/aws-web.html#update-the-cl-instance">Update the Clear Linux OS instance</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/aws-web/aws-web.html#stop-the-cl-instance">Stop the Clear Linux OS instance</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/smb/smb.html">Enable simple file sharing with a Windows* machine using Samba*</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/smb/smb.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/smb/smb.html#set-up-file-sharing">Set up file sharing</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/smb/smb.html#map-cl-drive-in-windows">Map Clear Linux OS drive in Windows</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/smb/smb-desktop.html">Connect to Windows* shared location from Clear Linux* OS desktop</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/smb/smb-desktop.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/smb/smb-desktop.html#connect-to-windows-shared-location-with-nautilus">Connect to Windows shared location with Nautilus</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/spark.html">Set up a standalone cluster system using Apache* Spark*</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/spark.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/spark.html#install-apache-spark">Install Apache Spark</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/spark.html#configure-apache-spark">Configure Apache Spark</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/spark.html#start-the-master-server-and-a-worker-daemon">Start the master server and a worker daemon</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/spark.html#run-the-spark-wordcount-example">Run the Spark wordcount example</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/kata.html">Install Kata Containers*</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kata.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kata.html#id1">Install Kata Containers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kata.html#run-kata-containers">Run Kata Containers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kata.html#more-information-about-docker">More information about Docker</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/kata.html#troubleshooting">Troubleshooting</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/kata_migration.html">Migrate Clear Containers to Kata Containers*</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kata_migration.html#stop-clear-containers-instances">Stop Clear Containers instances</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kata_migration.html#manually-migrate-customized-configuration-files">Manually migrate customized configuration files</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kata_migration.html#enable-kata-containers-as-default">Enable Kata Containers as default</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kata_migration.html#run-kata-containers">Run Kata Containers</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html">Run Kubernetes*</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#install-kubernetes-and-cri-runtimes">Install Kubernetes and CRI runtimes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#configure-kubernetes">Configure Kubernetes</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#configure-and-run-kubernetes">Configure and run Kubernetes</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#configure-and-run-cri-o-kata-runtime">Configure and run CRI-O + kata-runtime</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#install-pod-network-add-on">Install pod network add-on</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#use-your-cluster">Use your cluster</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#related-topics">Related topics</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#cloud-native-setup-automation-optional">Cloud native setup automation (optional)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#package-configuration-customization-optional">Package configuration customization (optional)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#proxy-configuration-optional">Proxy configuration (optional)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#next-steps">Next steps</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes.html#troubleshooting">Troubleshooting</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes-bp.html">Kubernetes Best Practices on Clear Linux OS</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes-bp.html#use-swupd-to-update-clusters">Use swupd to update clusters</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes-bp.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes-bp.html#update-the-control-plane">Update the control plane</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/kubernetes/kubernetes-bp.html#update-worker-nodes">Update worker nodes</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/yubikey-u2f.html">Enable YubiKey U2F Support</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/yubikey-u2f.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/yubikey-u2f.html#enable-linux-udev-rules-for-yubikey">Enable Linux udev rules for YubiKey</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/yubikey-u2f.html#enable-u2f-in-mozilla-firefox">Enable U2F in Mozilla Firefox</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/yubikey-u2f.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/nvidia.html">Install NVIDIA* Drivers</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/nvidia.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/nvidia.html#install-dkms">Install DKMS</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/nvidia.html#download-and-install-the-nvidia-drivers">Download and install the NVIDIA drivers</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/nvidia.html#download-the-nvidia-drivers-for-linux">Download the NVIDIA drivers for Linux</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/nvidia.html#disable-the-nouveau-driver">Disable the nouveau driver</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/nvidia.html#configure-alternative-software-paths">Configure alternative software paths</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/nvidia.html#install-the-nvidia-drivers">Install the NVIDIA drivers</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/nvidia.html#updating-the-nvidia-drivers">Updating the NVIDIA drivers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/nvidia.html#uninstalling-the-nvidia-drivers">Uninstalling the NVIDIA drivers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/nvidia.html#debugging-installation-of-nvidia-drivers">Debugging installation of NVIDIA drivers</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/nvidia.html#additional-resources">Additional resources</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/redis.html">Run Redis on Clear Linux* OS</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/redis.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/redis.html#install-the-redis-bundle">Install the redis bundle</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/redis.html#start-the-redis-server">Start the redis-server</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/redis.html#example-1-use-the-redis-cli-and-try-commands">Example 1: Use the redis-cli and try commands</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/redis.html#example-2-run-the-cl-redis-docker-image">Example 2: Run the Clear Linux OS redis docker image</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/redis.html#next-steps">Next Steps</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../tutorials/tutorial-proxy.html">Setting up proxy</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/tutorial-proxy.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/tutorial-proxy.html#shells-and-programs-in-a-desktop-session">Shells and programs in a desktop session</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../tutorials/tutorial-proxy.html#terminal">Terminal</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/tutorial-proxy.html#wget">wget</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/tutorial-proxy.html#system-service-docker">System service (Docker)</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../tutorials/tutorial-proxy.html#git-over-ssh">git over ssh</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1 current"><a class="reference internal" href="../reference.html">Reference</a><ul class="current">
|
||
<li class="toctree-l2"><a class="reference internal" href="../compatible-hardware.html">Compatible Hardware</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../bundle-commands.html">Useful bundle commands</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../bundle-commands.html#additional-information">Additional information</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../bundles/bundles.html">Available bundles</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../bundles/bundles.html#bundle-list">Bundle list</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../bundles/openssh-server.html">openssh-server</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../bundles/openssh-server.html#prerequisites">Prerequisites</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../bundles/openssh-server.html#change-default-port">Change default port</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../bundles/openssh-server.html#enable-sftp">Enable SFTP</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../bundles/openssh-server.html#enable-root-login">Enable root login</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../bundles/openssh-server.html#enable-x11-forwarding">Enable X11-forwarding</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2 current"><a class="reference internal" href="collaboration.html">Documentation guidelines</a><ul class="current">
|
||
<li class="toctree-l3 current"><a class="reference internal" href="collaboration.html#contribution-guidelines">Contribution guidelines</a><ul class="current">
|
||
<li class="toctree-l4"><a class="reference internal" href="writing-guide.html">Writing guide: Describes the style we use to keep our documents clear and concise.</a></li>
|
||
<li class="toctree-l4 current"><a class="current reference internal" href="#">Structure and formatting guide: Explains how we organize and format content, using reStructuredText and Sphinx.</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="collaboration.html#how-to-contribute">How to contribute</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="collaboration.html#contribute-via-github">Contribute via GitHub</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="collaboration.html#references">References</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../system-requirements.html">Recommended minimum system requirements</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../system-requirements.html#installer-requirements">Installer requirements</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../system-requirements.html#id1">System requirements</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../system-requirements.html#recommended-configurations">Recommended configurations</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../image-types.html">Clear Linux* OS image types</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../reference.html#clear-linux-concepts">Clear Linux concepts</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../concepts/autospec-about.html">Autospec</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/autospec-about.html#how-autospec-works">How autospec works</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/autospec-about.html#control-files">Control files</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/autospec-about.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../concepts/bundles-about.html">Bundles</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/bundles-about.html#next-steps">Next steps</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../concepts/mixer-about.html">Mixer</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/mixer-about.html#create-a-mix">Create a mix</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/mixer-about.html#related-topics">Related topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../concepts/swupd-about.html">swupd: software updater</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/swupd-about.html#versioning">Versioning</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/swupd-about.html#updating">Updating</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/swupd-about.html#bundles">Bundles</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../concepts/telemetry-about.html">Telemetrics</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/telemetry-about.html#architecture">Architecture</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../concepts/telemetry-about.html#next-steps">Next steps</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/stateless.html">Stateless</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/stateless.html#file-level-separation">File-level separation</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/stateless.html#software-configuration">Software configuration</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/stateless.html#system-reset">System reset</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/stateless.html#additional-information">Additional information</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../guides/clear/security.html">OS Security</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/security.html#security-in-updates">Security in updates</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/security.html#security-in-software">Security in software</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="../../guides/clear/security.html#security-in-system-design">Security in system design</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="../../FAQ/faq.html">FAQ</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../FAQ/faq.html#general">General</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#why-did-you-make-another-distro">Why did you make another distro?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#can-other-distros-copy-cl-improvements">Can other distros copy Clear Linux OS improvements?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#how-often-do-you-update">How often do you update?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#is-telemetry-required">Is telemetry required?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#what-is-the-default-firewall">What is the default firewall?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#where-are-the-files-that-i-usually-see-under-etc-like-fstab">Where are the files that I usually see under /etc like fstab?</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../FAQ/faq.html#software-packages">Software packages</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#how-is-software-installed-and-updated">How is software installed and updated?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#does-cl-use-rpms-like-other-distros">Does Clear Linux OS use RPMs like other distros?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#can-i-install-a-software-package-from-another-os-on-cl">Can I install a software package from another OS on Clear Linux OS?</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="../../FAQ/faq.html#software-availability">Software availability</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#what-software-is-available-on-cl">What software is available on Clear Linux OS?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#is-google-chrome-available">Is Google* Chrome* available?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#is-ffmpeg-available">Is FFmpeg available?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#is-zfs-available">Is ZFS* available?</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="../../FAQ/faq.html#can-you-add-a-driver-that-i-need">Can you add a driver that I need?</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
||
|
||
|
||
<nav class="wy-nav-top" aria-label="top navigation">
|
||
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="../../index.html">Clear Linux* Project Docs</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<div class="wy-nav-content">
|
||
|
||
<header id="header">
|
||
<div class="padding-md--left-right">
|
||
|
||
<div class="header__site_info">
|
||
<div class="header__site_info_name">
|
||
<a href ="https://clearlinux.org"> Clear Linux* Project</a>
|
||
</div>
|
||
</div>
|
||
<nav class="header__menu">
|
||
<ul class="header__menu_list">
|
||
<li class="header__menu_list_item green ">
|
||
<a tabindex='1' href="https://clearlinux.org/about">About</a>
|
||
</li>
|
||
<li class="header__menu_list_item purple ">
|
||
<a tabindex='1' href="https://clearlinux.org/developer">Developer</a>
|
||
</li>
|
||
<li class="header__menu_list_item blue ">
|
||
<a tabindex='1' href="https://clearlinux.org/software">Software</a>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
</header>
|
||
|
||
|
||
|
||
<div class="rst-content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation">
|
||
|
||
<ul class="wy-breadcrumbs">
|
||
|
||
<li><a href="../../index.html">Docs</a> »</li>
|
||
|
||
<li><a href="../reference.html">Reference</a> »</li>
|
||
|
||
<li><a href="collaboration.html">Documentation guidelines</a> »</li>
|
||
|
||
<li>Structure and formatting</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
|
||
<a href="https://github.com/clearlinux/clear-linux-documentation/blob/rtd-theme/source/reference/collaboration/structure-formatting.rst" class="fa fa-github"> Edit on GitHub</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<div class="section" id="structure-and-formatting">
|
||
<span id="structure-formatting"></span><h1>Structure and formatting</h1>
|
||
<p>Content should be organized to support scanning. Consistent organization,
|
||
formatting, and writing style helps readers quickly find what they need and to
|
||
understand the content more effectively. This document describes our
|
||
organization and formatting guidelines.</p>
|
||
<p>Refer to <a class="reference internal" href="writing-guide.html#writing-guide"><span class="std std-ref">Writing guide</span></a> to learn how we keep our documents clear and
|
||
concise.</p>
|
||
<div class="contents local topic" id="contents">
|
||
<ul class="simple">
|
||
<li><a class="reference internal" href="#markup" id="id1">Markup</a></li>
|
||
<li><a class="reference internal" href="#documentation-organization" id="id2">Documentation organization</a></li>
|
||
<li><a class="reference internal" href="#inline-text-formatting" id="id3">Inline text formatting</a></li>
|
||
<li><a class="reference internal" href="#code-blocks-and-examples" id="id4">Code blocks and examples</a></li>
|
||
<li><a class="reference internal" href="#lists-and-instructions" id="id5">Lists and instructions</a></li>
|
||
<li><a class="reference internal" href="#notices" id="id6">Notices</a></li>
|
||
<li><a class="reference internal" href="#links" id="id7">Links</a></li>
|
||
<li><a class="reference internal" href="#images" id="id8">Images</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="markup">
|
||
<h2><a class="toc-backref" href="#id1">Markup</a></h2>
|
||
<p>Our documentation is written in the reStructuredText markup language, using
|
||
Sphinx roles and directives. We use Sphinx to generate the final documentation.
|
||
You can read more about reStructuredText and Sphinx on their respective
|
||
websites:</p>
|
||
<ul class="simple">
|
||
<li><a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">Sphinx documentation</a></li>
|
||
<li><a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html">reStructuredText Primer</a></li>
|
||
</ul>
|
||
<p>You can view the content directly in the .rst markup files, or generate the HTML
|
||
content by installing and building the documentation locally. To run the
|
||
documentation locally, follow the instructions found in the
|
||
<a class="reference external" href="https://github.com/clearlinux/clear-linux-documentation">documentation repository</a> README.</p>
|
||
<div class="section" id="new-pages">
|
||
<h3>New pages</h3>
|
||
<p>There are a few additional steps to consider when adding a new page to the
|
||
documentation. First, identify where your new page should be located within the
|
||
existing <a class="reference internal" href="#documentation-organization">Documentation organization</a>. Second, make sure the new page is picked
|
||
up in the Sphinx build and easily linkable from other content.</p>
|
||
<p>Each page must be included in a <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/quickstart.html?highlight=toctree#defining-document-structure">Sphinx toctree</a> in order to be included in the
|
||
documentation content tree. Typically, pages are added to the section landing
|
||
page toctree.</p>
|
||
<p>For example, the <a class="reference internal" href="collaboration.html#collaboration"><span class="std std-ref">Documentation guidelines</span></a> page toctree looks like:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">toctree</span><span class="p">::</span>
|
||
<span class="nc">:maxdepth:</span> <span class="nf">1</span>
|
||
|
||
writing-guide
|
||
structure-formatting
|
||
</pre></div>
|
||
</div>
|
||
<p>Additionally, each page must include a uniquely named reST label directly before
|
||
the page title, to enable the <a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref">Sphinx ref role</a> for linking to a page.</p>
|
||
<p>For example, this page “Structure and formating” has the label
|
||
<code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">_structure-formatting</span></code>:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_structure-formatting:</span>
|
||
|
||
<span class="gh">Structure and formatting</span>
|
||
<span class="gh">########################</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>This page can then be referenced from other pages in the documentation using the
|
||
<cite>:ref:</cite> role:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="na">:ref:</span><span class="nv">`structure-formatting`</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="documentation-organization">
|
||
<h2><a class="toc-backref" href="#id2">Documentation organization</a></h2>
|
||
<p>The documentation is organized into five general sections:</p>
|
||
<ol class="arabic simple">
|
||
<li><strong>Concepts</strong>: Introduction and overview of Clear Linux OS specific concepts or
|
||
features.</li>
|
||
<li><strong>Get started</strong>: Information about getting started with Clear Linux OS.</li>
|
||
<li><strong>Guides</strong>: Detailed information and instruction on using Clear Linux OS features.</li>
|
||
<li><strong>Tutorials</strong>: Step-by-step instruction for using Clear Linux OS in specific use cases.</li>
|
||
<li><strong>Reference</strong>: Supplementary and reference information for Clear Linux OS.</li>
|
||
</ol>
|
||
<div class="section" id="page-structure">
|
||
<h3>Page structure</h3>
|
||
<p>Each page in the documentation should follow the basic format of:</p>
|
||
<ul class="simple">
|
||
<li>Overview: 1-2 sentences describing what this page shows and why it matters</li>
|
||
<li>Prerequisites: Describe any pre-work necessary to the content (if appropriate)</li>
|
||
<li>Content</li>
|
||
<li>Next steps: List links to next steps (if appropriate)</li>
|
||
<li>Related topics: List links to related content (if appropriate)</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="headings">
|
||
<h3>Headings</h3>
|
||
<p>Use headings to section and organize your content for better readability and
|
||
clarity.</p>
|
||
<ul class="simple">
|
||
<li>All files must have a top level heading, which is the title for the page.</li>
|
||
<li>Up to three additional levels of headings are allowed under the title heading.</li>
|
||
<li>Each heading should be followed by at least one paragraph of content. Avoid
|
||
two or more consecutive headings.</li>
|
||
</ul>
|
||
<p>Refer to the <a class="reference internal" href="writing-guide.html#writing-guide"><span class="std std-ref">Writing guide</span></a> for tips on using headings to create
|
||
<a class="reference internal" href="writing-guide.html#scannable-content"><span class="std std-ref">scannable content</span></a>.</p>
|
||
<p>To mark up headings in the .rst file:</p>
|
||
<ul>
|
||
<li><p class="first">Use hash-tags to underline the file’s main title:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="gh">Main title</span>
|
||
<span class="gh">##########</span>
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p class="first">Use asterisks to underline the file’s first level headings:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="gh">First level heading</span>
|
||
<span class="gh">*******************</span>
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p class="first">Use equal signs to underline the file’s second level of headings:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="gh">Second level heading</span>
|
||
<span class="gh">====================</span>
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p class="first">Use dashes to underline the file’s third level of headings:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="gh">Third level heading</span>
|
||
<span class="gh">-------------------</span>
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="in-page-navigation">
|
||
<h3>In-page navigation</h3>
|
||
<p>If a page has three or more sections, provide quick links to each section. Place
|
||
the quick links after the overview section.</p>
|
||
<p>Use the standard <a class="reference external" href="http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents">reST contents directive</a> with depth: 1 for quick links.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="inline-text-formatting">
|
||
<h2><a class="toc-backref" href="#id3">Inline text formatting</a></h2>
|
||
<p>We use the <a class="reference external" href="https://docs.microsoft.com/en-us/style-guide/welcome/">Microsoft Writing Style Guide</a> as our starting point for text
|
||
formatting. We apply the formatting using reST and Sphinx markup.</p>
|
||
<p>Use our quick reference for the most commonly used inline text elements:</p>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="32%" />
|
||
<col width="39%" />
|
||
<col width="29%" />
|
||
</colgroup>
|
||
<tbody valign="top">
|
||
<tr class="row-odd"><td><strong>Element</strong></td>
|
||
<td><strong>Convention</strong></td>
|
||
<td><strong>reST/Sphinx</strong></td>
|
||
</tr>
|
||
<tr class="row-even"><td>Acronyms</td>
|
||
<td>Define acronym when first used. After
|
||
first use and definition, use the
|
||
acronym only.</td>
|
||
<td><p class="first">Use the <code class="docutils literal notranslate"><span class="pre">:abbr:</span></code> role, in
|
||
the following format:</p>
|
||
<p class="last"><code class="docutils literal notranslate"><span class="pre">:abbr:`Acronym</span> <span class="pre">(Def)`</span></code></p>
|
||
</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Bundle names</td>
|
||
<td>Bold</td>
|
||
<td>Use the <code class="docutils literal notranslate"><span class="pre">:command:</span></code> role.</td>
|
||
</tr>
|
||
<tr class="row-even"><td>Callouts</td>
|
||
<td> </td>
|
||
<td>Use <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">note::</span></code></td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Code/command examples</td>
|
||
<td>Monospace, visually distinct
|
||
from rest of text. Use an
|
||
indented call-out box.</td>
|
||
<td>Use <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">code-block::</span></code>
|
||
with the correct language
|
||
setting.</td>
|
||
</tr>
|
||
<tr class="row-even"><td>Commands</td>
|
||
<td>Bold</td>
|
||
<td>Use the <code class="docutils literal notranslate"><span class="pre">:command:</span></code> role.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Command flags</td>
|
||
<td>Bold</td>
|
||
<td>Use the <code class="docutils literal notranslate"><span class="pre">:command:</span></code> role.</td>
|
||
</tr>
|
||
<tr class="row-even"><td>Console output</td>
|
||
<td>Monospace, visual distinction
|
||
from rest of text. Use an
|
||
indented call-out box.</td>
|
||
<td>Use <code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">code-block::</span></code>
|
||
with console as the
|
||
language setting.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Emphasis</td>
|
||
<td>Italic</td>
|
||
<td><code class="docutils literal notranslate"><span class="pre">*strong*</span></code></td>
|
||
</tr>
|
||
<tr class="row-even"><td>Environment variables</td>
|
||
<td>Use the case format of the
|
||
environment variable.</td>
|
||
<td>Use <code class="docutils literal notranslate"><span class="pre">:envvar:</span></code></td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Example commands with
|
||
optional or replaceable
|
||
parts</td>
|
||
<td><p class="first">Use angle brackets for swapping
|
||
in the specific name,
|
||
e.g. <package-name>.</p>
|
||
<p class="last">Use square brackets for optional
|
||
parts,
|
||
e.g. [–build].</p>
|
||
</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>Example URLs (not linked)</td>
|
||
<td>Plain text</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-odd"><td>File extensions</td>
|
||
<td>Lowercase</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>File names, directories, paths</td>
|
||
<td>Title style capitalization</td>
|
||
<td>Use the <code class="docutils literal notranslate"><span class="pre">:file:</span></code> role.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>GUI labels</td>
|
||
<td> </td>
|
||
<td>Use <code class="docutils literal notranslate"><span class="pre">:guilabel:</span></code></td>
|
||
</tr>
|
||
<tr class="row-even"><td>Inline comments</td>
|
||
<td> </td>
|
||
<td>Use <code class="docutils literal notranslate"><span class="pre">..</span></code></td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Keystrokes</td>
|
||
<td> </td>
|
||
<td>Use <code class="docutils literal notranslate"><span class="pre">:kbd:</span></code></td>
|
||
</tr>
|
||
<tr class="row-even"><td>Local navigation</td>
|
||
<td> </td>
|
||
<td><code class="docutils literal notranslate"><span class="pre">..</span> <span class="pre">contents::</span> <span class="pre">:local:</span></code>
|
||
with a depth of 1</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Menu selection</td>
|
||
<td> </td>
|
||
<td>Use <code class="docutils literal notranslate"><span class="pre">:menuselection:</span></code></td>
|
||
</tr>
|
||
<tr class="row-even"><td>New terms</td>
|
||
<td><p class="first">Italic for first use, normal for all
|
||
subsequent uses.</p>
|
||
<p class="last">If it is used outside of the source
|
||
of definition, link the term.</p>
|
||
</td>
|
||
<td><code class="docutils literal notranslate"><span class="pre">*term*</span></code></td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Product name</td>
|
||
<td>Follow correct trademark and
|
||
attribution guidelines.</td>
|
||
<td> </td>
|
||
</tr>
|
||
<tr class="row-even"><td>Tool names</td>
|
||
<td><p class="first">Correctly capitalized, no quotes,
|
||
bold, or italics as the basic rule.</p>
|
||
<p>If the tool name is the command, like
|
||
most Linux tools, treat it like a
|
||
command.</p>
|
||
<p class="last">If the tool name is lowercase and
|
||
used at the start of a sentence, use
|
||
bold.</p>
|
||
</td>
|
||
<td> </td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div class="section" id="white-space-and-line-length">
|
||
<h3>White space and line length</h3>
|
||
<p>Limit line length to 78 characters. The GitHub web interface forces this
|
||
limitation for readability.</p>
|
||
<p>Remove trailing whitespace from your documents.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="code-blocks-and-examples">
|
||
<h2><a class="toc-backref" href="#id4">Code blocks and examples</a></h2>
|
||
<p>When providing example code or commands use the <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block">Sphinx code-block directive</a>.
|
||
Select the appropriate syntax highlighting for the example command or code.</p>
|
||
<p>For example, if showing console output, use console highlighting:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">code-block</span><span class="p">::</span> console
|
||
</pre></div>
|
||
</div>
|
||
<p>Sphinx provides other ways of <a class="reference external" href="http://www.sphinx-doc.org/en/1.6/markup/code.html">marking up example code</a> if needed.</p>
|
||
</div>
|
||
<div class="section" id="lists-and-instructions">
|
||
<h2><a class="toc-backref" href="#id5">Lists and instructions</a></h2>
|
||
<p>Use a numbered list when the order or priority of the items is important, such
|
||
as step-by-step instructions.</p>
|
||
<p>Use a bulleted list when the order of the items is not important.</p>
|
||
<p>For both list types, keep all items in the list parallel. See
|
||
<a class="reference internal" href="writing-guide.html#parallelism"><span class="std std-ref">Parallelism</span></a>.</p>
|
||
<p>Use standard <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks">reST list markup</a>.</p>
|
||
<div class="section" id="numbered-lists">
|
||
<h3>Numbered lists</h3>
|
||
<p>Numbered lists are most frequently used for procedures. Use numbered lists to
|
||
show sequence for the items. Follow our guidelines for numbered lists:</p>
|
||
<ul class="simple">
|
||
<li>Make sure the list is sequential and not just a collection of items.</li>
|
||
<li>Introduce a numbered list with a sentence. End the setup text with a
|
||
colon. Example: “To configure the unit, perform the following steps:”</li>
|
||
<li>Each item in the list should be parallel.</li>
|
||
<li>Treat numbered list items as full sentences with correct ending
|
||
punctuation.</li>
|
||
<li>You may interrupt numbered lists with other content, if relevant,
|
||
e.g. explanatory text, commands, or code.</li>
|
||
<li>Second-level steps are acceptable; avoid third-level steps.</li>
|
||
<li>Avoid single-step procedures; the minimum number of steps in a procedure
|
||
is two.</li>
|
||
<li>Do not create numbered lists that emulate flowcharts. The reader should be
|
||
able to execute the list of steps from first to last without branching or
|
||
looping.</li>
|
||
<li>Avoid over-using numbered lists, except in procedural documents such as
|
||
tutorials and step-by-step guides.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="bulleted-lists">
|
||
<h3>Bulleted lists</h3>
|
||
<p>Use bulleted lists to reduce wordiness and paragraph density, especially when
|
||
a sequence is not required. Here are some guidelines for bulleted lists:</p>
|
||
<ul class="simple">
|
||
<li>Introduce a bulleted list with a sentence. End the setup text with a
|
||
colon. Example: “To repair the unit, you will need the following items:”</li>
|
||
<li>Each item in the list should be parallel.</li>
|
||
<li>Avoid interrupting bulleted lists with other paragraph styles.</li>
|
||
<li>Second-level bullets are acceptable; avoid third-level bullets.</li>
|
||
</ul>
|
||
<p>Use the correct ending punctuation for sentence style bullet lists. For example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">When</span> <span class="n">setting</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span><span class="p">,</span> <span class="n">remember</span><span class="p">:</span>
|
||
|
||
<span class="o">*</span> <span class="n">Use</span> <span class="n">a</span> <span class="n">number</span> <span class="n">that</span> <span class="n">has</span> <span class="n">a</span> <span class="n">meaning</span> <span class="k">for</span> <span class="n">you</span><span class="o">.</span>
|
||
<span class="o">*</span> <span class="n">Change</span> <span class="n">the</span> <span class="n">code</span> <span class="n">once</span> <span class="n">a</span> <span class="n">month</span><span class="o">.</span>
|
||
<span class="o">*</span> <span class="n">Do</span> <span class="ow">not</span> <span class="n">disclose</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span> <span class="n">to</span> <span class="n">anyone</span><span class="p">,</span> <span class="n">including</span> <span class="n">the</span> <span class="n">security</span> <span class="n">company</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Not this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">When</span> <span class="n">setting</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span> <span class="n">remember</span><span class="p">:</span>
|
||
|
||
<span class="o">*</span> <span class="n">make</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span> <span class="n">easy</span> <span class="n">to</span> <span class="n">remember</span><span class="o">.</span> <span class="n">Use</span> <span class="n">a</span> <span class="n">number</span> <span class="n">that</span> <span class="n">has</span> <span class="n">a</span> <span class="n">meaning</span> <span class="k">for</span> <span class="n">you</span>
|
||
<span class="o">*</span> <span class="n">change</span> <span class="n">the</span> <span class="n">code</span> <span class="n">once</span> <span class="n">a</span> <span class="n">month</span>
|
||
<span class="o">*</span> <span class="n">do</span> <span class="ow">not</span> <span class="n">disclose</span> <span class="n">the</span> <span class="n">user</span> <span class="n">code</span> <span class="n">to</span> <span class="n">anyone</span> <span class="k">else</span><span class="o">.</span> <span class="n">This</span> <span class="n">includes</span> <span class="n">the</span> <span class="n">security</span>
|
||
<span class="n">company</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="instructions">
|
||
<h3>Instructions</h3>
|
||
<p>When presenting instructions, such as in a tutorial, present them in a numbered
|
||
list according to these guidelines:</p>
|
||
<ul>
|
||
<li><p class="first">Each step (list item) should describe one action.</p>
|
||
</li>
|
||
<li><p class="first">If the same steps are repeated, refer to the earlier steps rather than
|
||
repeating them.</p>
|
||
</li>
|
||
<li><p class="first">When a step includes a command or code block as an example, put the command
|
||
or code block after the step that includes them.</p>
|
||
</li>
|
||
<li><p class="first">Use supporting images where appropriate. If the series of steps is supported
|
||
by one figure, refer to the figure in the introductory text.</p>
|
||
<p>For example: “See Figure 15 and do the following:”</p>
|
||
<p>When a series of steps is supported by two or more figures, refer to the
|
||
specific figure in the relevant step and show the figure immediately after
|
||
the reference. <strong>Do not write</strong>: “See figures 15 through 22 and do the
|
||
following:”</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="notices">
|
||
<h2><a class="toc-backref" href="#id6">Notices</a></h2>
|
||
<p>We use four special types of notices: notes, cautions, warnings, and dangers.
|
||
Here are some specific rules and tips regarding use of these notices:</p>
|
||
<ul class="simple">
|
||
<li>Do not use a notice directly after a heading. Notices must follow a variant of
|
||
body text.</li>
|
||
<li>Do not include more than one notice in a single notice block.</li>
|
||
<li>Avoid back-to-back notices.</li>
|
||
<li>If back-to-back notices are not avoidable, make sure each distinct notice in
|
||
the notice block is clearly defined.</li>
|
||
</ul>
|
||
<p>Use the standard <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives">reST admonition directive</a>.</p>
|
||
<div class="section" id="notes-cautions-and-warnings">
|
||
<h3>Notes, cautions, and warnings</h3>
|
||
<p>Use notes sparingly. Avoid having more than one note per section. If you exceed
|
||
this number consistently, consider rewriting the notes as main body text.</p>
|
||
<p>Use cautions and warnings to alert readers of potential problems or pitfalls.
|
||
Use conditional phrases in cautions and warnings, such as “If you do X, then Y
|
||
will occur.”</p>
|
||
<p>These are examples of typical notices and the conditions for their usage:</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Notes are extra bits of information that supplement the main content. Notes
|
||
should be relatively short.</p>
|
||
</div>
|
||
<div class="admonition caution">
|
||
<p class="first admonition-title">Caution</p>
|
||
<p class="last">Cautions are low-level hazard messages that alert the user of possible
|
||
equipment, product, and software damage, including loss of data.</p>
|
||
</div>
|
||
<div class="admonition warning">
|
||
<p class="first admonition-title">Warning</p>
|
||
<p class="last">Warnings are mid-level hazards that are likely to cause product damage.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="links">
|
||
<h2><a class="toc-backref" href="#id7">Links</a></h2>
|
||
<p>Use the standard <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks">reST markup for links</a>.</p>
|
||
<p>To add a cross-reference to another documentation page, use the <cite>:ref:</cite> role:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="na">:ref:</span><span class="nv">`structure-formatting`</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>To add an external link, we use named references that refer to a defined
|
||
link/label at the bottom of the page.</p>
|
||
<p>For example, an external link is defined at the bottom of the page like this:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="nt">_wiki about dogs:</span> https://en.wikipedia.org/wiki/Dog
|
||
</pre></div>
|
||
</div>
|
||
<p>The defined link is then used in the content like this:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span>Check out the great <span class="s">`wiki about dogs`_</span>.
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="images">
|
||
<h2><a class="toc-backref" href="#id8">Images</a></h2>
|
||
<p>Use images or figures to convey information that may be difficult to explain
|
||
using words alone. Well-planned graphics reduce the amount of text required to
|
||
explain a topic or example.</p>
|
||
<p>Follow these guidelines when using graphics in support of your documentation:</p>
|
||
<ul>
|
||
<li><p class="first">Keep it simple. Use images that serve a specific purpose in your document,
|
||
and contain only the information the reader needs.</p>
|
||
</li>
|
||
<li><p class="first">Avoid graphics that will need frequent updating. Don’t include information in
|
||
a graphic that might change with each release, such as product versions.</p>
|
||
</li>
|
||
<li><p class="first">Use either PNG or JPEG bitmap files for screenshots and SVG files for vector
|
||
graphics.</p>
|
||
</li>
|
||
<li><p class="first">Place the image immediately after the text it helps clarify, or as close as
|
||
possible.</p>
|
||
</li>
|
||
<li><p class="first">Use the <a class="reference external" href="http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#directives">Sphinx figure directive</a> to insert images and figures into the
|
||
document. Include both alt text, a figure name, and caption.</p>
|
||
<p>For example:</p>
|
||
<div class="highlight-rest notranslate"><div class="highlight"><pre><span></span><span class="p">..</span> <span class="ow">figure</span><span class="p">::</span> figures/topic-1.png
|
||
<span class="nc">:alt:</span> <span class="nf">An image supporting the topic.</span>
|
||
|
||
Figure 1: This is the figure 1 caption.
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p class="first">Include at least one direct reference to an image from the main text, using
|
||
the figure number. For example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Figure</span> <span class="mi">1</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Not this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">The</span> <span class="n">figure</span> <span class="n">above</span> <span class="ow">or</span> <span class="n">below</span>
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
<p>Images should follow these naming and location conventions:</p>
|
||
<ul class="simple">
|
||
<li>Save the image files in a <code class="file docutils literal notranslate"><span class="pre">figures</span></code> folder at the same level as the file
|
||
that will reference the image.</li>
|
||
<li>Name image files according to the following rules:<ul>
|
||
<li>Use only lower case letters.</li>
|
||
<li>Separate multiple words in filenames using dashes.</li>
|
||
<li>Name images using the filename of the file they appear on and add a number
|
||
to indicate their place in the file. For example, the third figure added to
|
||
the <code class="file docutils literal notranslate"><span class="pre">welcome.rst</span></code> file must be named <code class="file docutils literal notranslate"><span class="pre">welcome-3.png</span></code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="../system-requirements.html" class="btn btn-neutral float-right" title="Recommended minimum system requirements" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="writing-guide.html" class="btn btn-neutral float-left" title="Writing guide" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
||
|
||
</div>
|
||
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>
|
||
© Copyright 2019, many
|
||
<span class="lastupdated">
|
||
Last updated on Jul 29, 2019.
|
||
</span>
|
||
|
||
</p>
|
||
</div>
|
||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
</footer>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</section>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="../../_static/tcs_theme.js"></script>
|
||
|
||
|
||
|
||
</body>
|
||
</html> |