Update and reorganize documentation

- Convert "Common Tasks" to "How-to Guides"
  (QubesOS/qubes-issues#6694)
- Make title capitalization consistent across docs
- Fix leftover h1 headings
- Reorganize various pages and topics
- Update permalinks to better match titles
- Create redirects for changed permalinks
- Miscellaneous cleanup

QubesOS/qubes-issues#6701
This commit is contained in:
Andrew David Wong 2021-06-17 04:23:57 -07:00
parent 12408884dd
commit 6d81f95cc2
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
73 changed files with 101 additions and 107 deletions

View File

@ -3,5 +3,5 @@ lang: en
layout: doc
permalink: /doc/qubes-template-configs/
redirect_to: https://github.com/QubesOS/qubes-template-configs
title: Qubes template configs
title: Qubes Template Configs
---

View File

@ -7,7 +7,7 @@ redirect_from:
- /doc/QubesLicensing/
- /wiki/QubesLicensing/
ref: 52
title: License
title: Software License
---

View File

@ -3,7 +3,7 @@ lang: en
layout: doc
permalink: /doc/mount-lvm-image/
ref: 46
title: Mount LVM image
title: How to Mount LVM Images
---

View File

@ -7,7 +7,7 @@ redirect_from:
- /doc/Profiling/
- /wiki/Profiling/
ref: 48
title: Profiling
title: Python Profiling
---

View File

@ -7,7 +7,7 @@ redirect_from:
- /doc/TestBench/
- /wiki/TestBench/
ref: 44
title: Test Bench
title: How to Set Up a Test Bench
---

View File

@ -8,7 +8,7 @@ redirect_from:
- /doc/DVMimpl/
- /wiki/DVMimpl/
ref: 34
title: DisposableVM implementation
title: DisposableVM Implementation
---
**Note: The content below applies to Qubes R3.2.**

View File

@ -7,10 +7,9 @@ redirect_from:
- /doc/Qfilecopy/
- /wiki/Qfilecopy/
ref: 35
title: Qfilecopy
title: Inter-VM File Copying (qfilecopy)
---
There are two cases when we need a mechanism to copy files between VMs:
- "regular" file copy - when user instructs file manager to copy a given files/directories to a different VM

View File

@ -7,7 +7,7 @@ redirect_from:
- /doc/Qfileexchgd/
- /wiki/Qfileexchgd/
ref: 40
title: Qfileexchgd
title: qfileexchgd (deprecated)
---
**This mechanism is obsolete as of Qubes Beta 1!**

View File

@ -7,10 +7,9 @@ redirect_from:
- /doc/Qmemman/
- /wiki/Qmemman/
ref: 41
title: Qmemman
title: Qubes Memory Manager (qmemman)
---
Rationale
---------

View File

@ -8,7 +8,7 @@ redirect_from:
- /doc/Qrexec3Implementation/
- /wiki/Qrexec3Implementation/
ref: 39
title: 'Qrexec: Qubes RPC internals'
title: 'Qrexec: Qubes RPC Internals'
---

View File

@ -3,7 +3,7 @@ lang: en
layout: doc
permalink: /doc/qrexec-socket-services/
ref: 42
title: 'Qrexec: Socket-based services'
title: 'Qrexec: Socket-based Services'
---

View File

@ -11,7 +11,7 @@ redirect_from:
- /doc/Qrexec/
- /wiki/Qrexec/
ref: 37
title: 'Qrexec: secure communication across domains'
title: 'Qrexec: Secure Communication Across Domains'
---
(*This page is about qrexec v3. For qrexec v2, see [here](/doc/qrexec2/).*)

View File

@ -8,11 +8,10 @@ redirect_from:
- /doc/Qrexec2Implementation/
- /wiki/Qrexec2Implementation/
ref: 38
title: Qrexec2
title: qrexec v2 (deprecated)
---
(*This page is about qrexec v2. For qrexec v3, see [here](/doc/qrexec3/).*)
(*This page is about qrexec v2. For qrexec v3, see [here](/doc/qrexec/).*)
Qubes **qrexec** is a framework for implementing inter-VM (incl. Dom0-VM)
services. It offers a mechanism to start programs in VMs, redirect their

View File

@ -8,10 +8,9 @@ redirect_from:
- /doc/GUIdocs/
- /wiki/GUIdocs/
ref: 61
title: GUI
title: GUI Virtualization
---
qubes_gui and qubes_guid processes
------------------------------------

View File

@ -9,7 +9,7 @@ redirect_from:
- /doc/SecurityGoals/
- /wiki/SecurityGoals/
ref: 210
title: Security design goals
title: Security Design Goals
---

View File

@ -7,10 +7,9 @@ redirect_from:
- /doc/ContributingHowto/
- /wiki/ContributingHowto/
ref: 125
title: Contributing to the Qubes OS Project
title: How to Contribute
---
Thank you for your interest in contributing to Qubes! Here are some of the many
ways in which you can help:

View File

@ -12,7 +12,7 @@ redirect_from:
- /bug-report/
- /bug-reports/
ref: 121
title: Reporting bugs and other issues
title: Reporting Bugs and Other Issues
---
All issues pertaining to the Qubes OS Project (including auxiliary infrastructure such as the [website](/)) are tracked in [qubes-issues](https://github.com/QubesOS/qubes-issues/issues), our GitHub issue tracker.

View File

@ -15,8 +15,6 @@ ref: 122
title: Help, Support, Mailing Lists, and Forum
---
# Help, Support, Mailing Lists, and Forum
Help and support for Qubes OS is available from the [documentation](/doc/), the
[mailing lists](#mailing-lists), and our [forum](#forum) which are explained below. The Qubes OS
Project does not offer paid support services.

View File

@ -13,11 +13,9 @@ redirect_from:
- /wiki/SecurityPage/
- /trac/wiki/SecurityPage/
ref: 217
title: Security Center
title: Qubes OS Project Security Center
---
# Qubes OS Project Security Center
This page provides a central hub for topics pertaining to the security of the Qubes OS Project.
For topics pertaining to software security *within* Qubes OS, see [Security in Qubes](/doc/#security-in-qubes).
The following is a list of important project security pages:

View File

@ -5,7 +5,7 @@ permalink: /doc/bind-dirs/
redirect_from:
- /en/doc/bind-dirs/
ref: 186
title: How to make any file in a TemplateBasedVM persistent using bind-dirs
title: How to Make Any File Persistent (bind-dirs)
---

View File

@ -1,20 +1,20 @@
---
lang: en
layout: doc
permalink: /doc/software-update-dom0/
permalink: /doc/how-to-install-software-in-dom0/
redirect_from:
- /doc/software-update-dom0/
- /en/doc/software-update-dom0/
- /doc/SoftwareUpdateDom0/
- /wiki/SoftwareUpdateDom0/
ref: 194
title: Installing and updating software in dom0
title: How to Install Software in Dom0
---
Updating [dom0](/doc/glossary/#dom0) is one of the main steps in [Updating Qubes OS](/doc/updating-qubes-os/).
It is very important to keep dom0 up-to-date with the latest [security](/security/) updates.
We also publish dom0 updates for various non-security bug fixes and enhancements to Qubes components.
In addition, you may wish to update the kernel, drivers, or libraries in dom0 when [troubleshooting newer hardware](/doc/newer-hardware-troubleshooting/).
<div class="alert alert-danger" role="alert">
<i class="fa fa-exclamation-triangle"></i>
<b>Warning:</b> Installing software in dom0 is for advanced users only. Doing so has the potential to compromise your entire Qubes OS installation. Exercise extreme caution.
</div>
## Security

View File

@ -3,7 +3,7 @@ lang: en
layout: doc
permalink: /doc/installing-contributed-packages/
ref: 225
title: Installing contributed packages
title: Installing Contributed Packages
---

View File

@ -6,7 +6,7 @@ redirect_from:
- /doc/managing-vm-kernel/
- /en/doc/managing-vm-kernel/
ref: 173
title: Managing VM kernels
title: Managing VM Kernels
---

View File

@ -7,7 +7,7 @@ redirect_from:
- /doc/MountFromOtherOs/
- /wiki/MountFromOtherOs/
ref: 175
title: Mounting and Decrypting Qubes Partitions from Outside Qubes
title: How to Mount a Qubes Partition from Another OS
---

View File

@ -3,7 +3,7 @@ lang: en
layout: doc
permalink: /doc/salt/
ref: 185
title: Salt management stack
title: Salt (management stack)
---

View File

@ -16,11 +16,9 @@ redirect_from:
- /doc/InstallationGuideR3.0rc2/
- /doc/live-usb/
ref: 153
title: Installation guide
title: Installation Guide
---
# Installation guide
Welcome to the Qubes OS installation guide!
This guide will walk you through the process of installing Qubes.
Please read it carefully and thoroughly, as it contains important information for ensuring that your Qubes OS installation is functional and secure.

View File

@ -3,7 +3,7 @@ lang: en
layout: doc
permalink: /doc/testing/
ref: 147
title: Testing new releases and updates
title: Testing New Releases and Updates
---

View File

@ -1,13 +1,14 @@
---
lang: en
layout: doc
permalink: /doc/backup-restore/
permalink: /doc/how-to-back-up-restore-and-migrate/
redirect_from:
- /doc/backup-restore/
- /en/doc/backup-restore/
- /doc/BackupRestore/
- /wiki/BackupRestore/
ref: 199
title: Backup, restoration, and migration
title: How to Back Up, Restore, and Migrate
---

View File

@ -1,13 +1,14 @@
---
lang: en
layout: doc
permalink: /doc/copying-files/
permalink: /doc/how-to-copy-and-move-files/
redirect_from:
- /doc/copying-files/
- /en/doc/copying-files/
- /doc/CopyingFiles/
- /wiki/CopyingFiles/
ref: 191
title: Copying and moving files between qubes
title: How to Copy and Move Files
---

View File

@ -1,13 +1,14 @@
---
lang: en
layout: doc
permalink: /doc/copy-paste/
permalink: /doc/how-to-copy-and-paste-text/
redirect_from:
- /doc/copy-paste/
- /en/doc/copy-paste/
- /doc/CopyPaste/
- /wiki/CopyPaste/
ref: 196
title: Copying and pasting text between qubes
title: How to Copy and Paste Text
---

View File

@ -1,14 +1,15 @@
---
lang: en
layout: doc
permalink: /doc/copy-from-dom0/
permalink: /doc/how-to-copy-from-dom0/
redirect_from:
- /doc/copy-from-dom0/
- /doc/copy-to-dom0/
- /en/doc/copy-to-dom0/
- /doc/CopyToDomZero/
- /wiki/CopyToDomZero/
ref: 198
title: Copying from (and to) dom0
title: How to Copy from Dom0
---

View File

@ -1,13 +1,14 @@
---
lang: en
layout: doc
permalink: /doc/full-screen-mode/
permalink: /doc/how-to-enter-fullscreen-mode/
redirect_from:
- /doc/full-screen-mode/
- /en/doc/full-screen-mode/
- /doc/FullScreenMode/
- /wiki/FullScreenMode/
ref: 205
title: Full Screen Mode
title: How to Enter Fullscreen Mode
---

View File

@ -1,16 +1,17 @@
---
lang: en
layout: doc
permalink: /doc/getting-started/
permalink: /doc/how-to-get-started/
redirect_from:
- /doc/getting-started/
- /getting-started/
- /en/doc/getting-started/
- /doc/GettingStarted/
- /wiki/GettingStarted/
ref: 190
title: How to Get Started
---
After [downloading](/downloads/) and [installing](/doc/installation-guide/) Qubes OS, let's cover some basic concepts.
Introduction

View File

@ -1,20 +1,19 @@
---
lang: en
layout: doc
permalink: /doc/software-update-domu/
permalink: /doc/how-to-install-software/
redirect_from:
- /doc/software-update-domu/
- /doc/software-update-vm/
- /en/doc/software-update-vm/
- /doc/SoftwareUpdateVM/
- /wiki/SoftwareUpdateVM/
ref: 189
title: Installing and updating software in domUs
title: How to Install Software
---
Updating [domUs](/doc/glossary/#domu), especially [TemplateVMs](/doc/templates/) and [StandaloneVMs](/doc/standalone-and-hvm/) are important steps in [Updating Qubes OS](/doc/updating-qubes-os/).
It is very import to keep domUs up-to-date with the latest [security](/security/) updates.
Updating these VMs also allows you to receive various non-security bug fixes and enhancements both from the Qubes OS Project and from your upstream distro maintainer.
This page explains how to install software in TemplateVMs and StandaloneVMs.
Advanced users may also be interested in learning [how to install software in dom0](/doc/how-to-install-software-in-dom0).
## Installing software in TemplateVMs

View File

@ -1,12 +1,13 @@
---
lang: en
layout: doc
permalink: /doc/updating-qubes-os/
permalink: /doc/how-to-update/
redirect_from:
- /doc/updating-qubes-os/
ref: 200
title: Updating Qubes OS
title: How to Update
---
*This page is about updating your system while staying on the same [supported version of Qubes OS](/doc/supported-versions/#qubes-os).
If you're instead looking to upgrade from your current version of Qubes OS to a newer version, see the [Upgrade Guides](/doc/upgrade/).*

View File

@ -1,14 +1,15 @@
---
lang: en
layout: doc
permalink: /doc/block-devices/
permalink: /doc/how-to-use-block-storage-devices/
redirect_from:
- /doc/block-devices/
- /doc/stick-mounting/
- /en/doc/stick-mounting/
- /doc/StickMounting/
- /wiki/StickMounting/
ref: 193
title: Block (Storage) Devices
title: How to Use Block Storage Devices
---

View File

@ -1,14 +1,15 @@
---
lang: en
layout: doc
permalink: /doc/device-handling/
permalink: /doc/how-to-use-devices/
redirect_from:
- /doc/device-handling/
- /doc/external-device-mount-point/
- /en/doc/external-device-mount-point/
- /doc/ExternalDeviceMountPoint/
- /wiki/ExternalDeviceMountPoint/
ref: 188
title: Device Handling
title: How to Use Devices
---

View File

@ -1,14 +1,15 @@
---
lang: en
layout: doc
permalink: /doc/disposablevm/
permalink: /doc/how-to-use-disposablevms/
redirect_from:
- /doc/disposablevm/
- /doc/dispvm/
- /en/doc/dispvm/
- /doc/DisposableVms/
- /wiki/DisposableVMs/
ref: 203
title: DisposableVMs
title: How to Use DisposableVMs
---

View File

@ -1,12 +1,13 @@
---
lang: en
layout: doc
permalink: /doc/optical-discs/
permalink: /doc/how-to-use-optical-discs/
redirect_from:
- /doc/optical-discs/
- /doc/recording-optical-discs/
- /en/doc/recording-optical-discs/
ref: 204
title: Optical Discs
title: How to Use Optical Discs
---

View File

@ -1,14 +1,15 @@
---
lang: en
layout: doc
permalink: /doc/pci-devices/
permalink: /doc/how-to-use-pci-devices/
redirect_from:
- /doc/pci-devices/
- /doc/assigning-devices/
- /en/doc/assigning-devices/
- /doc/AssigningDevices/
- /wiki/AssigningDevices/
ref: 197
title: PCI Devices
title: How to Use PCI Devices
---

View File

@ -1,11 +1,12 @@
---
lang: en
layout: doc
permalink: /doc/usb-devices/
permalink: /doc/how-to-use-usb-devices/
redirect_from:
- /doc/usb-devices/
- /doc/usb/
ref: 195
title: USB Devices
title: How to Use USB Devices
---

View File

@ -10,7 +10,7 @@ redirect_from:
- /doc/tools/3.2/dom0/
- /doc/tools/3.2/domU/
ref: 141
title: Command-Line Tools
title: Command-line Tools
---

View File

@ -8,10 +8,9 @@ redirect_from:
- /doc/QubesFirewall/
- /wiki/QubesFirewall/
ref: 166
title: The Qubes Firewall
title: Firewall
---
Understanding firewalling in Qubes
----------------------------------

View File

@ -16,8 +16,6 @@ ref: 168
title: Split GPG
---
# Qubes Split GPG
Split GPG implements a concept similar to having a smart card with your private GPG keys, except that the role of the "smart card" is played by another Qubes AppVM.
This way one not-so-trusted domain, e.g. the one where Thunderbird is running, can delegate all crypto operations -- such as encryption/decryption and signing -- to another, more trusted, network-isolated domain.
This way the compromise of your domain where Thunderbird or another client app is running -- arguably a not-so-unthinkable scenario -- does not allow the attacker to automatically also steal all your keys.

View File

@ -3,7 +3,7 @@ lang: en
layout: doc
permalink: /doc/u2f-proxy/
ref: 167
title: The Qubes U2F Proxy
title: U2F Proxy
---

View File

@ -1,12 +1,13 @@
---
lang: en
layout: doc
permalink: /doc/yubi-key/
permalink: /doc/yubikey/
redirect_from:
- /doc/yubi-key/
- /en/doc/yubi-key/
- /doc/YubiKey/
ref: 169
title: YubiKey in Qubes
title: YubiKey
---

View File

@ -9,10 +9,9 @@ redirect_from:
- /doc/DebianTemplateUpgrade8/
- /wiki/DebianTemplateUpgrade8/
ref: 133
title: In-place upgrade of Debian TemplateVMs
title: How to Upgrade a Debian Template In-place
---
<div class="alert alert-danger" role="alert">
<i class="fa fa-exclamation-triangle"></i>
<b>Warning:</b> This page is intended for advanced users only. Most users seeking to upgrade should instead <a href="/doc/templates/debian/#installing">install a new Debian TemplateVM</a>. Learn more about the two options <a href="/doc/templates/debian/#upgrading">here</a>.

View File

@ -8,7 +8,7 @@ redirect_from:
- /doc/Templates/Debian/
- /wiki/Templates/Debian/
ref: 134
title: The Debian TemplateVM
title: Debian Templates
---

View File

@ -20,11 +20,9 @@ redirect_from:
- /wiki/FedoraTemplateUpgrade28/
- /doc/template/fedora/upgrade-29-to-30/
ref: 137
title: In-place upgrade of Fedora TemplateVMs
title: How to Upgrade a Fedora Template In-place
---
# Upgrading Fedora TemplateVMs
<div class="alert alert-danger" role="alert">
<i class="fa fa-exclamation-triangle"></i>
<b>Warning:</b> This page is intended for advanced users only. Most users seeking to upgrade should instead <a href="/doc/templates/fedora/#installing">install a new Fedora TemplateVM</a>. Learn more about the two options <a href="/doc/templates/fedora/#upgrading">here</a>.

View File

@ -3,7 +3,7 @@ lang: en
layout: doc
permalink: /doc/templates/fedora/
ref: 136
title: The Fedora TemplateVM
title: Fedora Templates
---

View File

@ -1,11 +1,12 @@
---
lang: en
layout: doc
permalink: /doc/reinstall-template/
permalink: /doc/how-to-reinstall-a-template/
redirect_from:
- /doc/reinstall-template/
- /doc/whonix/reinstall/
ref: 128
title: How to Reinstall a TemplateVM
title: How to Reinstall a Template
---

View File

@ -10,11 +10,9 @@ redirect_from:
- /wiki/Templates/FedoraMinimal/
- /doc/templates/debian-minimal/
ref: 132
title: Minimal TemplateVMs
title: Minimal Templates
---
# Minimal TemplateVMs
The Minimal [TemplateVMs](/doc/templates/) are lightweight versions of their standard TemplateVM counterparts.
They have only the most vital packages installed, including a minimal X and xterm installation.
The sections below contain instructions for using the template and provide some examples for common use cases.

View File

@ -8,7 +8,7 @@ redirect_from:
- /doc/Templates/
- /wiki/Templates/
ref: 131
title: TemplateVMs
title: Templates
---

View File

@ -8,7 +8,7 @@ redirect_from:
- /doc/Templates/Xfce/
- /wiki/Templates/Xfce/
ref: 222
title: Xfce TemplateVMs
title: XFCE Templates
---

View File

@ -8,10 +8,9 @@ redirect_from:
- /doc/ManagingAppVmShortcuts/
- /wiki/ManagingAppVmShortcuts/
ref: 202
title: App menu shortcut troubleshooting
title: App Menu Shortcut Troubleshooting
---
For ease of use Qubes aggregates shortcuts to applications that are installed in AppVMs and shows them in one application menu (aka "app menu" or "start menu") in dom0.
Clicking on such shortcut runs the assigned application in its AppVM.