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
cfa5880828
qubes-doc/DocStyle.md
Marek Marczykowski-Górecki eea0bf57af
Merge remote-tracking branch 'origin/pr/42' 
* origin/pr/42:
  all wiki trac {% highlight trac-wiki %}{% endhighlight %} replaced with the ``` used for markdown code
  Added link to R3 template for Archlinux.md and added IPPolicy explanation to Ubuntu.md. Linked both files to UserDoc.md
  DocStyle description added rules for headings
  just reverted (deleted) a former change
  added a page ResizeRootDiskImage.md and removed the external link
  Qubes OS 3.0 rc3 release added to wikistart
  added description of QvmFirewall rule
2015-09-20 05:34:22 +02:00

1.7 KiB
Raw Blame History

layout title permalink redirect_from
doc DocStyle /doc/DocStyle/ /wiki/DocStyle/

Guidelines for Documentation Contributors

  • 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 [reference-style][ref] links.
    [ref]: http://daringfireball.net/projects/markdown/syntax#link
  • Use underline headings ===== and ----- if possible. If this is not possible use the Atx-style headings on the left side, e. g. ### H3.

Sending documentation updates

Main documentation repository is qubes-doc on QubesOS github account. If you want to add something there, clone that repository commit the changes and send us patches using either github pull requests or plain email sent to qubes-devel mailing list.

If you have a github account (its free!), you can simply browse qubes-doc repository and edit the files there! Github interface will automatically guide you through fork & pull request creation process.