summaryrefslogtreecommitdiffstats
path: root/wiki/src/contribute/how/documentation.mdwn
blob: 6bf40ae215e30e65167cbbc2886c55e963f55e15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
[[!meta title="Improve Tails documentation"]]

<div id="intro">

<p>Tails documentation would greatly benefit from your help.</p>

[[!toc levels=1]]

</div>

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

The documentation on the website is not freely editable. The way we
document things has serious security implications. People should be able
to trust the Tails website as much as they trust Tails itself.
Furthermore, every change in the documentation possibly breaks the
translations that were made of the previous version.

But there are still many ways you can start contributing:

  - We maintain a list of [documentation
    tasks](https://labs.riseup.net/code/projects/tails/issues?query_id=172).
    You can start writing a draft in the corresponding ticket and then
    [[ask us for review|contribute/talk]].

  - Small fixes and enhancements to the current documentation are
    greatly welcome. This can be done by sending Git patches to [[the
    tails-dev mailing list|contribute/talk]] or by publishing a
    [[Git]] branch (for example to a fork on
    [GitLab](https://gitlab.com/Tails/tails)). In general,
    documentation changes should be based on the `master` branch.

Documentation writers coordinate themselves using our usual
[[development communication channels|contribute/talk]].

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.

# 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.

# Talk to us

[[!inline pages="contribute/talk" raw="yes"]]