Commit 6f79af74 authored by Tails developers's avatar Tails developers

Improve how to contribute documentation

parent 8b5c8dd7
......@@ -8,18 +8,29 @@
</div>
# Reporting errors
We do value documentation very much, but it's difficult to keep it
up-to-date. If you find a typo or an error in the documentation please
do let us know — ideally, by submitting a patch with your fix.
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 easiest documentation tasks may be found by looking at
documentation section on the [[!tails_todo "" desc="TODO"]] list (items tagged `todo/documentation`). Small fixes and
enhancements are greatly welcome, and can be done by [[sending
us|contribute/talk]] Git patches, or by publishing a [[Git]] branch.
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:
- Some documentation tasks can be found in the documentation section
on the [[!tails_todo "" desc="TODO"]] list (items tagged
`todo/documentation`). 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 us|contribute/talk]]
Git patches, by publishing a [[Git]] branch, or simply by email on
the public mailing list.
Documentation writers coordinate themselves using our usual
[[development communication channels|contribute/talk]].
......@@ -27,8 +38,9 @@ Documentation writers coordinate themselves using our usual
Documentation writers should also read our [[documentation
guidelines|guidelines]].
You may want to check your contributions before to publish them.
For that, you can [[build and update the documentation offline|contribute/build/website]].
If you want to test your contributions before to sharing them with us,
you can [[build and update the documentation
offline|contribute/build/website]].
# Translating
......
[[!meta title="Documentation"]]
This documentation is a work in progress and a collective task. If you think it
lacks documentation on a specific topic you can suggest us to complete it or try
to write it yourself and share it with us.
This documentation is a work in progress and a collective task.
Read about how you can help [[improving Tails
documentation|/contribute/how/documentation]].
- [[Introduction to this documentation|introduction]]
......
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