mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-05-14 02:43:43 +00:00
1440 lines
106 KiB
HTML
1440 lines
106 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>Writing guide — 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="Structure and formatting" href="structure-formatting.html" />
|
||
<link rel="prev" title="Documentation guidelines" href="collaboration.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/writing-guide.html">English</a></dd>
|
||
|
||
<dd><a href="/clearlinux/latest/zh_CN/reference/collaboration/writing-guide.html">Chinese</a></dd>
|
||
|
||
</dl>
|
||
<dl>
|
||
<dt>Document Versions</dt>
|
||
|
||
<dd><a href="/clearlinux/latest/reference/collaboration/writing-guide.html">latest</a></dd>
|
||
|
||
<dd><a href="/clearlinux/L19.01/reference/collaboration/writing-guide.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 current"><a class="current reference internal" href="#">Writing guide: Describes the style we use to keep our documents clear and concise.</a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="structure-formatting.html">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>Writing guide</li>
|
||
|
||
|
||
<li class="wy-breadcrumbs-aside">
|
||
|
||
|
||
|
||
<a href="https://github.com/clearlinux/clear-linux-documentation/blob/rtd-theme/source/reference/collaboration/writing-guide.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="writing-guide">
|
||
<span id="id1"></span><h1>Writing guide</h1>
|
||
<p>We want our documentation to be easy to read and understand. This document
|
||
describes guidelines for writing documentation that is clear, concise,
|
||
confident, and courteous.</p>
|
||
<p>Refer to <a class="reference internal" href="structure-formatting.html#structure-formatting"><span class="std std-ref">Structure and formatting</span></a> for details on organizing content and how
|
||
we use reStructuredText and Sphinx.</p>
|
||
<div class="contents local topic" id="contents">
|
||
<ul class="simple">
|
||
<li><a class="reference internal" href="#use-simple-english" id="id3">Use simple English</a></li>
|
||
<li><a class="reference internal" href="#make-content-scannable" id="id4">Make content scannable</a></li>
|
||
<li><a class="reference internal" href="#use-strong-verbs" id="id5">Use strong verbs</a></li>
|
||
<li><a class="reference internal" href="#avoid-long-noun-phrases" id="id6">Avoid long noun phrases</a></li>
|
||
<li><a class="reference internal" href="#parallelism" id="id7">Parallelism</a></li>
|
||
<li><a class="reference internal" href="#grammar-and-punctuation" id="id8">Grammar and punctuation</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="use-simple-english">
|
||
<h2><a class="toc-backref" href="#id3">Use simple English</a></h2>
|
||
<p>Write using simple English: Be brief and communicate only the information that
|
||
is needed. Be friendly and informative. Emphasize clarity and avoid
|
||
unecessary complicated or technical terms. Make the content accessible to
|
||
non-native speakers.</p>
|
||
<div class="section" id="be-brief">
|
||
<h3>Be brief</h3>
|
||
<p>Use short sentences and paragraphs. Stick to the principle of one main
|
||
idea per sentence, plus one additional point if needed. Each paragraph
|
||
should address one main idea. Remember the basic structure of a paragraph:
|
||
Introduction, body, and conclusion.</p>
|
||
</div>
|
||
<div class="section" id="be-friendly">
|
||
<h3>Be friendly</h3>
|
||
<p>We write for our peers and want to be familiar. Take a personal tone as if you
|
||
were speaking directly to the reader. Use “you” to address the reader and “we”
|
||
to refer to our view. Be professional, respectful, and cooperative.</p>
|
||
<p>Assume your audience has the same level of technical understanding and expertise
|
||
as you did when you first started collaborating. Do not talk down to our
|
||
readers, but also do not assume they know everything about the subject. Offer
|
||
brief explanations or summaries of common knowledge if a significant portion of
|
||
readers might benefit.</p>
|
||
</div>
|
||
<div class="section" id="use-simple-words">
|
||
<h3>Use simple words</h3>
|
||
<p>Use simple words to increase reader comprehension and reduce ambiguity. Follow
|
||
our tips for making good word choices:</p>
|
||
<ul>
|
||
<li><p class="first"><strong>Avoid jargon</strong>: Write for your audience, using everyday language where
|
||
possible, and technical terms where appropriate. Avoid clichés, idioms, and
|
||
metaphors.</p>
|
||
</li>
|
||
<li><p class="first"><strong>Be consistent</strong>: Use one term for each concept or action and use it
|
||
consistently.</p>
|
||
</li>
|
||
<li><p class="first"><strong>Avoid “fancy” words and phrases</strong>: If there is a simpler word or phrase,
|
||
use it.</p>
|
||
<p>For example:</p>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="50%" />
|
||
<col width="50%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Use this</th>
|
||
<th class="head">Not this</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>start, begin</td>
|
||
<td>commence</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>so</td>
|
||
<td>consequently</td>
|
||
</tr>
|
||
<tr class="row-even"><td>more than</td>
|
||
<td>in excess of</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>if</td>
|
||
<td>in the event of</td>
|
||
</tr>
|
||
<tr class="row-even"><td>before</td>
|
||
<td>prior to</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>if you want</td>
|
||
<td>should one wish</td>
|
||
</tr>
|
||
<tr class="row-even"><td>use</td>
|
||
<td>utilize</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>example</td>
|
||
<td>instance</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="avoid-overuse-of-product-name">
|
||
<h3>Avoid overuse of product name</h3>
|
||
<p>Use product names only when necessary. Typically, you can rewrite sentences to
|
||
remove the product name with no change in meaning, which keeps the content
|
||
concise and scannable.</p>
|
||
<p>Avoid using the product name in page titles and headings.</p>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="make-content-scannable">
|
||
<span id="scannable-content"></span><h2><a class="toc-backref" href="#id4">Make content scannable</a></h2>
|
||
<p>Organize your content to make it scannable for the reader, which helps them find
|
||
what they need quickly, and to understand the information more efficiently.</p>
|
||
<ul class="simple">
|
||
<li><strong>Put the most important content first.</strong> Make sure your introduction clearly
|
||
communicates what the reader can find on the page. Present the point of the
|
||
document first, and organize supporting information towards the end of the
|
||
page.</li>
|
||
<li><strong>Write scannable headings.</strong> Expect readers of documentation to skim and scan
|
||
the content, and to leave if they dont find what they need quickly. Good
|
||
headings add organization to your content and help the reader to find and
|
||
understand content more effectively. Follow our guidelines for writing
|
||
effective <a class="reference internal" href="#headings">Headings</a>.</li>
|
||
<li><strong>Write great link text.</strong> Great link text tells the reader what they can
|
||
expect when they click on a link. It also helps make the page more scannable.
|
||
Follow our guidelines for writing <a class="reference internal" href="#link-text">Link text</a>.</li>
|
||
</ul>
|
||
<div class="section" id="headings">
|
||
<h3>Headings</h3>
|
||
<p>Use these guidelines to write effective headings:</p>
|
||
<ul class="simple">
|
||
<li><strong>Be concise and descriptive.</strong> Use only the words necessary to describe the
|
||
section.</li>
|
||
<li><strong>Use sentence case.</strong> Capitalize only the first word and proper nouns in a
|
||
heading.</li>
|
||
<li><strong>Avoid punctuation.</strong> Unless your heading is a question, don’t use sentence
|
||
punctuation in headings.</li>
|
||
<li><strong>Use parallel structure.</strong> Headings at the same level should use the same
|
||
grammatical pattern. This provides structure to the document and helps users
|
||
find information more easily. See <a class="reference internal" href="#parallelism"><span class="std std-ref">Parallelism</span></a>.</li>
|
||
<li><strong>Use strong verbs.</strong> Strong, active verbs get to the point. Avoid -ing verbs,
|
||
such as <em>Running</em>, <em>Testing</em>, etc.</li>
|
||
</ul>
|
||
<p>For example, two headings at the same level:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Install</span> <span class="n">software</span>
|
||
|
||
<span class="n">Configure</span> <span class="n">software</span>
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Not this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Installing</span> <span class="n">the</span> <span class="n">Software</span> <span class="n">on</span> <span class="n">the</span> <span class="n">Platform</span>
|
||
|
||
<span class="n">Software</span> <span class="n">Configuration</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="link-text">
|
||
<h3>Link text</h3>
|
||
<p>All links in content should follow these guidelines:</p>
|
||
<ul class="simple">
|
||
<li><strong>Write descriptive link text</strong>: Link text should describe where the link
|
||
goes, without having to read the surrounding text.</li>
|
||
<li><strong>Keep link text concise</strong>: Use only the words needed to accurately describe
|
||
the destination.</li>
|
||
<li><strong>Use unique link text</strong>: Each link on a page should be unique. If users see
|
||
the same link text twice on a page, they’ll assume it goes to the same place.</li>
|
||
<li><strong>Start link text with keywords</strong>: Frontload the link text with the most
|
||
important words to help users scan the text.</li>
|
||
<li><strong>Avoid generic text</strong>: Don’t use generic, uninformative link text such as
|
||
“click here” or “read more”.</li>
|
||
</ul>
|
||
<p>For example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>For more information about dogs, read the `dog wiki article`_.
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Not this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>For more information about dogs, `click here`_.
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="use-strong-verbs">
|
||
<h2><a class="toc-backref" href="#id5">Use strong verbs</a></h2>
|
||
<p>Passive verbs make writing stuffy and formal. Use strong verbs to get to the
|
||
point and avoid unnecessary words and phrases.</p>
|
||
<div class="section" id="use-imperatives">
|
||
<h3>Use imperatives</h3>
|
||
<p>Commands, also called imperatives, are the fastest and most direct way of giving
|
||
someone instructions. For example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Send</span> <span class="n">it</span> <span class="n">to</span> <span class="n">me</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">I</span> <span class="n">would</span> <span class="n">appreciate</span> <span class="n">it</span> <span class="k">if</span> <span class="n">you</span> <span class="n">would</span> <span class="n">send</span> <span class="n">it</span> <span class="n">to</span> <span class="n">me</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="use-present-tense">
|
||
<h3>Use present tense</h3>
|
||
<p>Use simple present tense instead of future tense for most text. Search for the
|
||
words “will” or “shall” to find future tense instances. Future tense is
|
||
acceptable for conditional statements, such as in a caution or a warning. For
|
||
example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">The</span> <span class="n">system</span> <span class="n">operates</span> <span class="n">at</span> <span class="n">a</span> <span class="n">nominal</span> <span class="n">temperature</span> <span class="n">of</span> <span class="mi">180</span> <span class="n">degrees</span> <span class="n">Fahrenheit</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">The</span> <span class="n">system</span> <span class="n">will</span> <span class="n">operate</span> <span class="n">at</span> <span class="n">a</span> <span class="n">nominal</span> <span class="n">temperature</span> <span class="n">of</span> <span class="mi">180</span> <span class="n">degrees</span> <span class="n">Fahrenheit</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="avoid-nominalizations">
|
||
<h3>Avoid nominalizations</h3>
|
||
<p>Avoid nominalizations, which are nouns formed from verbs.</p>
|
||
<p>For example:</p>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="39%" />
|
||
<col width="61%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Verb</th>
|
||
<th class="head">Nominalization</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td>complete</td>
|
||
<td>completion</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>provide</td>
|
||
<td>provision</td>
|
||
</tr>
|
||
<tr class="row-even"><td>fail</td>
|
||
<td>failure</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>install</td>
|
||
<td>installation</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>For example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">We</span> <span class="n">discussed</span> <span class="n">the</span> <span class="n">matter</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">We</span> <span class="n">had</span> <span class="n">a</span> <span class="n">discussion</span> <span class="n">about</span> <span class="n">the</span> <span class="n">matter</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
<p>Or:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">IT</span> <span class="n">has</span> <span class="n">installed</span> <span class="n">the</span> <span class="n">software</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">IT</span> <span class="n">has</span> <span class="n">completed</span> <span class="n">the</span> <span class="n">installation</span> <span class="n">of</span> <span class="n">the</span> <span class="n">software</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="avoid-words-ending-in-ing">
|
||
<h3>Avoid words ending in -ing</h3>
|
||
<p>Avoid using words ending in -ing unless they are part of a technical name. For
|
||
example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">There</span> <span class="ow">is</span> <span class="n">no</span> <span class="n">way</span> <span class="n">to</span> <span class="n">verify</span> <span class="n">this</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">There</span> <span class="ow">is</span> <span class="n">no</span> <span class="n">way</span> <span class="n">of</span> <span class="n">verifying</span> <span class="n">this</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="use-the-active-voice">
|
||
<h3>Use the active voice</h3>
|
||
<p>Use active voice whenever possible to show who or what is performing an
|
||
action.</p>
|
||
<ul class="simple">
|
||
<li>Active voice follows standard English word order: SUBJECT–VERB–OBJECT
|
||
(where the OBJECT is optional).</li>
|
||
<li>Passive voice reverses the order and weakens the verb: OBJECT–be VERB–by
|
||
SUBJECT (where the OBJECT is optional).</li>
|
||
</ul>
|
||
<p>For example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">I</span> <span class="n">made</span> <span class="n">a</span> <span class="n">mistake</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>A mistake was made. *(By whom?)*
|
||
</pre></div>
|
||
</div>
|
||
<p>Or:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">We</span> <span class="n">released</span> <span class="n">version</span> <span class="mf">2.0</span> <span class="ow">in</span> <span class="n">June</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">Version</span> <span class="mf">2.0</span> <span class="n">was</span> <span class="n">released</span> <span class="ow">in</span> <span class="n">June</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="avoid-long-noun-phrases">
|
||
<h2><a class="toc-backref" href="#id6">Avoid long noun phrases</a></h2>
|
||
<p>Noun phrases (a noun and other words that describe or modify it) can be
|
||
difficult to understand. Try to limit the number of modifiers in a noun phrase
|
||
to two. For example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Integration</span> <span class="n">policies</span> <span class="k">for</span> <span class="n">power</span> <span class="n">management</span> <span class="n">mechanisms</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">Power</span> <span class="n">management</span> <span class="n">mechanism</span> <span class="n">integration</span> <span class="n">policies</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="parallelism">
|
||
<span id="id2"></span><h2><a class="toc-backref" href="#id7">Parallelism</a></h2>
|
||
<p>Parallelism refers to the practice of using similar patterns of grammar, and
|
||
sometimes length, to coordinate words, phrases, and clauses.</p>
|
||
<p>Use parallel construction in lists. The table below shows some unparallel
|
||
structures and how they can be made parallel with a little rewording.</p>
|
||
<table border="1" class="docutils">
|
||
<colgroup>
|
||
<col width="50%" />
|
||
<col width="50%" />
|
||
</colgroup>
|
||
<thead valign="bottom">
|
||
<tr class="row-odd"><th class="head">Parallel (do)</th>
|
||
<th class="head">Unparallel (don’t)</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody valign="top">
|
||
<tr class="row-even"><td><ol class="first last arabic simple">
|
||
<li>Mount the panel.</li>
|
||
<li>Install the battery.</li>
|
||
<li>Wire the keypad.</li>
|
||
</ol>
|
||
</td>
|
||
<td><ol class="first last arabic simple">
|
||
<li>Mount the panel.</li>
|
||
<li>Battery installation.</li>
|
||
<li>Wiring the keypad.</li>
|
||
</ol>
|
||
</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>I like practicing my accordion,
|
||
reading sci-fi, and eating
|
||
peanut butter and pickle
|
||
sandwiches.</td>
|
||
<td>I like practicing my accordion,
|
||
reading sci-fi, and to eat
|
||
peanut butter and pickle
|
||
sandwiches.</td>
|
||
</tr>
|
||
<tr class="row-even"><td>For breakfast he likes coffee
|
||
and bacon.</td>
|
||
<td>For breakfast he likes coffee
|
||
and to fry bacon.</td>
|
||
</tr>
|
||
<tr class="row-odd"><td>Apples or bananas are a good
|
||
snack.</td>
|
||
<td>Apples or a banana are a good
|
||
snack.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="section" id="grammar-and-punctuation">
|
||
<h2><a class="toc-backref" href="#id8">Grammar and punctuation</a></h2>
|
||
<p>This section covers common grammatical topics relevant to our
|
||
documentation. For detailed explanations of correct grammar and punctuation,
|
||
use one of our <a class="reference internal" href="collaboration.html#references"><span class="std std-ref">preferred references</span></a>.</p>
|
||
<div class="section" id="capitalization">
|
||
<h3>Capitalization</h3>
|
||
<p>The capitalization style for all documentation is sentence case. Words should
|
||
only be capitalized when they are proper nouns or refer to trademarked product
|
||
names.</p>
|
||
<div class="admonition note">
|
||
<p class="first admonition-title">Note</p>
|
||
<p class="last">Do not capitalize a word to indicate it is more important than other
|
||
words. Never change the case of variable, function or file names - always
|
||
keep the original case.</p>
|
||
</div>
|
||
<div class="section" id="menu-capitalization">
|
||
<h4>Menu capitalization</h4>
|
||
<p>When referring to software menu items by name, use the same capitalization as
|
||
seen in the actual menu.</p>
|
||
<p>A few other tips when referring to menu items:</p>
|
||
<ul>
|
||
<li><p class="first">Reference the specific menu item using “Select <span class="menuselection">File ‣ New</span>.”</p>
|
||
</li>
|
||
<li><p class="first">Put the option to be selected last. “Select
|
||
<span class="menuselection">View ‣ Side Bar ‣ Hide Side Bar</span>”</p>
|
||
</li>
|
||
<li><p class="first">Do not include more than 3 navigation steps in a menu selection. If
|
||
more than three steps are needed, divide the steps using
|
||
<code class="docutils literal notranslate"><span class="pre">:guilabel:</span></code> or <code class="docutils literal notranslate"><span class="pre">:menuselection:</span></code>.</p>
|
||
<p>For example: “Go to <span class="guilabel">File</span> and select
|
||
<span class="menuselection">Print ‣ Print Preview ‣ Set Up</span>.”</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="software-version-capitalization">
|
||
<h4>Software version capitalization</h4>
|
||
<p>When listing software or hardware version numbers, the word “version” or letter
|
||
“v” are lowercase. The v is closed with the number (no period).</p>
|
||
<p>For example:</p>
|
||
<ul class="simple">
|
||
<li>Widget Pro version 5.0</li>
|
||
<li>Widget Master v2.1.12</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="contractions">
|
||
<h3>Contractions</h3>
|
||
<p>Avoid using contractions, such as it’s, they’re, and you’re, because they may be
|
||
unclear to non-native English-speaking audiences.</p>
|
||
</div>
|
||
<div class="section" id="quotation-marks">
|
||
<h3>Quotation marks</h3>
|
||
<p>Follow these guidelines for quotation marks:</p>
|
||
<ul class="simple">
|
||
<li>Restrict use of quotation marks to terms as terms.</li>
|
||
<li>Do not use quotation marks for emphasis; use <em>italics</em> for emphasis.</li>
|
||
<li>Avoid using single-quote marks.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="commas-and-colons">
|
||
<h3>Commas and colons</h3>
|
||
<p>This section addresses common use of commas, semicolons, and colons in our
|
||
documentation. Refer to one of our <a class="reference internal" href="collaboration.html#references"><span class="std std-ref">preferred references</span></a>
|
||
for further details.</p>
|
||
<div class="section" id="use-the-serial-comma">
|
||
<h4>Use the serial comma</h4>
|
||
<p>When writing a series of items, use the serial comma before the final <em>and</em> and
|
||
<em>or</em> to avoid confusion and ambiguity. For example:</p>
|
||
<p><strong>Use this:</strong></p>
|
||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Mom</span><span class="p">,</span> <span class="n">Dad</span><span class="p">,</span> <span class="ow">and</span> <span class="n">I</span> <span class="n">are</span> <span class="n">going</span> <span class="n">to</span> <span class="n">the</span> <span class="n">game</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">Mom</span><span class="p">,</span> <span class="n">Dad</span> <span class="ow">and</span> <span class="n">I</span> <span class="n">are</span> <span class="n">going</span> <span class="n">to</span> <span class="n">the</span> <span class="n">game</span><span class="o">.</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
<footer>
|
||
|
||
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
||
|
||
<a href="structure-formatting.html" class="btn btn-neutral float-right" title="Structure and formatting" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
||
|
||
|
||
<a href="collaboration.html" class="btn btn-neutral float-left" title="Documentation guidelines" 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> |