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-11-29 22:55:20 +01:00
basics Update intro and wrap lines 2015-11-08 01:46:07 +00:00
common-tasks Fix typo 2015-11-20 07:26:28 +00:00
configuration mgmt-salt: add links to documentation, typo fix 2015-11-29 15:14:16 +01:00
customization Remove en/ from URLs (QubesOS/qubes-issues#1333) 2015-10-28 22:14:40 +00:00
developers development-workflow: add script for inter-VM git and packages copy 2015-11-24 03:12:51 +01:00
hardware Remove en/ from URLs (QubesOS/qubes-issues#1333) 2015-10-28 22:14:40 +00:00
installing R3.1 release notes and upgrade instruction 2015-11-29 22:55:20 +01:00
managing-os Fedora 21->22: minor improvements 2015-11-14 16:22:46 +01:00
reference Remove en/ from URLs (QubesOS/qubes-issues#1333) 2015-10-28 22:14:40 +00:00
releases R3.1 release notes and upgrade instruction 2015-11-29 22:55:20 +01:00
security Fixed broken link 2015-11-05 14:16:32 +01:00
troubleshooting Merge pull request #50 from b4dger/patch-2 2015-10-30 06:00:09 +00:00
unsorted Remove en/ from URLs (QubesOS/qubes-issues#1333) 2015-10-28 22:14:40 +00:00
doc.md Add salt mgmt stack to documentation index 2015-11-29 15:00:54 +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