summaryrefslogtreecommitdiffstats
path: root/wiki/src/contribute/how
diff options
context:
space:
mode:
Diffstat (limited to 'wiki/src/contribute/how')
-rw-r--r--wiki/src/contribute/how/documentation.mdwn26
-rw-r--r--wiki/src/contribute/how/documentation/release_notes.mdwn2
-rw-r--r--wiki/src/contribute/how/documentation/release_notes/template.mdwn6
-rw-r--r--wiki/src/contribute/how/sysadmin.mdwn9
-rw-r--r--wiki/src/contribute/how/translate/team/it.mdwn4
-rw-r--r--wiki/src/contribute/how/translate/with_Transifex.mdwn16
6 files changed, 46 insertions, 17 deletions
diff --git a/wiki/src/contribute/how/documentation.mdwn b/wiki/src/contribute/how/documentation.mdwn
index a332a4c..1be1b47 100644
--- a/wiki/src/contribute/how/documentation.mdwn
+++ b/wiki/src/contribute/how/documentation.mdwn
@@ -50,6 +50,32 @@ before sharing them with us.
# Tools
+## Find documentation pages impacted by changes in Tails
+
+The `bin/doc-impacted-by` tool takes two "states" (see its `--help`)
+of Tails, and checks the changes between these states against a
+database of relationship between documentation pages and the source
+files and packages impacting them.
+
+The relationships between documentation and source files are stored in
+`doc-source-relationships.yml` in the Git root. It's YAML, and the
+format is something like this:
+
+- The `pages` field is mandatory (after all, we want to find the
+ documentation *pages* that might need to be updated). The remaining
+ fields list source files and packages impacting these pages.
+
+- All fields are interchangeable between the single and plural forms
+ (e.g. `page` is the same as `pages`). Similarly, the values can be
+ either strings, or a lists of strings.
+
+- All string values can use globs and pathspec magic features like
+ `{foo,bar}`.
+
+To use this tools, please first install the dependencies:
+
+ apt install ruby ruby-deep-merge ruby-git ruby-test-unit
+
<a id="compress-image"></a>
## Image compression
diff --git a/wiki/src/contribute/how/documentation/release_notes.mdwn b/wiki/src/contribute/how/documentation/release_notes.mdwn
index 481a3e7..e17055b 100644
--- a/wiki/src/contribute/how/documentation/release_notes.mdwn
+++ b/wiki/src/contribute/how/documentation/release_notes.mdwn
@@ -20,7 +20,7 @@
- Read the Changelog of other updated software (Tor etc.) to find relevant highlights
- Tor: <https://blog.torproject.org/>
- Tor: <https://gitweb.torproject.org/tor.git/tree/ChangeLog>
- - Tor Browser: <https://gitweb.torproject.org/builders/tor-browser-bundle.git/tree/Bundle-Data/Docs/ChangeLog.txt?h=maint-6.5>
+ - Tor Browser: <https://gitweb.torproject.org/builders/tor-browser-bundle.git/tree/Bundle-Data/Docs/ChangeLog.txt?h=maint-7.0>
- Firefox: <https://www.mozilla.org/en-US/firefox/52.0/releasenotes/>
- Thunderbird: <https://www.mozilla.org/en-US/thunderbird/notes/>
- Electrum: <https://github.com/spesmilo/electrum/blob/master/RELEASE-NOTES>
diff --git a/wiki/src/contribute/how/documentation/release_notes/template.mdwn b/wiki/src/contribute/how/documentation/release_notes/template.mdwn
index f15f03a..1ae07a0 100644
--- a/wiki/src/contribute/how/documentation/release_notes/template.mdwn
+++ b/wiki/src/contribute/how/documentation/release_notes/template.mdwn
@@ -1,4 +1,4 @@
-[[!meta date="Tue $MONTH $DAY 12:34:56 $YEAR"]]
+[[!meta date="Tue, $DAY $MONTH $YEAR 12:34:56 +0000"]]
[[!meta title="Tails $VERSION is out"]]
[[!tag announce]]
@@ -32,7 +32,7 @@ See the list of [[long-standing issues|support/known_issues]].
- To upgrade, automatic upgrades are available from $VERSION-2 and $VERSION-1 to $VERSION.
- XXX: Check which IUK will be available with `git grep -l "to_${VERSION}\.iuk"` wiki/src/upgrade/v1/Tails/
+ XXX: Check which IUK will be available with `git grep -l "to_${VERSION}\.iuk" wiki/src/upgrade/v1/Tails/`
If you cannot do an automatic upgrade or if you fail to start after an
automatic upgrade, please try to do a [[manual upgrade|upgrade]].
@@ -46,5 +46,5 @@ Tails $VERSION+1 is [[scheduled|contribute/calendar]] for $MONTH $DAY.
Have a look at our [[!tails_roadmap]] to see where we are heading to.
We need your help and there are many ways to [[contribute to
-Tails|contribute]] ([[donating|donate#$VERSION]] is only one of
+Tails|contribute]] (<a href="https://tails.boum.org/donate?r=$VERSION">donating</a> is only one of
them). Come [[talk to us|about/contact#tails-dev]]!
diff --git a/wiki/src/contribute/how/sysadmin.mdwn b/wiki/src/contribute/how/sysadmin.mdwn
index 3872465..663064c 100644
--- a/wiki/src/contribute/how/sysadmin.mdwn
+++ b/wiki/src/contribute/how/sysadmin.mdwn
@@ -11,9 +11,10 @@ Welcome aboard! Please read-on.</p>
# Read this first
-First of all, please read the [[goals and
-principles|contribute/working_together/roles/sysadmins#goals]] of the
-Tails system administration team.
+First of all, please read about the
+[[goals|contribute/working_together/roles/sysadmins#goals]]
+and [[principles|contribute/working_together/roles/sysadmins#principles]]
+of the Tails system administration team.
# Skills needed
@@ -103,6 +104,8 @@ To solve a problem with Puppet, you need to:
* Or, create a new Puppet module. But first, try to find an existing
module that can be adapted to our needs.
+See the [[Puppet modules|contribute/git#puppet-modules]] we already use.
+
Many Puppet modules can be found in the [shared Puppet
modules](https://labs.riseup.net/code/projects/sharedpuppetmodules),
the [Puppet Forge](https://forge.puppetlabs.com/), and on GitHub.
diff --git a/wiki/src/contribute/how/translate/team/it.mdwn b/wiki/src/contribute/how/translate/team/it.mdwn
index f32671d..f8a261a 100644
--- a/wiki/src/contribute/how/translate/team/it.mdwn
+++ b/wiki/src/contribute/how/translate/team/it.mdwn
@@ -13,13 +13,13 @@
We have three main communication channels:
-* Our wiki (https://tails.boum.org/blueprint/l10n_Italian/), to share guides and tools and to keep trace of who is doing what;
+* Our [[wiki|blueprint/l10n_Italian]], to share guides and tools and to keep trace of who is doing what;
* Online assemblies, to discuss about how translations and reviews are going;
* A [mailing list](https://www.autistici.org/mailman/listinfo/transitails) (<transitails@inventati.org>), to plan assemblies and for other day by day communications.
We discuss together which files should have the priority, then each translator makes a branch with a group of files s/he wants to translate. When the translations are ready, they are reviewed by another member of the team and then merged.
-We use Poedit (https://poedit.net/) for the translations.
+We use [Poedit](https://poedit.net/) for the translations.
If you want to contribute, please contact us first through the mailing list. We kindly ask not to start translating files on your own before contacting the team, as we prefer to discuss things together and have a consensus before starting to work.
diff --git a/wiki/src/contribute/how/translate/with_Transifex.mdwn b/wiki/src/contribute/how/translate/with_Transifex.mdwn
index cb65620..9cfacdf 100644
--- a/wiki/src/contribute/how/translate/with_Transifex.mdwn
+++ b/wiki/src/contribute/how/translate/with_Transifex.mdwn
@@ -1,17 +1,17 @@
[[!meta title="Translate Tails using Transifex"]]
Most of Tails can be translated directly online, through a simple web interface,
-after logging in with [Transifex](http://transifex.com/).
+after logging in with [Transifex](https://www.transifex.com/).
- [Tails
- Greeter](https://www.transifex.com/projects/p/torproject/resource/3-tails-tails-greeter-pot/)
+ Greeter](https://www.transifex.com/otf/torproject/tails-tails-greeter-2pot/)
- [Tails Persistence
- Setup](https://www.transifex.com/projects/p/torproject/resource/3-tails-tails-persistence-setup-pot/)
-- [Tails Installer](https://www.transifex.com/projects/p/torproject/resource/3-tails-liveusb-creator-pot/)
-- [Tails Upgrader](https://www.transifex.com/projects/p/torproject/resource/tails-tails-iukpot/)
-- [Tails Perl library](https://www.transifex.com/projects/p/torproject/resource/tails-tails-perl5libpot/)
-- [WhisperBack](https://www.transifex.com/projects/p/torproject/resource/3-whisperback-whisperback-pot/)
-- [A set of various translatable strings](https://www.transifex.com/projects/p/torproject/resource/tails-misc/)
+ Setup](https://www.transifex.com/otf/torproject/3-tails-tails-persistence-setup-pot/)
+- [Tails Installer](https://www.transifex.com/otf/torproject/3-tails-liveusb-creator-pot/)
+- [Tails Upgrader](https://www.transifex.com/otf/torproject/tails-tails-iukpot/)
+- [Tails Perl library](https://www.transifex.com/otf/torproject/tails-tails-perl5libpot/)
+- [WhisperBack](https://www.transifex.com/otf/torproject/3-whisperback-whisperback-pot/)
+- [A set of various translatable strings](https://www.transifex.com/otf/torproject/tails-misc/)
In order to get started with using Transifex, [you can watch their
introductory video](https://www.youtube.com/watch?v=3y0x8q3Oj7Q).