Commit 2ed9af98 authored by sajolida's avatar sajolida
Browse files

Merge remote-tracking branch 'cbrownstein/contrib/10225-publish-writing-style-guide'

parents d21d406e ffbfc934
......@@ -4,7 +4,7 @@
<p>Tails documentation would greatly benefit from your help.</p>
[[!toc levels=1]]
[[!toc levels=2]]
</div>
......@@ -12,7 +12,7 @@ Good documentation is difficult to keep up-to-date. If you find a typo
or an error in the documentation please let us know — ideally, by
submitting a patch with your correction.
# Writing
# Find a task
The documentation on the website is not freely editable. The way we
document things has serious security implications. People should be able
......@@ -34,20 +34,16 @@ But there are still many ways you can start contributing:
[GitLab](https://gitlab.com/Tails/tails)). In general,
documentation changes should be based on the `master` branch.
Documentation writers coordinate themselves on [[tails-dev@boum.org
mailing list|about/contact#tails-dev]], our development mailing list.
Documentation writers should also read our [[documentation
guidelines|guidelines]].
New documentation should be wrapped to 80 characters; however, please
do not submit patches that merely re-wrap existing text, as this makes
it harder to read the git history.
We recommend you to [[build an offline version of the
documentation|contribute/build/website]] to test your contributions
before sharing them with us.
# Guidelines and style
- [[Documentation guidelines|guidelines]]
- [[Documentation style guide|style_guide]]
- [[Checklist for writing release notes|release_notes]]
# Tools
## Find documentation pages impacted by changes in Tails
......@@ -72,7 +68,7 @@ format is something like this:
- All string values can use globs and pathspec magic features like
`{foo,bar}`.
To use this tools, please first install the dependencies:
To use these tools, please first install the dependencies:
apt install ruby ruby-deep-merge ruby-git ruby-test-unit
......@@ -102,16 +98,9 @@ To use this tools, please first install the dependencies:
QR-Code:https://tails.boum.org/
# Translating
We want Tails [[end-user documentation|doc]] to be translated in
as many languages as possible. See the [[guidelines for
translators|contribute/how/translate]] for details.
# Related pages
- [[Documentation guidelines|guidelines]]
- [[Checklist for release notes|release_notes]]
- [[Translating Tails|contribute/how/translate]]
# Talk to us
......
......@@ -136,8 +136,8 @@ using <span class="application">OpenPGP Applet</span>.</p>
<a id="screenshot"></a>
About screenshots
=================
Screenshots
===========
We limit the number of screenshots in the documentation to the minimum.
The GNOME Documentation Style Guide explains very well the
......@@ -173,6 +173,13 @@ Ikiwiki shortcuts
The `\[[!wikipedia ..]]` strings you can find in some files are ikiwiki [[shortcuts]].
You might also need to understand [[ikiwiki directives|ikiwiki/directive]].
Wrap to 80 characters but only when needed
==========================================
New documentation should be wrapped to 80 characters. However, please do
not submit patches that merely re-wrap existing text, as this makes it
harder to read the Git history.
Related online resources
========================
......
[[!meta title="Documentation style guide"]]
- **bulleted lists**
Refer to this article from NN/g on [presenting bulleted
lists](https://www.nngroup.com/articles/presenting-bulleted-lists/).
- **Debian and Ubuntu version**
- **Debian and Ubuntu versions**
Refer to Debian versions primarily by their number, and additionally
by their codename.
Refer to Debian and Ubuntu versions primarily by their numbers, and additionally
by their codenames.
* *For example*:
- Tails 3.0 is based on Debian 9 (Stretch)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment