Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-02-24 00:39:53 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source 
Remove information about contributing and instead refer readers to the
Documentation Guidelines. This will help to avoid future desynchronization
issues.
This commit is contained in:
Axon 2016-03-22 22:38:54 +00:00
parent 160a5f24c0
commit dd3d64c956
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 7 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -3,47 +3,15 @@ Qubes OS Documentation
Canonical URL: https://www.qubes-os.org/doc/
All [Qubes OS Project][qubes] documentation pages are stored as plain text
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][gh-fork] this repo,
make your changes, then either [submit a pull request][gh-pull] or
[send a patch][patch] to the `qubes-devel` [mailing list][lists]. 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][gh-fork].
Qubes documentation rather than relying solely on the Web.
For more information about the documentation, including how to contribute,
please see the [Documentation Guidelines].
Markdown Conventions
--------------------
[Qubes OS Project]]: https://github.com/QubesOS
[documentation guidelines]: https://www.qubes-os.org/doc/doc-guidelines/
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`
[qubes]: https://github.com/QubesOS
[gh-fork]: https://guides.github.com/activities/forking/
[gh-pull]: https://help.github.com/articles/using-pull-requests/
[patch]: https://www.qubes-os.org/doc/source-code/#sending-a-patch
[lists]: https://www.qubes-os.org/doc/mailing-lists/