mirror of
https://github.com/QubesOS/qubes-doc.git
synced 2024-12-18 04:04:39 -05:00
Tag for commit 6eea2bf394
-----BEGIN PGP SIGNATURE-----
iQIzBAABCgAdFiEE4R0VxtIENXaf+qRWjOE3NSoBmhcFAmDqGVAACgkQjOE3NSoB
mhcsdg/6A2zT+GvdR0XtnGxyJoI1WDTHrTSt9e0BiVOWorCs1OoL85leR0jvzWgO
hcXeIxiQK7EnG/QKQC1UMY3gSfL+t8bkaGlXVqcNPFdbVIiHqg/w0KuMaA1pq4mQ
slGtcZyQjjWLLm8RiL4KxshnqVZWqokQwOg3GwL72bNvVxOGb5nJAI9VIyq9+C6N
rqE3qUg3CkzVUxjEFh8kNjGGc/SrpWRlXDHr/6+L5BgGKGcXjhy3S480yRNHU5LI
V/xqkFa+QJaA5F0E+2CIX+fuHSQGl8HrupdXltBRT4VYTibLICGAPsiibpETSrNX
f0lPXUfJAQINw9MAWEvypuFhCHc21xwV/KHVymGuUsbLVFsSUDFrAimb9zBxvqRC
MNAnIBcwrvgxBBg2P4XVTLaV6fKe8vGf3fuiV0Rlxpjk/5oq8KKwCc9LeSd1Q+Sq
hHV72j/yOpXe/FJ10eWMJQLoOGUk/aMu8gAhpjSMBzuDV9kmwp3H2eNNrTrU3hxW
UAvSaNTCK+klmNTWfiPKDaQCtJFhrBqglzo/yNo0JUBhpP6azZ41ISU9pd9lamc5
kbBWioRjeb6hQ+aBgU6W2UY+q9S6gyvITpfB+PmjU+HzCUqoxpKKe2epQnnm63Tn
46eceH/DdlFWZcRP0Zi2aMsdyylwRaGVoRASwb90JKRtfVSEd58=
=gYJ6
-----END PGP SIGNATURE-----
gpgsig -----BEGIN PGP SIGNATURE-----
iQGzBAABCAAdFiEE2igx/unaOtbQrvi8nUlmN9gUhKYFAmDrOeAACgkQnUlmN9gU
hKYoCwv/RQXtJxSkEz79FaVQHFb2Jw2MK5Gl1W6mjDbOSHvyPJEHH04ZzQnIQKZX
cYGSTvXoSiqdLwlFi+vGZXqdWPYprOCjDKDz0E+0Mxh4gr6FKY9NNlq335wN1ePg
AEoHI78OzRHhyUBVJuEpS6MAHl45xkxbC6wsBvx+23/rSit5aNopghtiE7Ln/RlO
fxfUUrYbA3sMr8TvxSiMSr6KkjFWZU44s5Gu+PH/N/iTmbYbSXmCvMP6j9V1BwKq
2JDyGXIdqpGztAojiWDNL+b7lV0+Bd1QXh3BnBJ6H9u3TpqNC0nihPeATlV0SJi8
dG1AB87/dv6NiZo4v5MH+yYIHyYNhte8vvPeN3NqoMHr4M9t3p9SviJc9+sVFDwZ
X0eBx1aaZT7PDex2EPX9eHIVgBkzuhuMab9l5+zXDril+g/KOGPHwmk11PeEb3mA
FNuo6HKwxuD0zVzPN0vQmcHG1nIl612sugI9J0bp6ZmaFdlApKa6UP57jE0I8Qg0
Jz8IC2qg
=hQrV
-----END PGP SIGNATURE-----
Merge tag 'adw_6eea2bf3'
Tag for commit 6eea2bf394
# -----BEGIN PGP SIGNATURE-----
#
# iQIzBAABCgAdFiEE4R0VxtIENXaf+qRWjOE3NSoBmhcFAmDqGVAACgkQjOE3NSoB
# mhcsdg/6A2zT+GvdR0XtnGxyJoI1WDTHrTSt9e0BiVOWorCs1OoL85leR0jvzWgO
# hcXeIxiQK7EnG/QKQC1UMY3gSfL+t8bkaGlXVqcNPFdbVIiHqg/w0KuMaA1pq4mQ
# slGtcZyQjjWLLm8RiL4KxshnqVZWqokQwOg3GwL72bNvVxOGb5nJAI9VIyq9+C6N
# rqE3qUg3CkzVUxjEFh8kNjGGc/SrpWRlXDHr/6+L5BgGKGcXjhy3S480yRNHU5LI
# V/xqkFa+QJaA5F0E+2CIX+fuHSQGl8HrupdXltBRT4VYTibLICGAPsiibpETSrNX
# f0lPXUfJAQINw9MAWEvypuFhCHc21xwV/KHVymGuUsbLVFsSUDFrAimb9zBxvqRC
# MNAnIBcwrvgxBBg2P4XVTLaV6fKe8vGf3fuiV0Rlxpjk/5oq8KKwCc9LeSd1Q+Sq
# hHV72j/yOpXe/FJ10eWMJQLoOGUk/aMu8gAhpjSMBzuDV9kmwp3H2eNNrTrU3hxW
# UAvSaNTCK+klmNTWfiPKDaQCtJFhrBqglzo/yNo0JUBhpP6azZ41ISU9pd9lamc5
# kbBWioRjeb6hQ+aBgU6W2UY+q9S6gyvITpfB+PmjU+HzCUqoxpKKe2epQnnm63Tn
# 46eceH/DdlFWZcRP0Zi2aMsdyylwRaGVoRASwb90JKRtfVSEd58=
# =gYJ6
# -----END PGP SIGNATURE-----
# gpg: Signature made 7/10/2021 5:04:00 PM Central Daylight Time
# gpg: using RSA key E11D15C6D20435769FFAA4568CE137352A019A17
# gpg: Can't check signature: No public key
This commit is contained in:
Dave Smith
commit
d4d00ef9d1
@ -1,8 +1,12 @@
|
||||
# Contributing to `qubes-doc`
|
||||
|
||||
Thank you for your interest in contributing to `qubes-doc`, the Qubes OS
|
||||
Project's dedicated documentation repository! Please take a moment to read our
|
||||
[Documentation Guidelines](https://www.qubes-os.org/doc/doc-guidelines/) before
|
||||
you begin writing. These guidelines are important to maintaining high quality
|
||||
documentation, and following them will increase the likelihood that your
|
||||
contribution will be accepted.
|
||||
Project's dedicated documentation repository! Please see [how to edit the
|
||||
documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/) for
|
||||
detailed contribution instructions.
|
||||
|
||||
In addition, please take a moment to read our [documentation style
|
||||
guide](https://www.qubes-os.org/doc/documentation-style-guide/) before
|
||||
contributing. These guidelines are important to maintaining high standards of
|
||||
quality, and following them will increase the likelihood that your contribution
|
||||
will be accepted.
|
||||
|
||||
@ -7,5 +7,5 @@ stored as plain text files in this dedicated repository. By cloning and
|
||||
regularly pulling from this repo, users can maintain their own up-to-date
|
||||
offline copy of all Qubes documentation rather than relying solely on the Web.
|
||||
|
||||
For more information about the documentation, including how to contribute,
|
||||
please see the [Documentation Guidelines](https://www.qubes-os.org/doc/doc-guidelines/).
|
||||
To contribute, please see [how to edit the
|
||||
documentation](https://www.qubes-os.org/doc/how-to-edit-the-documentation/).
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/DevelopmentWorkflow/
|
||||
- /wiki/DevelopmentWorkflow/
|
||||
ref: 66
|
||||
title: Development Workflow
|
||||
title: Development workflow
|
||||
---
|
||||
|
||||
A workflow for developing Qubes OS+
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/QubesBuilderDetails/
|
||||
- /wiki/QubesBuilderDetails/
|
||||
ref: 65
|
||||
title: Qubes Builder Details
|
||||
title: Qubes builder details
|
||||
---
|
||||
|
||||
Components Makefile.builder file
|
||||
@ -50,4 +50,4 @@ Most settings are documented in *builder.conf.default* file, which can be used a
|
||||
Notes
|
||||
-----
|
||||
|
||||
* For a list of custom TemplateVMs available in QubesBuilder look at [Supported Versions page](/doc/supported-versions/).
|
||||
* For a list of custom TemplateVMs available in QubesBuilder look at [Supported Versions page](/doc/supported-releases/).
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/QubesBuilder/
|
||||
- /wiki/QubesBuilder/
|
||||
ref: 64
|
||||
title: Qubes Builder
|
||||
title: Qubes builder
|
||||
---
|
||||
|
||||
**Note: See [ISO building instructions](/doc/qubes-iso-building/) for a streamlined overview on how to use the build system.**
|
||||
|
||||
@ -9,7 +9,7 @@ redirect_from:
|
||||
- /doc/QubesR3Building/
|
||||
- /wiki/QubesR3Building/
|
||||
ref: 63
|
||||
title: Qubes ISO Building
|
||||
title: Qubes ISO building
|
||||
---
|
||||
|
||||
Build Environment
|
||||
|
||||
@ -4,5 +4,5 @@ layout: doc
|
||||
permalink: /doc/qubes-template-configs/
|
||||
redirect_to: https://github.com/QubesOS/qubes-template-configs
|
||||
ref: 248
|
||||
title: Qubes Template Configs
|
||||
title: Qubes template configs
|
||||
---
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /doc/code-signing/
|
||||
ref: 51
|
||||
title: Code Signing
|
||||
title: Code signing
|
||||
---
|
||||
|
||||
All contributions to the Qubes OS [source code](/doc/source-code/) must be cryptographically signed by the author's PGP key.
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
- /wiki/CodingStyle/
|
||||
- /trac/wiki/CodingStyle/
|
||||
ref: 53
|
||||
title: Coding Style
|
||||
title: Coding style
|
||||
---
|
||||
|
||||
Rationale
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/QubesLicensing/
|
||||
- /wiki/QubesLicensing/
|
||||
ref: 52
|
||||
title: Software License
|
||||
title: Software license
|
||||
---
|
||||
|
||||
Qubes OS is a compilation of software packages, each under its own license. The
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/SourceCode/
|
||||
- /wiki/SourceCode/
|
||||
ref: 54
|
||||
title: Source Code
|
||||
title: Source code
|
||||
---
|
||||
|
||||
All the Qubes code is kept in Git repositories. We have divided the project into
|
||||
|
||||
@ -6,7 +6,7 @@ redirect_from:
|
||||
- /en/doc/automated-tests/
|
||||
- /doc/AutomatedTests/
|
||||
ref: 45
|
||||
title: Automated Tests
|
||||
title: Automated tests
|
||||
---
|
||||
|
||||
## Unit and Integration Tests
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /doc/mount-lvm-image/
|
||||
ref: 46
|
||||
title: How to Mount LVM Images
|
||||
title: How to mount LVM images
|
||||
---
|
||||
|
||||
You want to read your LVM image (e.g., there is a problem where you can't start any VMs except dom0).
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/Profiling/
|
||||
- /wiki/Profiling/
|
||||
ref: 48
|
||||
title: Python Profiling
|
||||
title: Python profiling
|
||||
---
|
||||
|
||||
This is a python profiling primer.
|
||||
|
||||
@ -5,7 +5,7 @@ permalink: /doc/safe-remote-ttys/
|
||||
redirect_from:
|
||||
- /en/doc/safe-remote-ttys/
|
||||
ref: 49
|
||||
title: Safe Remote Dom0 Terminals
|
||||
title: Safe remote dom0 terminals
|
||||
---
|
||||
|
||||
If you do not have working graphics in Dom0, then using a terminal can be quite annoying!
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/TestBench/
|
||||
- /wiki/TestBench/
|
||||
ref: 44
|
||||
title: How to Set Up a Test Bench
|
||||
title: How to set up a test bench
|
||||
---
|
||||
|
||||
This guide shows how to set up simple test bench that automatically test your code you're about to push. It is written especially for `core3` branch of `core-admin.git` repo, but some ideas are universal.
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
- /doc/SystemDoc/VMInterface/
|
||||
- /wiki/SystemDoc/VMInterface/
|
||||
ref: 47
|
||||
title: VM Configuration Interface
|
||||
title: Qube configuration interface
|
||||
---
|
||||
|
||||
Qubes VM have some settings set by dom0 based on VM settings. There are multiple configuration channels, which includes:
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/WindowsDebugging/
|
||||
- /wiki/WindowsDebugging/
|
||||
ref: 50
|
||||
title: Windows Debugging
|
||||
title: Windows debugging
|
||||
---
|
||||
|
||||
Debugging Windows code can be tricky in a virtualized environment. The guide below assumes Xen hypervisor and Windows 7 VMs.
|
||||
|
||||
34
developer/general/continuous-integration.md
Normal file
34
developer/general/continuous-integration.md
Normal file
@ -0,0 +1,34 @@
|
||||
---
|
||||
lang: en
|
||||
layout: doc
|
||||
permalink: /doc/continuous-integration/
|
||||
title: Continuous integration (CI)
|
||||
---
|
||||
|
||||
This page explains the [continuous integration
|
||||
(CI)](https://en.wikipedia.org/wiki/Continuous_integration) infrastructure that
|
||||
the Qubes OS Project uses.
|
||||
|
||||
## Website and documentation
|
||||
|
||||
The following commands may be useful as a way to interact with our CI
|
||||
infrastructure on website
|
||||
([qubesos.github.io](https://github.com/QubesOS/qubesos.github.io)) and
|
||||
documentation ([qubes-doc](https://github.com/QubesOS/qubes-doc)) pull requests
|
||||
(PRs). Note that special permissions may be required to use some of these
|
||||
commands. These commands are generally issued by adding a comment to a PR
|
||||
containing only the command.
|
||||
|
||||
- `PipelineRetry`: Attempts to run the entire build pipeline over again. This
|
||||
can be useful if CI incorrectly uses a stale branch instead of testing the PR
|
||||
as if it were merged into `master`.
|
||||
|
||||
- `TestDeploy`: Deploys a test website, which is a live version of the Qubes
|
||||
website as if this PR had been merged. This can be useful for previewing a PR
|
||||
on a live public website. **Note:** You must wait for the site to finish
|
||||
building before issuing this command, or else it will deploy an empty
|
||||
website. To find the URL of the test website, look for text similar to "This
|
||||
branch was successfully deployed" and a button named something like "View
|
||||
deployment." Note that there are two different testing sites: `wwwtest` is
|
||||
manually updated, whereas `wwwpreview` is managed by the `TestDeploy`
|
||||
command.
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/DevelBooks/
|
||||
- /wiki/DevelBooks/
|
||||
ref: 32
|
||||
title: Developer Books
|
||||
title: Developer books
|
||||
---
|
||||
|
||||
Below is a list of various books that might be useful in learning some basics needed for Qubes development.
|
||||
|
||||
@ -1,662 +0,0 @@
|
||||
---
|
||||
lang: en
|
||||
layout: doc
|
||||
permalink: /doc/doc-guidelines/
|
||||
redirect_from:
|
||||
- /en/doc/doc-guidelines/
|
||||
- /wiki/DocStyle/
|
||||
- /doc/DocStyle/
|
||||
ref: 30
|
||||
title: Documentation Guidelines
|
||||
---
|
||||
|
||||
All Qubes OS documentation pages are stored as plain text files in the
|
||||
dedicated [qubes-doc](https://github.com/QubesOS/qubes-doc) repository. By
|
||||
cloning and regularly pulling from this repo, users can maintain their own
|
||||
up-to-date offline copy of all Qubes documentation rather than relying solely
|
||||
on the web.
|
||||
|
||||
The documentation is a community effort. Volunteers work hard trying to keep
|
||||
everything accurate and comprehensive. If you notice a problem or some way it
|
||||
can be improved, please [edit the documentation](#how-to-contribute)!
|
||||
|
||||
## Security
|
||||
|
||||
*Also see: [Should I trust this website?](/faq/#should-i-trust-this-website)*
|
||||
|
||||
All pull requests (PRs) against
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc) must pass review prior to be
|
||||
merged, except in the case of [external
|
||||
documentation](/doc/#external-documentation) (see
|
||||
[#4693](https://github.com/QubesOS/qubes-issues/issues/4693)). This process is
|
||||
designed to ensure that contributed text is accurate and non-malicious. This
|
||||
process is a best effort that should provide a reasonable degree of assurance,
|
||||
but it is not foolproof. For example, all text characters are checked for ANSI
|
||||
escape sequences. However, binaries, such as images, are simply checked to
|
||||
ensure they appear or function the way they should when the website is
|
||||
rendered. They are not further analyzed in an attempt to determine whether they
|
||||
are malicious.
|
||||
|
||||
Once a pull request passes review, the reviewer should add a signed comment
|
||||
stating, "Passed review as of `<latest_commit>`" (or similar). The
|
||||
documentation maintainer then verifies that the pull request is mechanically
|
||||
sound (no merge conflicts, broken links, ANSI escapes, etc.). If so, the
|
||||
documentation maintainer then merges the pull request, adds a PGP-signed tag to
|
||||
the latest commit (usually the merge commit), then pushes to the remote. In
|
||||
cases in which another reviewer is not required, the documentation maintainer
|
||||
may review the pull request (in which case no signed comment is necessary,
|
||||
since it would be redundant with the signed tag).
|
||||
|
||||
## Questions, problems, and improvements
|
||||
|
||||
If you have a question about something you read in the documentation, please
|
||||
send it to the appropriate [mailing list](/support/). If you see that something
|
||||
in the documentation should be fixed or improved, please
|
||||
[contribute](#how-to-contribute) the change yourself. To report an issue with
|
||||
the documentation, please follow our standard [issue reporting
|
||||
guidelines](/doc/issue-tracking/). (If you report an issue with the
|
||||
documentation, you will likely be asked to address it, unless there is a clear
|
||||
indication in your report that you are not willing or able to do so.)
|
||||
|
||||
## How to contribute
|
||||
|
||||
Editing the documentation is easy, so if you see that a change should be made,
|
||||
please contribute it!
|
||||
|
||||
A few notes before we get started:
|
||||
|
||||
- Since Qubes is a security-oriented project, every documentation change will
|
||||
be [reviewed](#security) before it's accepted. This allows us to maintain
|
||||
quality control and protect our users.
|
||||
|
||||
- We don't want you to spend time and effort on a contribution that we can't
|
||||
accept. If your contribution would take a lot of time, please [file an
|
||||
issue](/doc/issue-tracking/) for it first so that we can make sure we're on
|
||||
the same page before significant works begins.
|
||||
|
||||
- Alternatively, you may already have written content that doesn't conform to
|
||||
these guidelines, but you'd be willing to modify it so that it does. In this
|
||||
case, you can still submit it by following the instructions below. Just make
|
||||
a note in your pull request (PR) that you're aware of the changes that need
|
||||
to be made and that you're just asking for the content to be reviewed before
|
||||
you spend time making those changes.
|
||||
|
||||
- Finally, if you've written something that doesn't belong in qubes-doc but that
|
||||
would be beneficial to the Qubes community, please consider adding it to the
|
||||
[external documentation](/doc/doc-guidelines/#core-vs-external-documentation).
|
||||
|
||||
As mentioned above, we keep all the documentation in a dedicated [Git
|
||||
repository](https://github.com/QubesOS/qubes-doc) hosted on
|
||||
[GitHub](https://github.com/). Thanks to GitHub's interface, you can edit the
|
||||
documentation even if you don't know Git at all! The only thing you need is a
|
||||
GitHub account, which is free.
|
||||
|
||||
(**Note:** If you're already familiar with GitHub or wish to work from the
|
||||
command line, you can skip the rest of this section. All you need to do to
|
||||
contribute is to [fork and
|
||||
clone](https://guides.github.com/activities/forking/) the
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc) repo, make your changes, then
|
||||
[submit a pull
|
||||
request](https://help.github.com/articles/using-pull-requests/).)
|
||||
|
||||
Ok, let's start. Every documentation page has a "Page Source on GitHub" button.
|
||||
Depending on the size of your screen, it may either be on the side (larger
|
||||
screens) or on the bottom (smaller screens).
|
||||
|
||||
[](/attachment/doc/doc-pr_01_page-source-button.png)
|
||||
|
||||
When you click on it, you'll be taken to the source file --- usually a Markdown
|
||||
(`.md`) file --- on GitHub. On this page, there will be a button to edit the
|
||||
file.
|
||||
|
||||
[](/attachment/doc/doc-pr_02_github-edit.png)
|
||||
|
||||
You'll be prompted to sign in with your GitHub username and password
|
||||
(if you aren't already logged in). You can also create a free account from here.
|
||||
|
||||
[](/attachment/doc/doc-pr_03_sign-in.png)
|
||||
|
||||
If this is your first contribution to the documentation, you need to "fork" the
|
||||
repository (make your own copy). It's easy --- just click the big green button
|
||||
on the next page. This step is only needed the first time you make a
|
||||
contribution.
|
||||
|
||||
[](/attachment/doc/doc-pr_04_fork.png)
|
||||
|
||||
Now you can make your modifications. You can also preview the changes to see
|
||||
how they'll be formatted by clicking the "Preview changes" tab. If you want to
|
||||
add images, please see [How to add images](#how-to-add-images). If you're
|
||||
making formatting changes, please [render the site
|
||||
locally](https://github.com/QubesOS/qubesos.github.io#instructions) to verify
|
||||
that everything looks correct before submitting any changes.
|
||||
|
||||
[](/attachment/doc/doc-pr_05_edit.png)
|
||||
|
||||
Once you're finished, describe your changes at the bottom and click "Propose
|
||||
file change".
|
||||
|
||||
[](/attachment/doc/doc-pr_06_commit-msg.png)
|
||||
|
||||
After that, you'll see exactly what modifications you've made. At this stage,
|
||||
those changes are still in your own copy of the documentation ("fork"). If
|
||||
everything looks good, send those changes to us by pressing the "Create pull
|
||||
request" button.
|
||||
|
||||
[](/attachment/doc/doc-pr_07_review-changes.png)
|
||||
|
||||
You will be able to adjust the pull request message and title there. In most
|
||||
cases, the defaults are ok, so you can just confirm by pressing the "Create
|
||||
pull request" button again. However, if you're not ready for your PR to be
|
||||
reviewed or merged yet, please [make a draft PR
|
||||
instead](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
|
||||
|
||||
[](/attachment/doc/doc-pr_08_create-pull-request.png)
|
||||
|
||||
If any of your changes should be reflected in the [documentation index (a.k.a.
|
||||
table of contents)](/doc/) --- for example, if you're adding a new page,
|
||||
changing the title of an existing page, or removing a page --- please see [How
|
||||
to edit the documentation index](#how-to-edit-the-documentation-index).
|
||||
|
||||
That's all! We will review your changes. If everything looks good, we'll pull
|
||||
them into the official documentation. Otherwise, we may have some questions for
|
||||
you, which we'll post in a comment on your pull request. (GitHub will
|
||||
automatically notify you if we do.) If, for some reason, we can't accept your
|
||||
pull request, we'll post a comment explaining why we can't.
|
||||
|
||||
[](/attachment/doc/doc-pr_09_done.png)
|
||||
|
||||
### How to edit the documentation index
|
||||
|
||||
The source file for the [documentation index (a.k.a. table of contents)](/doc/)
|
||||
lives here:
|
||||
|
||||
<https://github.com/QubesOS/qubesos.github.io/blob/master/_data/doc-index.yml>
|
||||
|
||||
Editing this file will change what appears on the documentation index. If your
|
||||
pull request (PR) adds, removes, or edits anything that should be reflected in
|
||||
the documentation index, please make sure you also submit an associated pull
|
||||
request against this file.
|
||||
|
||||
### How to add images
|
||||
|
||||
To add an image to a page, use the following syntax in the main document. This
|
||||
will make the image a hyperlink to the image file, allowing the reader to click
|
||||
on the image in order to view the image by itself.
|
||||
|
||||
```
|
||||
[](/attachment/doc/image.png)
|
||||
```
|
||||
|
||||
Then, submit your image(s) in a separate pull request to the
|
||||
[qubes-attachment](https://github.com/QubesOS/qubes-attachment) repository
|
||||
using the same path and filename. This is the only permitted way to include
|
||||
images. Do not link to images on other websites.
|
||||
|
||||
## Organizational guidelines
|
||||
|
||||
### Do not duplicate documentation
|
||||
|
||||
Duplicating documentation is almost always a bad idea. There are many reasons
|
||||
for this. The main one is that almost all documentation has to be updated as
|
||||
some point. When similar documentation appears in more than one place, it is
|
||||
very easy for it to get updated in one place but not the others (perhaps
|
||||
because the person updating it doesn't realize it's in more than once place).
|
||||
When this happens, the documentation as a whole is now inconsistent, and the
|
||||
outdated documentation becomes a trap, especially for novice users. Such traps
|
||||
are often more harmful than if the documentation never existed in the first
|
||||
place. The solution is to **link** to existing documentation rather than
|
||||
duplicating it. There are some exceptions to this policy (e.g., information
|
||||
that is certain not to change for a very long time), but they are rare.
|
||||
|
||||
### Core vs. external documentation
|
||||
|
||||
Core documentation resides in the [Qubes OS Project's official
|
||||
repositories](https://github.com/QubesOS/), mainly in
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc). External documentation can
|
||||
be anywhere else (such as forums, community websites, and blogs), but there is
|
||||
an especially large collection in the [Qubes
|
||||
Community](https://github.com/Qubes-Community) project. External documentation
|
||||
should not be submitted to [qubes-doc](https://github.com/QubesOS/qubes-doc).
|
||||
If you've written a piece of documentation that is not appropriate for
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc), we encourage you to submit
|
||||
it to the [Qubes Community](https://github.com/Qubes-Community) project
|
||||
instead. However, *linking* to external documentation from
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc) is perfectly fine. Indeed,
|
||||
the maintainers of the [Qubes Community](https://github.com/Qubes-Community)
|
||||
project should regularly submit PRs against the documentation index (see [How
|
||||
to edit the documentation index](#how-to-edit-the-documentation-index)) to add
|
||||
and update Qubes Community links in the "External Documentation" section of the
|
||||
documentation table of contents.
|
||||
|
||||
The main difference between **core** (or **official**) and **external** (or
|
||||
**community** or **unofficial**) documentation is whether it documents software
|
||||
that is officially written and maintained by the Qubes OS Project. The purpose
|
||||
of this distinction is to keep the core docs maintainable and high-quality by
|
||||
limiting them to the software output by the Qubes OS Project. In other words,
|
||||
we take responsibility for documenting all of the software we put out into the
|
||||
world, but it doesn't make sense for us to take on the responsibility of
|
||||
documenting or maintaining documentation for anything else. For example, Qubes
|
||||
OS may use a popular Linux distribution for an official
|
||||
[TemplateVM](/doc/templates/). However, it would not make sense for a
|
||||
comparatively small project like ours, with modest funding and a lean
|
||||
workforce, to attempt to document software belonging to a large, richly-funded
|
||||
project with an army of paid and volunteer contributors, especially when they
|
||||
probably already have documentation of their own. This is particularly true
|
||||
when it comes to Linux in general. Although many users who are new to Qubes are
|
||||
also new to Linux, it makes absolutely no sense for our comparatively tiny
|
||||
project to try to document Linux in general when there is already a plethora of
|
||||
documentation out there.
|
||||
|
||||
Many contributors do not realize that there is a significant amount of work
|
||||
involved in *maintaining* documentation after it has been written. They may
|
||||
wish to write documentation and submit it to the core docs, but they see only
|
||||
their own writing process and fail to consider that it will have to be kept
|
||||
up-to-date and consistent with the rest of the docs for years afterward.
|
||||
Submissions to the core docs also have to go through a review process to ensure
|
||||
accuracy before being merged (see [security](#security)), which takes up
|
||||
valuable time from the team. We aim to maintain high quality standards for the
|
||||
core docs (style and mechanics, formatting), which also takes up a lot of time.
|
||||
If the documentation involves anything external to the Qubes OS Project (such
|
||||
as a website, platform, program, protocol, framework, practice, or even a
|
||||
reference to a version number), the documentation is likely to become outdated
|
||||
when that external thing changes. It's also important to periodically review
|
||||
and update this documentation, especially when a new Qubes release comes out.
|
||||
Periodically, there may be technical or policy changes that affect all the core
|
||||
documentation. The more documentation there is relative to maintainers, the
|
||||
harder all of this will be. Since there are many more people who are willing to
|
||||
write documentation than to maintain it, these individually small incremental
|
||||
additions amount to a significant maintenance burden for the project.
|
||||
|
||||
On the positive side, we consider the existence of community documentation to
|
||||
be a sign of a healthy ecosystem, and this is quite common in the software
|
||||
world. The community is better positioned to write and maintain documentation
|
||||
that applies, combines, and simplifies the official documentation, e.g.,
|
||||
tutorials that explain how to install and use various programs in Qubes, how to
|
||||
create custom VM setups, and introductory tutorials that teach basic Linux
|
||||
concepts and commands in the context of Qubes. In addition, just because the
|
||||
Qubes OS Project has officially written and maintains some flexible framework,
|
||||
such as `qrexec`, it does not make sense to include every tutorial that says
|
||||
"here's how to do something cool with `qrexec`" in the core docs. Such
|
||||
tutorials generally also belong in the community documentation.
|
||||
|
||||
See [#4693](https://github.com/QubesOS/qubes-issues/issues/4693) for more
|
||||
background information.
|
||||
|
||||
### Version-specific documentation
|
||||
|
||||
*See [#5308](https://github.com/QubesOS/qubes-issues/issues/5308) for potential
|
||||
changes to this policy.*
|
||||
|
||||
We maintain only one set of documentation for Qubes OS. We do not maintain a
|
||||
different set of documentation for each version of Qubes. Our single set of
|
||||
Qubes OS documentation is updated on a continual, rolling basis. Our first
|
||||
priority is to document all **current, stable releases** of Qubes. Our second
|
||||
priority is to document the next, upcoming release (if any) that is currently
|
||||
in the beta or release candidate stage.
|
||||
|
||||
In cases where a documentation page covers functionality that differs
|
||||
considerably between Qubes OS versions, the page should be subdivided into
|
||||
clearly-labeled sections that cover the different functionality in different
|
||||
versions:
|
||||
|
||||
#### Incorrect Example
|
||||
|
||||
```
|
||||
# Page Title #
|
||||
|
||||
## How to Foo ##
|
||||
|
||||
Fooing is the process by which one foos. There are both general and specific
|
||||
versions of fooing, which vary in usefulness depending on your goals, but for
|
||||
the most part, all fooing is fooing.
|
||||
|
||||
To foo in Qubes 3.2:
|
||||
|
||||
$ qvm-foo <foo-bar>
|
||||
|
||||
Note that this does not work in Qubes 4.0, where there is a special widget
|
||||
for fooing, which you can find in the lower-right corner of the screen in
|
||||
the Foo Manager. Alternatively, you can use the more general `qubes-baz`
|
||||
command introduced in 4.0:
|
||||
|
||||
$ qubes-baz --foo <bar>
|
||||
|
||||
Once you foo, make sure to close the baz before fooing the next bar.
|
||||
```
|
||||
|
||||
#### Correct Example
|
||||
|
||||
```
|
||||
# Page Title #
|
||||
|
||||
## Qubes 3.2 ##
|
||||
|
||||
### How to Foo ###
|
||||
|
||||
Fooing is the process by which one foos. There are both general and specific
|
||||
versions of fooing, which vary in usefulness depending on your goals, but for
|
||||
the most part, all fooing is fooing.
|
||||
|
||||
To foo:
|
||||
|
||||
$ qvm-foo <foo-bar>
|
||||
|
||||
Once you foo, make sure to close the baz before fooing the next bar.
|
||||
|
||||
## Qubes 4.0 ##
|
||||
|
||||
### How to Foo ###
|
||||
|
||||
Fooing is the process by which one foos. There are both general and specific
|
||||
versions of fooing, which vary in usefulness depending on your goals, but for
|
||||
the most part, all fooing is fooing.
|
||||
|
||||
There is a special widget for fooing, which you can find in the lower-right
|
||||
corner of the screen in the Foo Manager. Alternatively, you can use the
|
||||
general `qubes-baz` command:
|
||||
|
||||
$ qubes-baz --foo <bar>
|
||||
|
||||
Once you foo, make sure to close the baz before fooing the next bar.
|
||||
```
|
||||
|
||||
Subdividing the page into clearly-labeled sections for each version has several
|
||||
benefits:
|
||||
|
||||
- It preserves good content for older (but still supported) versions. Many
|
||||
documentation contributors are also people who prefer to use the latest
|
||||
version. Many of them are tempted to *replace* existing content that applies
|
||||
to an older, supported version with content that applies only to the latest
|
||||
version. This is somewhat understandable. Since they only use the latest
|
||||
version, they may be focused on their own experience, and they may even
|
||||
regard the older version as deprecated, even when it's actually still
|
||||
supported. However, allowing this replacement of content would do a great
|
||||
disservice to those who still rely on the older, supported version. In many
|
||||
cases, these users value the stability and reliability of the older,
|
||||
supported version. With the older, supported version, there has been more
|
||||
time to fix bugs and make improvements in both the software and the
|
||||
documentation. Consequently, much of the documentation content for this
|
||||
version may have gone through several rounds of editing, review, and
|
||||
revision. It would be a tragedy for this content to vanish while the very set
|
||||
of users who most prize stability and reliability are depending on it.
|
||||
- It's easy for readers to quickly find the information they're looking for,
|
||||
since they can go directly to the section that applies to their version.
|
||||
- It's hard for readers to miss information they need, since it's all in one
|
||||
place. In the incorrect example, information that the reader needs could be
|
||||
in any paragraph in the entire document, and there's no way to tell without
|
||||
reading the entire page. In the correct example, the reader can simply skim
|
||||
the headings in order to know which parts of the page need to be read and
|
||||
which can be safely ignored. The fact that some content is repeated in the
|
||||
two version-specific sections is not a problem, since no reader has to read
|
||||
the same thing twice. Moreover, as one version gets updated, it's likely that
|
||||
the documentation for that version will also be updated. Therefore, content
|
||||
that is initially duplicated between version-specific sections will not
|
||||
necessarily stay that way, and this is a good thing: We want the
|
||||
documentation for a version that *doesn't* change to stay the same, and we
|
||||
want the documentation for a version that *does* change to change along with
|
||||
the software.
|
||||
- It's easy for documentation contributors and maintainers to know which file
|
||||
to edit and update, since there's only one page for all Qubes OS versions.
|
||||
Initially creating the new headings and duplicating content that applies to
|
||||
both is only a one-time cost for each page, and many pages don't even require
|
||||
this treatment, since they apply to all currently-supported Qubes OS
|
||||
versions.
|
||||
|
||||
By contrast, an alternative approach, such as segregating the documentation
|
||||
into two different branches, would mean that contributions that apply to both
|
||||
Qubes versions would only end up in one branch, unless someone remembered to
|
||||
manually submit the same thing to the other branch and actually made the effort
|
||||
to do so. Most of the time, this wouldn't happen. When it did, it would mean a
|
||||
second pull request that would have to be reviewed. Over time, the different
|
||||
branches would diverge in non-version-specific content. Good general content
|
||||
that was submitted only to one branch would effectively disappear once that
|
||||
version was deprecated. (Even if it were still on the website, no one would
|
||||
look at it, since it would explicitly be in the subdirectory of a deprecated
|
||||
version, and there would be a motivation to remove it from the website so that
|
||||
search results wouldn't be populated with out-of-date information.)
|
||||
|
||||
For further discussion about version-specific documentation in Qubes, see
|
||||
[here](https://groups.google.com/d/topic/qubes-users/H9BZX4K9Ptk/discussion).
|
||||
|
||||
## Style guidelines
|
||||
|
||||
### Correct use of terminology
|
||||
|
||||
Familiarize yourself with the terms defined in the [glossary](/doc/glossary/).
|
||||
Use these terms consistently and accurately throughout your writing.
|
||||
|
||||
### Variables in commands
|
||||
|
||||
Syntactically distinguish variables in commands. For example, this is
|
||||
ambiguous:
|
||||
|
||||
$ qvm-run --dispvm=disposable-template --service qubes.StartApp+xterm
|
||||
|
||||
It should instead be:
|
||||
|
||||
$ qvm-run --dispvm=<DISPOSABLE_TEMPLATE> --service qubes.StartApp+xterm
|
||||
|
||||
Note that we syntactically distinguish variables in three ways:
|
||||
1. Surrounding them in angled brackets (`< >`)
|
||||
2. Using underscores (`_`) instead of spaces between words
|
||||
3. Using all capital letters
|
||||
|
||||
We have observed that many novices make the mistake of typing the surrounding
|
||||
angled brackets (`< >`) on the command line, even after substituting the
|
||||
desired real value between them. Therefore, in documentation aimed at novices,
|
||||
we also recommend clarifying that the angled brackets should not be typed. This
|
||||
can be accomplished in one of several ways:
|
||||
- Explicitly say something like "without the angled brackets."
|
||||
- Provide an example command using real values that excludes the angled
|
||||
brackets.
|
||||
- If you know that almost all users will want to use (or should use) a specific
|
||||
command containing all real values and no variables, you might consider
|
||||
providing exactly that command and forgoing the version with variables.
|
||||
Novices may not realize which parts of the command they can substitute with
|
||||
different values, but if you've correctly judged that they should use the
|
||||
command you've provided as is, then this shouldn't matter.
|
||||
|
||||
## Markdown conventions
|
||||
|
||||
All the documentation is written in Markdown for maximum accessibility. When
|
||||
making contributions, please observe the following style conventions. If you're
|
||||
not familiar with Markdown syntax,
|
||||
[this](https://daringfireball.net/projects/markdown/) is a great resource.
|
||||
|
||||
### Indentation
|
||||
|
||||
Use spaces instead of tabs. Each indentation step should be exactly two (2)
|
||||
spaces.
|
||||
|
||||
### HTML and CSS
|
||||
|
||||
Do not write HTML inside Markdown documents (except in rare, unavoidable cases,
|
||||
such as alerts). In particular, never include HTML or CSS for styling,
|
||||
formatting, or white space control. That belongs in the (S)CSS files instead.
|
||||
|
||||
### Image linking
|
||||
|
||||
Link only to images in
|
||||
[qubes-attachment](https://github.com/QubesOS/qubes-attachment) (see
|
||||
[instructions above](#how-to-add-images)). Do not link to images on other
|
||||
websites.
|
||||
|
||||
### Relative vs. absolute links
|
||||
|
||||
Always use relative rather than absolute paths for internal website links. For
|
||||
example, use `/doc/doc-guidelines/` instead of
|
||||
`https://www.qubes-os.org/doc/doc-guidelines/`. Places where it's fine to use
|
||||
absolute URLs:
|
||||
- External links
|
||||
- URLs that appear inside code blocks (e.g., in comments and document
|
||||
templates, and the plain text reproductions of [QSBs](/security/qsb/) and
|
||||
[Canaries](/security/canary/)), since they're not hyperlinks
|
||||
- Git repo files like `README.md` and `CONTRIBUTING.md`, since they're not part
|
||||
of the website itself but rather of the auxiliary infrastructure supporting
|
||||
the website.
|
||||
|
||||
This rule is important, because using absolute URLs for internal website links
|
||||
is known to break the following:
|
||||
- Serving the website offline
|
||||
- Website localization
|
||||
- Generating offline documentation
|
||||
- Automatically redirecting Tor Browser visitors to the correct page on the
|
||||
onion service mirror.
|
||||
|
||||
### Source formatting and syntax
|
||||
|
||||
- Do not use `h1` headings (single `#` or `======` underline). These are
|
||||
automatically generated from the `title:` line in the YAML frontmatter.
|
||||
|
||||
- Use Atx-style headings: , `##h 2`, `### h3`, etc.
|
||||
|
||||
- Use non-reference-style links like `[website](https://example.com/)`. Do
|
||||
*not* use reference links like `[website][example]`, `[website][]` or
|
||||
`[website]`.
|
||||
|
||||
- If appropriate, make numerals in numbered lists match between Markdown source
|
||||
and HTML output. (Rationale: In the event that a user is required to read the
|
||||
Markdown source directly, this will make it easier to follow, e.g., numbered
|
||||
steps in a set of instructions.)
|
||||
|
||||
- When writing code blocks, use [syntax
|
||||
highlighting](https://github.github.com/gfm/#info-string) where
|
||||
[possible](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers)
|
||||
and use `[...]` for anything omitted.
|
||||
|
||||
- Use hanging indentations where appropriate.
|
||||
|
||||
### Writing command-line examples
|
||||
|
||||
When providing command line examples:
|
||||
- Tell the reader where to open a terminal (dom0 or a specific domU), and show
|
||||
the command along with its output (if any) in a code block, e.g.:
|
||||
|
||||
~~~markdown
|
||||
Open a terminal in dom0 and run:
|
||||
```shell_session
|
||||
$ cd test
|
||||
$ echo Hello
|
||||
Hello
|
||||
```
|
||||
~~~
|
||||
|
||||
- Precede each command with the appropriate command prompt: At a minimum, the
|
||||
prompt should contain a trailing `#` (for the user `root`) or `$` (for other
|
||||
users) on Linux systems and `>` on Windows systems, respectively.
|
||||
|
||||
- Don't try to add comments inside the code block. For example, *don't* do
|
||||
this:
|
||||
|
||||
~~~markdown
|
||||
Open a terminal in dom0 and run:
|
||||
```shell_session
|
||||
# Navigate to the new directory
|
||||
$ cd test
|
||||
# Generate a greeting
|
||||
$ echo Hello
|
||||
Hello
|
||||
```
|
||||
~~~
|
||||
|
||||
The `#` symbol preceding each comment is ambiguous with a root command
|
||||
prompt. Instead, put your comments *outside* of the code block in normal
|
||||
prose.
|
||||
|
||||
### Line wrapping
|
||||
|
||||
Hard wrap Markdown lines at 80 characters, unless the line can't be broken
|
||||
(e.g., code or a URL).
|
||||
|
||||
## Coding conventions
|
||||
|
||||
The following conventions apply to the website as a whole, including everything
|
||||
written in HTML, CSS, YAML, and Liquid. These conventions are intended to keep
|
||||
the codebase consistent when multiple collaborators are working on it. They
|
||||
should be understood as a practical set of rules for maintaining order in this
|
||||
specific codebase rather than as a statement of what is objectively right or
|
||||
good.
|
||||
|
||||
### General practices
|
||||
|
||||
- Use comments to indicate the purposes of different blocks of code. This makes
|
||||
the file easier to understand and navigate.
|
||||
|
||||
- Use descriptive variable names. Never use one or two letter variable names.
|
||||
Avoid obscure abbreviations and made-up words.
|
||||
|
||||
- In general, make it easy for others to read your code. Your future self will
|
||||
thank you, and so will your collaborators!
|
||||
|
||||
- [Don't Repeat Yourself
|
||||
(DRY)!](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) Instead of
|
||||
repeating the same block of code multiple times, abstract it out into a
|
||||
separate file and `include` that file where you need it.
|
||||
|
||||
### Whitespace
|
||||
|
||||
- Always use spaces. Never use tabs.
|
||||
|
||||
- Each indentation step should be exactly two (2) spaces.
|
||||
|
||||
- Whenever you add an opening tag, indent the following line. (Exception: If
|
||||
you open and close the tag on the same line, do not indent the following
|
||||
line.)
|
||||
|
||||
- Indent Liquid the same way as HTML.
|
||||
|
||||
- In general, the starting columns of every adjacent pair of lines should be no
|
||||
more than two spaces apart (example below).
|
||||
|
||||
- No blank or empty lines. (Hint: When you feel you need one, add a comment on
|
||||
that line instead.)
|
||||
|
||||
#### Indentation example
|
||||
|
||||
Here's an example that follows the indentation rules:
|
||||
|
||||
{% raw %}
|
||||
```html
|
||||
<table>
|
||||
<tr>
|
||||
<th title="Anchor Link"><span class="fa fa-link"></span></th>
|
||||
{% for item in secs.htmlsections[0].columns %}
|
||||
<th>{{ item.title }}</th>
|
||||
{% endfor %}
|
||||
</tr>
|
||||
{% for canary in site.data.sec-canary reversed %}
|
||||
<tr id="{{ canary.canary }}">
|
||||
<td><a href="#{{ canary.canary }}" class="fa fa-link black-icon" title="Anchor link to Qubes Canary row: Qubes Canary #{{ canary.canary }}"></a></td>
|
||||
<td>{{ canary.date }}</td>
|
||||
<td><a href="https://github.com/QubesOS/qubes-secpack/blob/master/canaries/canary-{{ canary.canary }}-{{ canary.date | date: '%Y' }}.txt">Qubes Canary #{{ canary.canary }}</a></td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
</table>
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
## Git conventions
|
||||
|
||||
Please try to write good commit messages, according to the [instructions in our
|
||||
coding style guidelines](/doc/coding-style/#commit-message-guidelines).
|
||||
|
||||
## Continuous Integration (CI)
|
||||
|
||||
The following commands may be useful as a way to interact with our CI
|
||||
infrastructure. Note that special permissions may be required to use some of
|
||||
these commands. These commands are generally issued by adding a comment to a
|
||||
pull request (PR) containing only the command.
|
||||
|
||||
- `PipelineRetry`: Attempts to run the entire build pipeline over again. This
|
||||
can be useful if CI incorrectly uses a stale branch instead of testing the PR
|
||||
as if it were merged into `master`.
|
||||
|
||||
- `TestDeploy`: Deploys a test website, which is a live version of the Qubes
|
||||
website as if this PR had been merged. This can be useful for previewing a PR
|
||||
on a live public website. **Note:** You must wait for the site to finish
|
||||
building before issuing this command, or else it will deploy an empty
|
||||
website. To find the URL of the test website, look for text similar to "This
|
||||
branch was successfully deployed" and a button named something like "View
|
||||
deployment." Note that there are two different testing sites: `wwwtest` is
|
||||
manually updated, whereas `wwwpreview` is managed by the `TestDeploy`
|
||||
command.
|
||||
440
developer/general/documentation-style-guide.md
Normal file
440
developer/general/documentation-style-guide.md
Normal file
@ -0,0 +1,440 @@
|
||||
---
|
||||
lang: en
|
||||
layout: doc
|
||||
permalink: /doc/documentation-style-guide/
|
||||
redirect_from:
|
||||
- /doc/doc-guidelines/
|
||||
- /en/doc/doc-guidelines/
|
||||
- /wiki/DocStyle/
|
||||
- /doc/DocStyle/
|
||||
ref: 30
|
||||
title: Documentation style guide
|
||||
---
|
||||
|
||||
_Also see [how to edit the documentation](/doc/how-to-edit-the-documentation/)._
|
||||
|
||||
Qubes OS documentation pages are stored as plain text Markdown files in the
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc) repository. By cloning and
|
||||
regularly pulling from this repo, users can maintain their own up-to-date
|
||||
offline copy of all Qubes documentation rather than relying solely on the web.
|
||||
|
||||
The documentation is a volunteer community effort. People like you are
|
||||
constantly working to make it better. If you notice something that can be fixed
|
||||
or improved, please [edit the
|
||||
documentation](/doc/how-to-edit-the-documentation/)!
|
||||
|
||||
This page explains the standards we follow for writing, formatting, and
|
||||
organizing the documentation. Please follow these guidelines and conventions
|
||||
when editing the documentation. For the standards governing the website as a
|
||||
whole, please see the [website style guide](/doc/website-style-guide).
|
||||
|
||||
## Markdown conventions
|
||||
|
||||
All the documentation is written in Markdown for maximum accessibility. When
|
||||
making contributions, please observe the following style conventions. If you're
|
||||
not familiar with Markdown syntax,
|
||||
[this](https://daringfireball.net/projects/markdown/) is a great resource.
|
||||
|
||||
### Hyperlink syntax
|
||||
|
||||
Use non-reference-style links like `[website](https://example.com/)`. Do *not*
|
||||
use reference-style links like `[website][example]`, `[website][]` or
|
||||
`[website]`. This facilitates the localization process.
|
||||
|
||||
### Relative vs. absolute links
|
||||
|
||||
Always use relative rather than absolute paths for internal website links. For
|
||||
example, use `/doc/documentation-style-guide/` instead of
|
||||
`https://www.qubes-os.org/doc/documentation-style-guide/`.
|
||||
|
||||
You may use absolute URLs in the following cases:
|
||||
|
||||
- External links
|
||||
- URLs that appear inside code blocks (e.g., in comments and document
|
||||
templates, and the plain text reproductions of [QSBs](/security/qsb/) and
|
||||
[Canaries](/security/canary/)), since they're not hyperlinks
|
||||
- Git repo files like `README.md` and `CONTRIBUTING.md`, since they're not part
|
||||
of the website itself but rather of the auxiliary infrastructure supporting
|
||||
the website
|
||||
|
||||
This rule is important because using absolute URLs for internal website links
|
||||
breaks:
|
||||
|
||||
- Serving the website offline
|
||||
- Website localization
|
||||
- Generating offline documentation
|
||||
- Automatically redirecting Tor Browser visitors to the correct page on the
|
||||
onion service mirror
|
||||
|
||||
### Image linking
|
||||
|
||||
See [how to add images](/doc/how-to-edit-the-documentation/#how-to-add-images)
|
||||
for the required syntax. This will make the image a hyperlink to the image
|
||||
file, allowing the reader to click on the image in order to view the full image
|
||||
by itself. This is important. Following best practices, our website has a
|
||||
responsive design, which allows the website to render appropriately across all
|
||||
screen sizes. When viewing this page on a smaller screen, such as on a mobile
|
||||
device, the image will automatically shrink down to fit the screen. If visitors
|
||||
cannot click on the image to view it in full size, then, depending on their
|
||||
device, they may have no way see the details in the image clearly.
|
||||
|
||||
In addition, make sure to link only to images in the
|
||||
[qubes-attachment](https://github.com/QubesOS/qubes-attachment) repository. Do
|
||||
not attempt to link to images hosted on other websites.
|
||||
|
||||
### HTML and CSS
|
||||
|
||||
Do not write HTML inside Markdown documents (except in rare, unavoidable cases,
|
||||
such as alerts). In particular, never include HTML or CSS for styling,
|
||||
formatting, or white space control. That belongs in the (S)CSS files instead.
|
||||
|
||||
### Headings
|
||||
|
||||
Do not use `h1` headings (single `#` or `======` underline). These are
|
||||
automatically generated from the `title:` line in the YAML front matter.
|
||||
|
||||
Use Atx-style syntax for headings: `##h2`, `### h3`, etc. Do not use
|
||||
underlining syntax (`-----`).
|
||||
|
||||
### Indentation
|
||||
|
||||
Use spaces instead of tabs. Use hanging indentations where appropriate.
|
||||
|
||||
### Lists
|
||||
|
||||
If appropriate, make numerals in numbered lists match between Markdown source
|
||||
and HTML output. Some users read the Markdown source directly, and this makes
|
||||
numbered lists easier to follow.
|
||||
|
||||
### Code blocks
|
||||
|
||||
When writing code blocks, use [syntax
|
||||
highlighting](https://github.github.com/gfm/#info-string) where possible (see
|
||||
[here](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers)
|
||||
for a list of supported languages). Use `[...]` for anything omitted.
|
||||
|
||||
### Line wrapping
|
||||
|
||||
Hard wrap Markdown lines at 80 characters, unless the line can't be broken
|
||||
(e.g., code or a URL).
|
||||
|
||||
## Writing guidelines
|
||||
|
||||
### Correct use of terminology
|
||||
|
||||
Familiarize yourself with the terms defined in the [glossary](/doc/glossary/).
|
||||
Use these terms consistently and accurately throughout your writing.
|
||||
|
||||
### Sentence case in headings
|
||||
|
||||
Use sentence case (rather than title case) in headings for the reasons
|
||||
explained
|
||||
[here](https://www.sallybagshaw.com.au/articles/sentence-case-v-title-case/).
|
||||
In particular, since the authorship of the Qubes documentation is decentralized
|
||||
and widely distributed among users from around the world, many contributors
|
||||
come from regions with different conventions for implementing title case, not
|
||||
to mention that there are often differing style guide recommendations even
|
||||
within a single region. It is much easier for all of us to implement sentence
|
||||
case consistently across our growing body of pages, which is very important for
|
||||
managing the ongoing maintenance burden and sustainability of the
|
||||
documentation.
|
||||
|
||||
### Writing command-line examples
|
||||
|
||||
When providing command-line examples:
|
||||
|
||||
- Tell the reader where to open a terminal (dom0 or a specific domU), and show
|
||||
the command along with its output (if any) in a code block, e.g.:
|
||||
|
||||
~~~markdown
|
||||
Open a terminal in dom0 and run:
|
||||
```shell_session
|
||||
$ cd test
|
||||
$ echo Hello
|
||||
Hello
|
||||
```
|
||||
~~~
|
||||
|
||||
- Precede each command with the appropriate command prompt: At a minimum, the
|
||||
prompt should contain a trailing `#` (for the user `root`) or `$` (for other
|
||||
users) on Linux systems and `>` on Windows systems, respectively.
|
||||
|
||||
- Don't try to add comments inside the code block. For example, *don't* do
|
||||
this:
|
||||
|
||||
~~~markdown
|
||||
Open a terminal in dom0 and run:
|
||||
```shell_session
|
||||
# Navigate to the new directory
|
||||
$ cd test
|
||||
# Generate a greeting
|
||||
$ echo Hello
|
||||
Hello
|
||||
```
|
||||
~~~
|
||||
|
||||
The `#` symbol preceding each comment is ambiguous with a root command
|
||||
prompt. Instead, put your comments *outside* of the code block in normal
|
||||
prose.
|
||||
|
||||
### Variable names in commands
|
||||
|
||||
Syntactically distinguish variables in commands. For example, this is
|
||||
ambiguous:
|
||||
|
||||
$ qvm-run --dispvm=disposable-template --service qubes.StartApp+xterm
|
||||
|
||||
It should instead be:
|
||||
|
||||
$ qvm-run --dispvm=<DISPOSABLE_TEMPLATE> --service qubes.StartApp+xterm
|
||||
|
||||
Note that we syntactically distinguish variables in three ways:
|
||||
|
||||
1. Surrounding them in angled brackets (`< >`)
|
||||
2. Using underscores (`_`) instead of spaces between words
|
||||
3. Using all capital letters
|
||||
|
||||
We have observed that many novices make the mistake of typing the surrounding
|
||||
angled brackets (`< >`) on the command line, even after substituting the
|
||||
desired real value between them. Therefore, in documentation aimed at novices,
|
||||
we also recommend clarifying that the angled brackets should not be typed. This
|
||||
can be accomplished in one of several ways:
|
||||
|
||||
- Explicitly say something like "without the angled brackets."
|
||||
- Provide an example command using real values that excludes the angled
|
||||
brackets.
|
||||
- If you know that almost all users will want to use (or should use) a specific
|
||||
command containing all real values and no variables, you might consider
|
||||
providing exactly that command and forgoing the version with variables.
|
||||
Novices may not realize which parts of the command they can substitute with
|
||||
different values, but if you've correctly judged that they should use the
|
||||
command you've provided as is, then this shouldn't matter.
|
||||
|
||||
## Organizational guidelines
|
||||
|
||||
### Do not duplicate documentation
|
||||
|
||||
Duplicating documentation is almost always a bad idea. There are many reasons
|
||||
for this. The main one is that almost all documentation has to be updated as
|
||||
some point. When similar documentation appears in more than one place, it is
|
||||
very easy for it to get updated in one place but not the others (perhaps
|
||||
because the person updating it doesn't realize it's in more than once place).
|
||||
When this happens, the documentation as a whole is now inconsistent, and the
|
||||
outdated documentation becomes a trap, especially for novice users. Such traps
|
||||
are often more harmful than if the documentation never existed in the first
|
||||
place. The solution is to **link** to existing documentation rather than
|
||||
duplicating it. There are some exceptions to this policy (e.g., information
|
||||
that is certain not to change for a very long time), but they are rare.
|
||||
|
||||
### Core vs. external documentation
|
||||
|
||||
Core documentation resides in the [Qubes OS Project's official
|
||||
repositories](https://github.com/QubesOS/), mainly in
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc). External documentation can
|
||||
be anywhere else (such as forums, community websites, and blogs), but there is
|
||||
an especially large collection in the [Qubes
|
||||
Community](https://github.com/Qubes-Community) project. External documentation
|
||||
should not be submitted to [qubes-doc](https://github.com/QubesOS/qubes-doc).
|
||||
If you've written a piece of documentation that is not appropriate for
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc), we encourage you to submit
|
||||
it to the [Qubes Community](https://github.com/Qubes-Community) project
|
||||
instead. However, *linking* to external documentation from
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc) is perfectly fine. Indeed,
|
||||
the maintainers of the [Qubes Community](https://github.com/Qubes-Community)
|
||||
project should regularly submit PRs against the documentation index (see [How
|
||||
to edit the documentation
|
||||
index](/doc/how-to-edit-the-documentation/#how-to-edit-the-documentation-index))
|
||||
to add and update Qubes Community links in the "External Documentation" section
|
||||
of the documentation table of contents.
|
||||
|
||||
The main difference between **core** (or **official**) and **external** (or
|
||||
**community** or **unofficial**) documentation is whether it documents software
|
||||
that is officially written and maintained by the Qubes OS Project. The purpose
|
||||
of this distinction is to keep the core docs maintainable and high-quality by
|
||||
limiting them to the software output by the Qubes OS Project. In other words,
|
||||
we take responsibility for documenting all of the software we put out into the
|
||||
world, but it doesn't make sense for us to take on the responsibility of
|
||||
documenting or maintaining documentation for anything else. For example, Qubes
|
||||
OS may use a popular Linux distribution for an official
|
||||
[TemplateVM](/doc/templates/). However, it would not make sense for a
|
||||
comparatively small project like ours, with modest funding and a lean
|
||||
workforce, to attempt to document software belonging to a large, richly-funded
|
||||
project with an army of paid and volunteer contributors, especially when they
|
||||
probably already have documentation of their own. This is particularly true
|
||||
when it comes to Linux in general. Although many users who are new to Qubes are
|
||||
also new to Linux, it makes absolutely no sense for our comparatively tiny
|
||||
project to try to document Linux in general when there is already a plethora of
|
||||
documentation out there.
|
||||
|
||||
Many contributors do not realize that there is a significant amount of work
|
||||
involved in *maintaining* documentation after it has been written. They may
|
||||
wish to write documentation and submit it to the core docs, but they see only
|
||||
their own writing process and fail to consider that it will have to be kept
|
||||
up-to-date and consistent with the rest of the docs for years afterward.
|
||||
Submissions to the core docs also have to [undergo a review
|
||||
process](/doc/how-to-edit-the-documentation#security) to ensure accuracy before
|
||||
being merged, which takes up valuable time from the team. We aim to maintain
|
||||
high quality standards for the core docs (style and mechanics, formatting),
|
||||
which also takes up a lot of time. If the documentation involves anything
|
||||
external to the Qubes OS Project (such as a website, platform, program,
|
||||
protocol, framework, practice, or even a reference to a version number), the
|
||||
documentation is likely to become outdated when that external thing changes.
|
||||
It's also important to periodically review and update this documentation,
|
||||
especially when a new Qubes release comes out. Periodically, there may be
|
||||
technical or policy changes that affect all the core documentation. The more
|
||||
documentation there is relative to maintainers, the harder all of this will be.
|
||||
Since there are many more people who are willing to write documentation than to
|
||||
maintain it, these individually small incremental additions amount to a
|
||||
significant maintenance burden for the project.
|
||||
|
||||
On the positive side, we consider the existence of community documentation to
|
||||
be a sign of a healthy ecosystem, and this is quite common in the software
|
||||
world. The community is better positioned to write and maintain documentation
|
||||
that applies, combines, and simplifies the official documentation, e.g.,
|
||||
tutorials that explain how to install and use various programs in Qubes, how to
|
||||
create custom VM setups, and introductory tutorials that teach basic Linux
|
||||
concepts and commands in the context of Qubes. In addition, just because the
|
||||
Qubes OS Project has officially written and maintains some flexible framework,
|
||||
such as `qrexec`, it does not make sense to include every tutorial that says
|
||||
"here's how to do something cool with `qrexec`" in the core docs. Such
|
||||
tutorials generally also belong in the community documentation.
|
||||
|
||||
See [#4693](https://github.com/QubesOS/qubes-issues/issues/4693) for more
|
||||
background information.
|
||||
|
||||
### Release-specific documentation
|
||||
|
||||
*See [#5308](https://github.com/QubesOS/qubes-issues/issues/5308) for pending
|
||||
changes to this policy.*
|
||||
|
||||
We maintain only one set of documentation for Qubes OS. We do not maintain a
|
||||
different set of documentation for each release of Qubes. Our single set of
|
||||
Qubes OS documentation is updated on a continual, rolling basis. Our first
|
||||
priority is to document all **current, stable releases** of Qubes. Our second
|
||||
priority is to document the next, upcoming release (if any) that is currently
|
||||
in the beta or release candidate stage.
|
||||
|
||||
In cases where a documentation page covers functionality that differs
|
||||
considerably between Qubes OS releases, the page should be subdivided into
|
||||
clearly-labeled sections that cover the different functionality in different
|
||||
releases:
|
||||
|
||||
#### Incorrect Example
|
||||
|
||||
```
|
||||
## How to Foo
|
||||
|
||||
Fooing is the process by which one foos. There are both general and specific
|
||||
versions of fooing, which vary in usefulness depending on your goals, but for
|
||||
the most part, all fooing is fooing.
|
||||
|
||||
To foo in Qubes 3.2:
|
||||
|
||||
$ qvm-foo <foo-bar>
|
||||
|
||||
Note that this does not work in Qubes 4.0, where there is a special widget
|
||||
for fooing, which you can find in the lower-right corner of the screen in
|
||||
the Foo Manager. Alternatively, you can use the more general `qubes-baz`
|
||||
command introduced in 4.0:
|
||||
|
||||
$ qubes-baz --foo <bar>
|
||||
|
||||
Once you foo, make sure to close the baz before fooing the next bar.
|
||||
```
|
||||
|
||||
#### Correct Example
|
||||
|
||||
```
|
||||
## Qubes 3.2
|
||||
|
||||
### How to Foo
|
||||
|
||||
Fooing is the process by which one foos. There are both general and specific
|
||||
versions of fooing, which vary in usefulness depending on your goals, but for
|
||||
the most part, all fooing is fooing.
|
||||
|
||||
To foo:
|
||||
|
||||
$ qvm-foo <foo-bar>
|
||||
|
||||
Once you foo, make sure to close the baz before fooing the next bar.
|
||||
|
||||
## Qubes 4.0
|
||||
|
||||
### How to Foo
|
||||
|
||||
Fooing is the process by which one foos. There are both general and specific
|
||||
versions of fooing, which vary in usefulness depending on your goals, but for
|
||||
the most part, all fooing is fooing.
|
||||
|
||||
There is a special widget for fooing, which you can find in the lower-right
|
||||
corner of the screen in the Foo Manager. Alternatively, you can use the
|
||||
general `qubes-baz` command:
|
||||
|
||||
$ qubes-baz --foo <bar>
|
||||
|
||||
Once you foo, make sure to close the baz before fooing the next bar.
|
||||
```
|
||||
|
||||
Subdividing the page into clearly-labeled sections for each release has several
|
||||
benefits:
|
||||
|
||||
- It preserves good content for older (but still supported) releases. Many
|
||||
documentation contributors are also people who prefer to use the latest
|
||||
release. Many of them are tempted to *replace* existing content that applies
|
||||
to an older, supported release with content that applies only to the latest
|
||||
release. This is somewhat understandable. Since they only use the latest
|
||||
release, they may be focused on their own experience, and they may even
|
||||
regard the older release as deprecated, even when it's actually still
|
||||
supported. However, allowing this replacement of content would do a great
|
||||
disservice to those who still rely on the older, supported release. In many
|
||||
cases, these users value the stability and reliability of the older,
|
||||
supported release. With the older, supported release, there has been more
|
||||
time to fix bugs and make improvements in both the software and the
|
||||
documentation. Consequently, much of the documentation content for this
|
||||
release may have gone through several rounds of editing, review, and
|
||||
revision. It would be a tragedy for this content to vanish while the very set
|
||||
of users who most prize stability and reliability are depending on it.
|
||||
- It's easy for readers to quickly find the information they're looking for,
|
||||
since they can go directly to the section that applies to their release.
|
||||
- It's hard for readers to miss information they need, since it's all in one
|
||||
place. In the incorrect example, information that the reader needs could be
|
||||
in any paragraph in the entire document, and there's no way to tell without
|
||||
reading the entire page. In the correct example, the reader can simply skim
|
||||
the headings in order to know which parts of the page need to be read and
|
||||
which can be safely ignored. The fact that some content is repeated in the
|
||||
two release-specific sections is not a problem, since no reader has to read
|
||||
the same thing twice. Moreover, as one release gets updated, it's likely that
|
||||
the documentation for that release will also be updated. Therefore, content
|
||||
that is initially duplicated between release-specific sections will not
|
||||
necessarily stay that way, and this is a good thing: We want the
|
||||
documentation for a release that *doesn't* change to stay the same, and we
|
||||
want the documentation for a release that *does* change to change along with
|
||||
the software.
|
||||
- It's easy for documentation contributors and maintainers to know which file
|
||||
to edit and update, since there's only one page for all Qubes OS releases.
|
||||
Initially creating the new headings and duplicating content that applies to
|
||||
both is only a one-time cost for each page, and many pages don't even require
|
||||
this treatment, since they apply to all currently-supported Qubes OS
|
||||
releases.
|
||||
|
||||
By contrast, an alternative approach, such as segregating the documentation
|
||||
into two different branches, would mean that contributions that apply to both
|
||||
Qubes releases would only end up in one branch, unless someone remembered to
|
||||
manually submit the same thing to the other branch and actually made the effort
|
||||
to do so. Most of the time, this wouldn't happen. When it did, it would mean a
|
||||
second pull request that would have to be reviewed. Over time, the different
|
||||
branches would diverge in non-release-specific content. Good general content
|
||||
that was submitted only to one branch would effectively disappear once that
|
||||
release was deprecated. (Even if it were still on the website, no one would
|
||||
look at it, since it would explicitly be in the subdirectory of a deprecated
|
||||
release, and there would be a motivation to remove it from the website so that
|
||||
search results wouldn't be populated with out-of-date information.)
|
||||
|
||||
For further discussion about release-specific documentation in Qubes, see
|
||||
[here](https://groups.google.com/d/topic/qubes-users/H9BZX4K9Ptk/discussion).
|
||||
|
||||
## Git conventions
|
||||
|
||||
Please follow our [Git commit message
|
||||
guidelines](/doc/coding-style/#commit-message-guidelines).
|
||||
@ -5,7 +5,7 @@ permalink: /gsoc/
|
||||
redirect_from:
|
||||
- /GSoC/
|
||||
ref: 33
|
||||
title: Google Summer of Code
|
||||
title: Google Summer of Code (GSoC)
|
||||
---
|
||||
|
||||
## Information for Students
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /gsod/
|
||||
ref: 242
|
||||
title: Google Season of Docs
|
||||
title: Google Season of Docs (GSoD)
|
||||
---
|
||||
|
||||
Thank you for your interest in participating in the [2021 Google Season of Docs](https://developers.google.com/season-of-docs/) program with the [Qubes OS team](/team/). You can read more about the Google Season of Docs in the official [guides](https://developers.google.com/season-of-docs/docs/) and [FAQ](https://developers.google.com/season-of-docs/docs/faq).
|
||||
|
||||
198
developer/general/how-to-edit-the-documentation.md
Normal file
198
developer/general/how-to-edit-the-documentation.md
Normal file
@ -0,0 +1,198 @@
|
||||
---
|
||||
lang: en
|
||||
layout: doc
|
||||
permalink: /doc/how-to-edit-the-documentation/
|
||||
title: How to edit the documentation
|
||||
---
|
||||
|
||||
_Also see the [documentation style guide](/doc/documentation-style-guide/)._
|
||||
|
||||
Qubes OS documentation pages are stored as plain text Markdown files in the
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc) repository. By cloning and
|
||||
regularly pulling from this repo, users can maintain their own up-to-date
|
||||
offline copy of all Qubes documentation rather than relying solely on the web.
|
||||
|
||||
The documentation is a volunteer community effort. People like you are
|
||||
constantly working to make it better. If you notice something that can be fixed
|
||||
or improved, please follow the steps below to open a pull request!
|
||||
|
||||
## How to submit a pull request
|
||||
|
||||
We keep all the documentation in
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc), a dedicated Git repository
|
||||
hosted on [GitHub](https://github.com/). Thanks to GitHub's easy web interface,
|
||||
you can edit the documentation even if you're not familiar with Git or the
|
||||
command line! All you need is a free GitHub account.
|
||||
|
||||
A few notes before we get started:
|
||||
|
||||
- Since Qubes is a security-oriented project, every documentation change will
|
||||
be [reviewed](#security) before it's accepted. This allows us to maintain
|
||||
quality control and protect our users.
|
||||
|
||||
- To give your contribution a better chance of being accepted, please follow
|
||||
our [documentation style guide](/doc/documentation-style-guide/).
|
||||
|
||||
- We don't want you to spend time and effort on a contribution that we can't
|
||||
accept. If your contribution would take a lot of time, please [file an
|
||||
issue](/doc/issue-tracking/) for it first so that we can make sure we're on
|
||||
the same page before significant works begins.
|
||||
|
||||
- Alternatively, you may already have written content that doesn't conform to
|
||||
these guidelines, but you'd be willing to modify it so that it does. In this
|
||||
case, you can still submit it by following the instructions below. Just make
|
||||
a note in your pull request (PR) that you're aware of the changes that need
|
||||
to be made and that you're just asking for the content to be reviewed before
|
||||
you spend time making those changes.
|
||||
|
||||
- Finally, if you've written something that doesn't belong in qubes-doc but
|
||||
that would be beneficial to the Qubes community, please consider adding it to
|
||||
the [external
|
||||
documentation](/doc/documentation-style-guide/#core-vs-external-documentation).
|
||||
|
||||
(**Advanced users:** If you're already familiar with GitHub or wish to work
|
||||
from the command line, you can skip the rest of this section. All you need to
|
||||
do to contribute is to [fork and
|
||||
clone](https://guides.github.com/activities/forking/) the
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc) repo, make your changes, then
|
||||
[submit a pull
|
||||
request](https://help.github.com/articles/using-pull-requests/).)
|
||||
|
||||
Ok, let's begin. Every documentation page has a "Page Source on GitHub" button.
|
||||
Depending on the size of your screen, it may either be on the side (larger
|
||||
screens) or on the bottom (smaller screens).
|
||||
|
||||
[](/attachment/doc/doc-pr_01_page-source-button.png)
|
||||
|
||||
When you click on it, you'll be taken to the source file --- usually a Markdown
|
||||
(`.md`) file --- on GitHub. On this page, there will be a button to edit the
|
||||
file.
|
||||
|
||||
[](/attachment/doc/doc-pr_02_github-edit.png)
|
||||
|
||||
You'll be prompted to sign in with your GitHub username and password
|
||||
(if you aren't already logged in). You can also create a free account from here.
|
||||
|
||||
[](/attachment/doc/doc-pr_03_sign-in.png)
|
||||
|
||||
If this is your first contribution to the documentation, you need to "fork" the
|
||||
repository (make your own copy). It's easy --- just click the big green button
|
||||
on the next page. This step is only needed the first time you make a
|
||||
contribution.
|
||||
|
||||
[](/attachment/doc/doc-pr_04_fork.png)
|
||||
|
||||
Now you can make your modifications. You can also preview the changes to see
|
||||
how they'll be formatted by clicking the "Preview changes" tab. If you want to
|
||||
add images, please see [How to add images](#how-to-add-images). If you're
|
||||
making formatting changes, please [render the site
|
||||
locally](https://github.com/QubesOS/qubesos.github.io#instructions) to verify
|
||||
that everything looks correct before submitting any changes.
|
||||
|
||||
[](/attachment/doc/doc-pr_05_edit.png)
|
||||
|
||||
Once you're finished, describe your changes at the bottom and click "Propose
|
||||
file change".
|
||||
|
||||
[](/attachment/doc/doc-pr_06_commit-msg.png)
|
||||
|
||||
After that, you'll see exactly what modifications you've made. At this stage,
|
||||
those changes are still in your own copy of the documentation ("fork"). If
|
||||
everything looks good, send those changes to us by pressing the "Create pull
|
||||
request" button.
|
||||
|
||||
[](/attachment/doc/doc-pr_07_review-changes.png)
|
||||
|
||||
You will be able to adjust the pull request message and title there. In most
|
||||
cases, the defaults are ok, so you can just confirm by pressing the "Create
|
||||
pull request" button again. However, if you're not ready for your PR to be
|
||||
reviewed or merged yet, please [make a draft PR
|
||||
instead](https://github.blog/2019-02-14-introducing-draft-pull-requests/).
|
||||
|
||||
[](/attachment/doc/doc-pr_08_create-pull-request.png)
|
||||
|
||||
If any of your changes should be reflected in the [documentation index (a.k.a.
|
||||
table of contents)](/doc/) --- for example, if you're adding a new page,
|
||||
changing the title of an existing page, or removing a page --- please see [How
|
||||
to edit the documentation index](#how-to-edit-the-documentation-index).
|
||||
|
||||
That's all! We will review your changes. If everything looks good, we'll pull
|
||||
them into the official documentation. Otherwise, we may have some questions for
|
||||
you, which we'll post in a comment on your pull request. (GitHub will
|
||||
automatically notify you if we do.) If, for some reason, we can't accept your
|
||||
pull request, we'll post a comment explaining why we can't.
|
||||
|
||||
[](/attachment/doc/doc-pr_09_done.png)
|
||||
|
||||
## How to edit the documentation index
|
||||
|
||||
The source file for the [documentation index (a.k.a. table of contents)](/doc/)
|
||||
is
|
||||
[doc-index.yml](https://github.com/QubesOS/qubesos.github.io/blob/master/_data/doc-index.yml).
|
||||
|
||||
Editing this file will change what appears on the documentation index. If your
|
||||
pull request (PR) adds, removes, or edits anything that should be reflected in
|
||||
the documentation index, please make sure you also submit an associated pull
|
||||
request against this file.
|
||||
|
||||
## How to add images
|
||||
|
||||
To add an image to a page, use the following syntax in the main document (see
|
||||
[here](/doc/documentation-style-guide/#image-linking) for why this syntax is
|
||||
important).
|
||||
|
||||
```
|
||||
[](/attachment/doc/image.png)
|
||||
```
|
||||
|
||||
Then, submit your image(s) in a separate pull request to the
|
||||
[qubes-attachment](https://github.com/QubesOS/qubes-attachment) repository
|
||||
using the same path and filename. This is the only permitted way to include
|
||||
images. Do not link to images on other websites.
|
||||
|
||||
## Serving the website locally
|
||||
|
||||
You can serve the website offline on your local machine by following [these
|
||||
instructions](https://github.com/QubesOS/qubesos.github.io#instructions). This
|
||||
can be useful for making sure that your changes render the way you expect,
|
||||
especially when your changes affect formatting, images, tables, styling, etc.
|
||||
|
||||
## Security
|
||||
|
||||
*Also see: [Should I trust this website?](/faq/#should-i-trust-this-website)*
|
||||
|
||||
All pull requests (PRs) against
|
||||
[qubes-doc](https://github.com/QubesOS/qubes-doc) must pass review prior to be
|
||||
merged, except in the case of [external
|
||||
documentation](/doc/#external-documentation) (see
|
||||
[#4693](https://github.com/QubesOS/qubes-issues/issues/4693)). This process is
|
||||
designed to ensure that contributed text is accurate and non-malicious. This
|
||||
process is a best effort that should provide a reasonable degree of assurance,
|
||||
but it is not foolproof. For example, all text characters are checked for ANSI
|
||||
escape sequences. However, binaries, such as images, are simply checked to
|
||||
ensure they appear or function the way they should when the website is
|
||||
rendered. They are not further analyzed in an attempt to determine whether they
|
||||
are malicious.
|
||||
|
||||
Once a pull request passes review, the reviewer should add a signed comment
|
||||
stating, "Passed review as of `<LATEST_COMMIT>`" (or similar). The
|
||||
documentation maintainer then verifies that the pull request is mechanically
|
||||
sound (no merge conflicts, broken links, ANSI escapes, etc.). If so, the
|
||||
documentation maintainer then merges the pull request, adds a PGP-signed tag to
|
||||
the latest commit (usually the merge commit), then pushes to the remote. In
|
||||
cases in which another reviewer is not required, the documentation maintainer
|
||||
may review the pull request (in which case no signed comment is necessary,
|
||||
since it would be redundant with the signed tag).
|
||||
|
||||
## Questions, problems, and improvements
|
||||
|
||||
If you have a question about something you read in the documentation or about
|
||||
how to edit the documentation, please post it on the
|
||||
[forum](https://forum.qubes-os.org/) or send it to the appropriate [mailing
|
||||
list](/support/). If you see that something in the documentation should be
|
||||
fixed or improved, please [contribute](#how-to-submit-a-pull-request) the
|
||||
change yourself. To report an issue with the documentation, please follow our
|
||||
standard [issue reporting guidelines](/doc/issue-tracking/). (If you report an
|
||||
issue with the documentation, you will likely be asked to submit a pull request
|
||||
for it, unless there is a clear indication in your report that you are not
|
||||
willing or able to do so.)
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /doc/package-contributions/
|
||||
ref: 29
|
||||
title: Package Contributions
|
||||
title: Package contributions
|
||||
---
|
||||
|
||||
_This page is for developers who wish to contribute packages.
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
---
|
||||
lang: en
|
||||
layout: doc
|
||||
permalink: /doc/style-guide/
|
||||
ref: 27
|
||||
title: Style Guide
|
||||
---
|
||||
@ -8,7 +8,7 @@ title: Usability & UX
|
||||
|
||||
Software that is too complicated to use, is often unused. Because we want as many people as possible to benefit from its unique security properties, the usability and user experience of Qubes OS is an utmost priority!
|
||||
|
||||
We ask anyone developing for Qubes OS to please read through this guide to better understand the user experience we strive to achieve. We also ask them to review [our style guide](/doc/style-guide/) for other design related information.
|
||||
We ask anyone developing for Qubes OS to please read through this guide to better understand the user experience we strive to achieve. We also ask them to review [our visual style guide](/doc/visual-style-guide/) for other design related information.
|
||||
|
||||
---
|
||||
|
||||
|
||||
9
developer/general/visual-style-guide.md
Normal file
9
developer/general/visual-style-guide.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
lang: en
|
||||
layout: doc
|
||||
permalink: /doc/visual-style-guide/
|
||||
redirect_from:
|
||||
- /doc/style-guide/
|
||||
ref: 27
|
||||
title: Visual style guide
|
||||
---
|
||||
78
developer/general/website-style-guide.md
Normal file
78
developer/general/website-style-guide.md
Normal file
@ -0,0 +1,78 @@
|
||||
---
|
||||
lang: en
|
||||
layout: doc
|
||||
permalink: /doc/website-style-guide/
|
||||
title: Website style guide
|
||||
---
|
||||
|
||||
This page explains the standards we follow for building and maintaining the
|
||||
website. Please follow these guidelines and conventions when modifying the
|
||||
website. For the standards governing the documentation in particular, please
|
||||
see the [documentation style guide](/doc/documentation-style-guide/).
|
||||
|
||||
## Coding conventions
|
||||
|
||||
The following conventions apply to the website as a whole, including everything
|
||||
written in HTML, CSS, YAML, and Liquid. These conventions are intended to keep
|
||||
the codebase consistent when multiple collaborators are working on it. They
|
||||
should be understood as a practical set of rules for maintaining order in this
|
||||
specific codebase rather than as a statement of what is objectively right or
|
||||
good.
|
||||
|
||||
### General practices
|
||||
|
||||
- Use comments to indicate the purposes of different blocks of code. This makes
|
||||
the file easier to understand and navigate.
|
||||
|
||||
- Use descriptive variable names. Never use one or two letter variable names.
|
||||
Avoid obscure abbreviations and made-up words.
|
||||
|
||||
- In general, make it easy for others to read your code. Your future self will
|
||||
thank you, and so will your collaborators!
|
||||
|
||||
- [Don't Repeat Yourself
|
||||
(DRY)!](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself) Instead of
|
||||
repeating the same block of code multiple times, abstract it out into a
|
||||
separate file and `include` that file where you need it.
|
||||
|
||||
### Whitespace
|
||||
|
||||
- Always use spaces. Never use tabs.
|
||||
|
||||
- Each indentation step should be exactly two (2) spaces.
|
||||
|
||||
- Whenever you add an opening tag, indent the following line. (Exception: If
|
||||
you open and close the tag on the same line, do not indent the following
|
||||
line.)
|
||||
|
||||
- Indent Liquid the same way as HTML.
|
||||
|
||||
- In general, the starting columns of every adjacent pair of lines should be no
|
||||
more than two spaces apart (example below).
|
||||
|
||||
- No blank or empty lines. (Hint: When you feel you need one, add a comment on
|
||||
that line instead.)
|
||||
|
||||
#### Indentation example
|
||||
|
||||
Here's an example that follows the indentation rules:
|
||||
|
||||
{% raw %}
|
||||
```html
|
||||
<table>
|
||||
<tr>
|
||||
<th title="Anchor Link"><span class="fa fa-link"></span></th>
|
||||
{% for item in secs.htmlsections[0].columns %}
|
||||
<th>{{ item.title }}</th>
|
||||
{% endfor %}
|
||||
</tr>
|
||||
{% for canary in site.data.sec-canary reversed %}
|
||||
<tr id="{{ canary.canary }}">
|
||||
<td><a href="#{{ canary.canary }}" class="fa fa-link black-icon" title="Anchor link to Qubes Canary row: Qubes Canary #{{ canary.canary }}"></a></td>
|
||||
<td>{{ canary.date }}</td>
|
||||
<td><a href="https://github.com/QubesOS/qubes-secpack/blob/master/canaries/canary-{{ canary.canary }}-{{ canary.date | date: '%Y' }}.txt">Qubes Canary #{{ canary.canary }}</a></td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
</table>
|
||||
```
|
||||
{% endraw %}
|
||||
@ -5,7 +5,7 @@ permalink: /doc/releases/1.0/release-notes/
|
||||
redirect_from:
|
||||
- /en/doc/releases/1.0/release-notes/
|
||||
ref: 18
|
||||
title: Qubes R1.0 Release Notes
|
||||
title: Qubes R1.0 release notes
|
||||
---
|
||||
|
||||
Detailed release notes in [this blog post](https://blog.invisiblethings.org/2012/09/03/introducing-qubes-10.html).
|
||||
|
||||
@ -5,7 +5,7 @@ permalink: /doc/releases/2.0/release-notes/
|
||||
redirect_from:
|
||||
- /en/doc/releases/2.0/release-notes/
|
||||
ref: 25
|
||||
title: Qubes R2.0 Release Notes
|
||||
title: Qubes R2.0 release notes
|
||||
---
|
||||
|
||||
Detailed release notes in [this blog post](https://blog.invisiblethings.org/2014/09/26/announcing-qubes-os-release-2.html)
|
||||
|
||||
@ -5,7 +5,7 @@ permalink: /doc/releases/3.0/release-notes/
|
||||
redirect_from:
|
||||
- /en/doc/releases/3.0/release-notes/
|
||||
ref: 19
|
||||
title: Qubes R3.0 Release Notes
|
||||
title: Qubes R3.0 release notes
|
||||
---
|
||||
|
||||
### Qubes R3.0 Release Notes
|
||||
|
||||
@ -5,7 +5,7 @@ permalink: /doc/releases/3.0/schedule/
|
||||
redirect_from:
|
||||
- /en/doc/releases/3.0/schedule/
|
||||
ref: 20
|
||||
title: Qubes R3.0 Release Schedule
|
||||
title: Qubes R3.0 release schedule
|
||||
---
|
||||
|
||||
| Date | Stage |
|
||||
|
||||
@ -5,7 +5,7 @@ permalink: /doc/releases/3.1/schedule/
|
||||
redirect_from:
|
||||
- /en/doc/releases/3.1/schedule/
|
||||
ref: 17
|
||||
title: Qubes R3.1 Release Schedule
|
||||
title: Qubes R3.1 release schedule
|
||||
---
|
||||
|
||||
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).
|
||||
|
||||
@ -5,7 +5,7 @@ permalink: /doc/releases/3.2/schedule/
|
||||
redirect_from:
|
||||
- /en/doc/releases/3.2/schedule/
|
||||
ref: 22
|
||||
title: Qubes R3.2 Release Schedule
|
||||
title: Qubes R3.2 release schedule
|
||||
---
|
||||
|
||||
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).
|
||||
|
||||
@ -5,7 +5,7 @@ permalink: /doc/releases/4.0/schedule/
|
||||
redirect_from:
|
||||
- /en/doc/releases/4.0/schedule/
|
||||
ref: 24
|
||||
title: Qubes R4.0 Release Schedule
|
||||
title: Qubes R4.0 release schedule
|
||||
---
|
||||
|
||||
This schedule is based on [Version Scheme](/doc/version-scheme/#release-schedule).
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /doc/releases/notes/
|
||||
ref: 13
|
||||
title: Release Notes
|
||||
title: Release notes
|
||||
---
|
||||
|
||||
* [Qubes R1.0 release notes](/doc/releases/1.0/release-notes/)
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /doc/releases/schedules/
|
||||
ref: 15
|
||||
title: Release Schedules
|
||||
title: Release schedules
|
||||
---
|
||||
|
||||
* [Qubes R3.0 release schedule](/doc/releases/3.0/schedule/)
|
||||
|
||||
@ -5,7 +5,7 @@ permalink: /doc/releases/todo/
|
||||
redirect_from:
|
||||
- /en/doc/releases/todo/
|
||||
ref: 14
|
||||
title: Release Checklist
|
||||
title: Release checklist
|
||||
---
|
||||
|
||||
*the checklist is probably unfinished*
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/VersionScheme/
|
||||
- /wiki/VersionScheme/
|
||||
ref: 151
|
||||
title: Version Scheme
|
||||
title: Version scheme
|
||||
---
|
||||
|
||||
Beginning with R3 release, we change (and formalise) the versioning scheme.
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: fullscreen
|
||||
permalink: /doc/admin-api/table/
|
||||
ref: 249
|
||||
title: Admin API Table
|
||||
title: Admin API table
|
||||
---
|
||||
|
||||
This page displays the fullscreen table from [Admin API](/doc/admin-api/).
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
- /doc/DVMimpl/
|
||||
- /wiki/DVMimpl/
|
||||
ref: 34
|
||||
title: DisposableVM Implementation
|
||||
title: Disposable implementation
|
||||
---
|
||||
|
||||
**Note: The content below applies to Qubes R3.2.**
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/Dom0SecureUpdates/
|
||||
- /wiki/Dom0SecureUpdates/
|
||||
ref: 43
|
||||
title: Dom0 Secure Updates
|
||||
title: Dom0 secure updates
|
||||
---
|
||||
|
||||
Reasons for Dom0 updates
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/Qfilecopy/
|
||||
- /wiki/Qfilecopy/
|
||||
ref: 35
|
||||
title: Inter-VM File Copying (qfilecopy)
|
||||
title: Inter-qube file copying (qfilecopy)
|
||||
---
|
||||
|
||||
There are two cases when we need a mechanism to copy files between VMs:
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/Qfileexchgd/
|
||||
- /wiki/Qfileexchgd/
|
||||
ref: 40
|
||||
title: qfileexchgd (deprecated)
|
||||
title: Qfileexchgd (deprecated)
|
||||
---
|
||||
|
||||
**This mechanism is obsolete as of Qubes Beta 1!**
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/Qmemman/
|
||||
- /wiki/Qmemman/
|
||||
ref: 41
|
||||
title: Qubes Memory Manager (qmemman)
|
||||
title: Qubes memory manager (qmemman)
|
||||
---
|
||||
|
||||
Rationale
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
- /doc/Qrexec3Implementation/
|
||||
- /wiki/Qrexec3Implementation/
|
||||
ref: 39
|
||||
title: 'Qrexec: Qubes RPC Internals'
|
||||
title: 'Qrexec: Qubes RPC internals'
|
||||
---
|
||||
|
||||
(*This page details the current implementation of qrexec (qrexec3).
|
||||
|
||||
@ -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'
|
||||
---
|
||||
|
||||
*This page describes how to implement and use new socket-backed services for qrexec. See [qrexec](/doc/qrexec/) for general overview of the qrexec framework.*
|
||||
|
||||
@ -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/).*)
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
- /doc/Qrexec2Implementation/
|
||||
- /wiki/Qrexec2Implementation/
|
||||
ref: 38
|
||||
title: qrexec v2 (deprecated)
|
||||
title: Qrexec v2 (deprecated)
|
||||
---
|
||||
|
||||
(*This page is about qrexec v2. For qrexec v3, see [here](/doc/qrexec/).*)
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /doc/audio-virtualization/
|
||||
ref: 60
|
||||
title: Audio Virtualization
|
||||
title: Audio virtualization
|
||||
---
|
||||
|
||||
VMs on Qubes OS have access to virtualized audio through the PulseAudio module.
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
- /doc/GUIdocs/
|
||||
- /wiki/GUIdocs/
|
||||
ref: 61
|
||||
title: GUI Virtualization
|
||||
title: GUI virtualization
|
||||
---
|
||||
|
||||
qubes_gui and qubes_guid processes
|
||||
|
||||
@ -4,5 +4,5 @@ layout: doc
|
||||
permalink: /doc/qubes-core-admin-client/
|
||||
redirect_to: https://dev.qubes-os.org/projects/core-admin-client/en/latest/
|
||||
ref: 245
|
||||
title: Qubes Core Admin Client
|
||||
title: Qubes core admin client
|
||||
---
|
||||
|
||||
@ -4,5 +4,5 @@ layout: doc
|
||||
permalink: /doc/qubes-core-admin/
|
||||
redirect_to: https://dev.qubes-os.org/projects/core-admin/en/latest/
|
||||
ref: 246
|
||||
title: Qubes Core Admin
|
||||
title: Qubes core admin
|
||||
---
|
||||
|
||||
@ -4,5 +4,5 @@ layout: doc
|
||||
permalink: /doc/qubes-core-stack/
|
||||
redirect_to: /news/2017/10/03/core3/
|
||||
ref: 247
|
||||
title: Qubes Core Stack
|
||||
title: Qubes core stack
|
||||
---
|
||||
|
||||
@ -8,7 +8,7 @@ redirect_from:
|
||||
- /wiki/SecurityCriticalCode/
|
||||
- /trac/wiki/SecurityCriticalCode/
|
||||
ref: 55
|
||||
title: Security-Critical Code
|
||||
title: Security-critical code
|
||||
---
|
||||
|
||||
Below is a list of security-critical (i.e., trusted) code components in Qubes OS.
|
||||
|
||||
@ -9,7 +9,7 @@ redirect_from:
|
||||
- /doc/SecurityGoals/
|
||||
- /wiki/SecurityGoals/
|
||||
ref: 210
|
||||
title: Security Design Goals
|
||||
title: Security design goals
|
||||
---
|
||||
|
||||
Qubes OS implements a security-by-isolation (or security-by-compartmentalization) approach by providing the ability to easily create many security domains. These domains are implemented as lightweight Virtual Machines (VMs) running under the Xen hypervisor. Qubes' main objective is to provide strong isolation between these domains, so that even if an attacker compromises one of the domains, the others are still safe. Qubes, however, does not attempt to provide any security isolation for applications running within the same domain. For example, a buggy web browser running in a Qubes domain could still be compromised just as easily as on a regular Linux distribution. The difference that Qubes makes is that now the attacker doesn't have access to all the software running in the other domains.
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /doc/storage-pools/
|
||||
ref: 57
|
||||
title: Storage Pools
|
||||
title: Storage pools
|
||||
---
|
||||
|
||||
Qubes OS R3.2 introduced the concept of storage drivers and pools. This feature
|
||||
|
||||
@ -9,5 +9,5 @@ redirect_from:
|
||||
redirect_to:
|
||||
- /doc/#developer-documentation
|
||||
ref: 62
|
||||
title: System Documentation
|
||||
title: System documentation
|
||||
---
|
||||
|
||||
@ -7,7 +7,7 @@ redirect_from:
|
||||
- /doc/TemplateImplementation/
|
||||
- /wiki/TemplateImplementation/
|
||||
ref: 58
|
||||
title: Template Implementation
|
||||
title: Template implementation
|
||||
---
|
||||
|
||||
Every VM has 4 block devices connected:
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/BuildingArchlinuxTemplate/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/building/building-archlinux-template.md
|
||||
ref: 116
|
||||
title: Building Archlinux Template
|
||||
title: Building Arch Linux template
|
||||
---
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/BuildingNonFedoraTemplate/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/building/building-non-fedora-template.md
|
||||
ref: 117
|
||||
title: Building Non-Fedora Template
|
||||
title: Building non-Fedora template
|
||||
---
|
||||
|
||||
@ -6,5 +6,5 @@ redirect_from:
|
||||
- /en/doc/building-whonix-template/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/building/building-whonix-template.md
|
||||
ref: 115
|
||||
title: Building Whonix Templates
|
||||
title: Building Whonix templates
|
||||
---
|
||||
|
||||
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/change-time-zone/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/change-time-zone.md
|
||||
ref: 109
|
||||
title: Changing your Time Zone
|
||||
title: Changing your time zone
|
||||
---
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/ExternalAudio/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/external-audio.md
|
||||
ref: 100
|
||||
title: External Audio
|
||||
title: External audio
|
||||
---
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/InstallNvidiaDriver/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/install-nvidia-driver.md
|
||||
ref: 96
|
||||
title: How to Install an Nvidia Driver
|
||||
title: How to install an Nvidia driver
|
||||
---
|
||||
|
||||
2
external/configuration-guides/multimedia.md
vendored
2
external/configuration-guides/multimedia.md
vendored
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/Multimedia/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/multimedia.md
|
||||
ref: 105
|
||||
title: How to Make a Multimedia TemplateVM
|
||||
title: How to make a multimedia template
|
||||
---
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/NetworkBridgeSupport/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/network-bridge-support.md
|
||||
ref: 113
|
||||
title: Network Bridge Support
|
||||
title: Network bridge support
|
||||
---
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/NetworkPrinter/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/network-printer.md
|
||||
ref: 108
|
||||
title: Network Printer
|
||||
title: Network printer
|
||||
---
|
||||
|
||||
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/tips-and-tricks/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/configuration/tips-and-tricks.md
|
||||
ref: 110
|
||||
title: Tips and Tricks
|
||||
title: Tips and tricks
|
||||
---
|
||||
|
||||
2
external/customization-guides/dark-theme.md
vendored
2
external/customization-guides/dark-theme.md
vendored
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/dark-theme/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/customization/dark-theme.md
|
||||
ref: 74
|
||||
title: Dark Theme in Dom0 and DomU
|
||||
title: Dark theme
|
||||
---
|
||||
|
||||
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /en/doc/fedora-minimal-template-customization/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/customization/fedora-minimal-template-customization.md
|
||||
ref: 76
|
||||
title: Fedora Minimal Template Customization
|
||||
title: Fedora minimal template customization
|
||||
---
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/LanguageLocalization/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/customization/language-localization.md
|
||||
ref: 73
|
||||
title: Language Localization
|
||||
title: Language localization
|
||||
---
|
||||
|
||||
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/removing-templatevm-packages/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/customization/removing-templatevm-packages.md
|
||||
ref: 75
|
||||
title: Removing TemplateVM Packages
|
||||
title: Removing template packages
|
||||
---
|
||||
|
||||
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/windows-template-customization/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/customization/windows-template-customization.md
|
||||
ref: 72
|
||||
title: Windows Template Customization
|
||||
title: Windows template customization
|
||||
---
|
||||
|
||||
2
external/os-guides/centos.md
vendored
2
external/os-guides/centos.md
vendored
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/templates/centos/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/centos.md
|
||||
ref: 81
|
||||
title: CentOS Template
|
||||
title: CentOS template
|
||||
---
|
||||
|
||||
2
external/os-guides/gentoo.md
vendored
2
external/os-guides/gentoo.md
vendored
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/templates/gentoo/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/gentoo.md
|
||||
ref: 221
|
||||
title: Gentoo Template
|
||||
title: Gentoo template
|
||||
---
|
||||
|
||||
2
external/os-guides/linux-hvm-tips.md
vendored
2
external/os-guides/linux-hvm-tips.md
vendored
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/LinuxHVMTips/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/linux-hvm-tips.md
|
||||
ref: 82
|
||||
title: Linux HVM Tips
|
||||
title: Linux HVM tips
|
||||
---
|
||||
|
||||
2
external/os-guides/netbsd.md
vendored
2
external/os-guides/netbsd.md
vendored
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/netbsd/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/netbsd.md
|
||||
ref: 84
|
||||
title: How to Create a NetBSD VM
|
||||
title: How to create a NetBSD qube
|
||||
---
|
||||
|
||||
2
external/os-guides/pentesting.md
vendored
2
external/os-guides/pentesting.md
vendored
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/pentesting/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/pentesting.md
|
||||
ref: 83
|
||||
title: Penetration Testing
|
||||
title: Penetration testing
|
||||
---
|
||||
|
||||
2
external/os-guides/pentesting/blackarch.md
vendored
2
external/os-guides/pentesting/blackarch.md
vendored
@ -6,5 +6,5 @@ redirect_from:
|
||||
- /doc/blackarch/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/pentesting/blackarch.md
|
||||
ref: 88
|
||||
title: How to Create a BlackArch VM
|
||||
title: How to create a BlackArch qube
|
||||
---
|
||||
|
||||
2
external/os-guides/pentesting/kali.md
vendored
2
external/os-guides/pentesting/kali.md
vendored
@ -6,5 +6,5 @@ redirect_from:
|
||||
- /doc/kali/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/pentesting/kali.md
|
||||
ref: 87
|
||||
title: How to create a Kali Linux VM
|
||||
title: How to create a Kali Linux qube
|
||||
---
|
||||
|
||||
2
external/os-guides/pentesting/ptf.md
vendored
2
external/os-guides/pentesting/ptf.md
vendored
@ -6,5 +6,5 @@ redirect_from:
|
||||
- /doc/ptf/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/pentesting/ptf.md
|
||||
ref: 89
|
||||
title: How to create Penetration Testers Framework (PTF) VM
|
||||
title: How to create penetration testers framework (PTF) qube
|
||||
---
|
||||
|
||||
2
external/os-guides/ubuntu.md
vendored
2
external/os-guides/ubuntu.md
vendored
@ -9,5 +9,5 @@ redirect_from:
|
||||
- /wiki/Templates/Ubuntu/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/ubuntu.md
|
||||
ref: 80
|
||||
title: Ubuntu Template
|
||||
title: Ubuntu template
|
||||
---
|
||||
|
||||
2
external/os-guides/windows/windows-tools.md
vendored
2
external/os-guides/windows/windows-tools.md
vendored
@ -14,5 +14,5 @@ redirect_from:
|
||||
- /wiki/WindowsTools/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/windows/windows-tools.md
|
||||
ref: 86
|
||||
title: Qubes Windows Tools
|
||||
title: Qubes Windows tools
|
||||
---
|
||||
|
||||
2
external/os-guides/windows/windows-vm.md
vendored
2
external/os-guides/windows/windows-vm.md
vendored
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/windows-vm/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/os/windows/windows-vm.md
|
||||
ref: 85
|
||||
title: Installing a Windows VM
|
||||
title: Installing a Windows qube
|
||||
---
|
||||
|
||||
@ -6,5 +6,5 @@ redirect_from:
|
||||
- /doc/randomizing-your-mac-address/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/privacy/anonymizing-your-mac-address.md
|
||||
ref: 67
|
||||
title: Anonymizing your MAC Address
|
||||
title: Anonymizing your MAC address
|
||||
---
|
||||
|
||||
2
external/privacy-guides/tails.md
vendored
2
external/privacy-guides/tails.md
vendored
@ -6,5 +6,5 @@ redirect_from:
|
||||
- /doc/running-tails/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/privacy/tails.md
|
||||
ref: 71
|
||||
title: Running Tails in Qubes
|
||||
title: Running Tails in qubes
|
||||
---
|
||||
|
||||
2
external/privacy-guides/whonix.md
vendored
2
external/privacy-guides/whonix.md
vendored
@ -18,5 +18,5 @@ redirect_from:
|
||||
- /doc/privacy/updating-whonix/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/privacy/whonix.md
|
||||
ref: 69
|
||||
title: Whonix for Privacy & Anonymity
|
||||
title: Whonix for privacy & anonymity
|
||||
---
|
||||
|
||||
@ -7,5 +7,5 @@ redirect_from:
|
||||
- /doc/Multi-factorAuthentication/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/security/multifactor-authentication.md
|
||||
ref: 78
|
||||
title: Multifactor Authentication
|
||||
title: Multifactor authentication
|
||||
---
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/SecurityGuidelines/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/security/security-guidelines.md
|
||||
ref: 79
|
||||
title: Security Guidelines
|
||||
title: Security guidelines
|
||||
---
|
||||
|
||||
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/application-troubleshooting/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/application-troubleshooting.md
|
||||
ref: 236
|
||||
title: Application Troubleshooting
|
||||
title: Application troubleshooting
|
||||
---
|
||||
|
||||
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/intel-igfx-troubleshooting/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/intel-igfx-troubleshooting.md
|
||||
ref: 90
|
||||
title: Intel Integrated Graphics Troubleshooting
|
||||
title: Intel integrated graphics troubleshooting
|
||||
---
|
||||
|
||||
@ -3,5 +3,5 @@ lang: en
|
||||
layout: doc
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/macbook-troubleshooting.md
|
||||
ref: 238
|
||||
title: Apple MacBook Troubleshooting
|
||||
title: Apple MacBook troubleshooting
|
||||
---
|
||||
|
||||
@ -6,5 +6,5 @@ redirect_from:
|
||||
- /wiki/NvidiaTroubleshooting/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/nvidia-troubleshooting.md
|
||||
ref: 91
|
||||
title: Nvidia Troubleshooting
|
||||
title: Nvidia troubleshooting
|
||||
---
|
||||
|
||||
@ -8,5 +8,5 @@ redirect_from:
|
||||
- /wiki/SonyVaioTinkering/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/sony-vaio-tinkering.md
|
||||
ref: 93
|
||||
title: Sony Vaio Tinkering
|
||||
title: Sony Vaio tinkering
|
||||
---
|
||||
|
||||
@ -5,5 +5,5 @@ redirect_from:
|
||||
- /doc/tails-troubleshooting/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/tails-troubleshooting.md
|
||||
ref: 237
|
||||
title: Tails Troubleshooting
|
||||
title: Tails troubleshooting
|
||||
---
|
||||
|
||||
@ -13,5 +13,5 @@ redirect_from:
|
||||
- /wiki/Lenovo450Tinkering/
|
||||
redirect_to: https://github.com/Qubes-Community/Contents/blob/master/docs/troubleshooting/thinkpad-troubleshooting.md
|
||||
ref: 95
|
||||
title: Lenovo ThinkPad Troubleshooting
|
||||
title: Lenovo ThinkPad troubleshooting
|
||||
---
|
||||
|
||||
@ -3,7 +3,7 @@ lang: en
|
||||
layout: doc
|
||||
permalink: /code-of-conduct/
|
||||
ref: 118
|
||||
title: Code of Conduct
|
||||
title: Code of conduct
|
||||
---
|
||||
|
||||
## Introduction
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user