Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-10-01 01:25:40 -04:00
Code Issues Packages Projects Releases Wiki Activity
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.
1,923 Commits 6 Branches 2,523 Tags 86 MiB
Makefile 51.8%
Python 48.2%
3a11eacb64
Go to file
Axon 3a11eacb64
Update supported-versions.md 
* Add downloads link
* Remove R3.2 line
* Format table source
2016-02-02 19:23:49 +00:00
basics Correction in faq about reassigning PCI device to dom0 2016-01-22 23:35:04 -06:00
common-tasks Reorganize USB-related information 2016-01-28 12:02:39 +00:00
configuration Move and rename Salt page 2016-01-28 10:12:57 +00:00
customization Fix a few typos 2016-01-10 18:41:30 -05:00
developers Add ilustrated documentation contribution guide 2016-01-29 13:40:00 +01:00
hardware fixed typo 2015-12-17 18:16:38 -05:00
installing Merge pull request #92 from dan-mi-sun/patch-1 2016-01-24 10:04:01 +00:00
managing-os Change qrexec-timeout references to qrexec_timeout 2016-02-02 15:32:14 +08:00
privacy Merge pull request #98 from mvermaes/patch-1 2016-02-02 19:02:39 +00:00
reference Fix a few typos 2016-01-10 18:41:30 -05:00
releases Update supported-versions.md 2016-02-02 19:23:49 +00:00
security Reorganize USB-related information 2016-01-28 12:02:39 +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 Reorganize USB-related information 2016-01-28 12:02:39 +00:00
README.md Update README 2015-11-08 01:05:45 +00:00

README.md

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