All Qubes OS Project documentation pages are 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.
Go to file
2015-12-13 00:29:33 +00:00
basics moved Getting Started & Research to site repo QubesOS/qubes-issues#1460 2015-12-04 16:29:22 +01:00
common-tasks Fix typo 2015-11-20 07:26:28 +00:00
configuration fixed broken /en/ links 2015-12-09 16:29:45 +00:00
customization Remove en/ from URLs (QubesOS/qubes-issues#1333) 2015-10-28 22:14:40 +00:00
developers moved Getting Started & Research to site repo QubesOS/qubes-issues#1460 2015-12-04 16:29:22 +01:00
hardware use Qubes + Purism image 2015-12-10 03:59:34 +01:00
installing Mark R3.0->R3.1 upgrade as experimental. 2015-12-11 16:46:12 +01:00
managing-os simplify shutdown step 2015-12-11 20:00:03 +00:00
privacy Merge remote-tracking branch 'origin/pr/76' 2015-12-10 02:47:56 +01:00
reference Remove en/ from URLs (QubesOS/qubes-issues#1333) 2015-10-28 22:14:40 +00:00
releases r3.1: minor fix 2015-12-09 20:34:13 +01:00
security Merge pull request #80 from adrelanos/patch-22 2015-12-10 05:01:46 +00:00
troubleshooting fixed broken /en/ links 2015-12-09 16:29:45 +00:00
unsorted Remove en/ from URLs (QubesOS/qubes-issues#1333) 2015-10-28 22:14:40 +00:00
doc.md Add link to "Adding SSD storage cache" message 2015-12-12 23:07:01 +01:00
README.md Update README 2015-11-08 01:05:45 +00:00

Qubes OS Documentation

Canonical URL: https://www.qubes-os.org/doc/

All Qubes OS Project documentation pages are 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. Contributions to the documentation (both new content and edits of existing content) are welcome. To contribute, please fork and clone this repo, make your changes, then either submit a pull request or send a patch to the qubes-devel mailing list. If you have a GitHub account (free), you can simply browse this repository and edit the files here. The GitHub interface will automatically guide you through the fork and pull request process.

Markdown Conventions

All the documentation is written in Markdown for maximum accessibility. When making contributions, please observe the following style conventions:

  • Use spaces instead of tabs.
  • Hard wrap Markdown lines at 80 characters.
  • Hard wrap Git commit message lines at 72 characters.
    • This leaves exactly four spaces on each side of the commit message when viewed in the default git log format.)
  • If appropriate, make numerals in numbered lists match between Markdown source and HTML output.
    • 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.
  • Use hanging indentations
    where appropriate.
  • Use underline headings (===== and -----) if possible. If this is not possible, use Atx-style headings on both the left and right sides (### H3 ###).
  • Use [reference-style][ref] links.

[ref]: http://daringfireball.net/projects/markdown/syntax#link