summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsajolida <sajolida@pimienta.org>2015-10-13 10:47:27 +0000
committersajolida <sajolida@pimienta.org>2015-10-13 10:47:27 +0000
commit437b6b81ad2537a3d5988e5433d1777fb786944c (patch)
treeb46a2617c40b40142ae5aa758ff32309b45617bb
parentd67cc56d28ffa8c5e77eca3ae4eb16ec5b48b91f (diff)
parent334adaec8a7b9ef944c39ae35e740e8188f10b05 (diff)
Merge branch 'doc/9018-build-website-in-tails' (Closes: #9018)
-rwxr-xr-xauto/build2
-rwxr-xr-xbuild-website (renamed from build-wiki)0
-rwxr-xr-xvagrant/provision/assets/build-tails2
-rw-r--r--wiki/src/contribute.mdwn2
-rw-r--r--wiki/src/contribute/build/website.mdwn86
-rw-r--r--wiki/src/contribute/build/website/languages.inline.mdwn5
-rw-r--r--wiki/src/contribute/build/website/src.inline.mdwn4
-rw-r--r--wiki/src/contribute/git.mdwn2
-rw-r--r--wiki/src/contribute/how/code.mdwn2
-rw-r--r--wiki/src/contribute/how/translate/team/fr.mdwn2
-rw-r--r--wiki/src/contribute/how/translate/with_Git.mdwn2
-rw-r--r--wiki/src/contribute/l10n_tricks.mdwn8
-rw-r--r--wiki/src/contribute/release_process.mdwn6
-rw-r--r--wiki/src/doc/first_steps/persistence/configure.mdwn11
14 files changed, 98 insertions, 36 deletions
diff --git a/auto/build b/auto/build
index 390ef3c..d464959 100755
--- a/auto/build
+++ b/auto/build
@@ -128,7 +128,7 @@ if [ -n "$JENKINS_URL" ] && [ -z "$GIT_TAG" ] \
fi
# build the doc wiki
-./build-wiki
+./build-website
# refresh translations of our programs
./refresh-translations || fatal "refresh-translations failed ($?)."
diff --git a/build-wiki b/build-website
index bb1590b..bb1590b 100755
--- a/build-wiki
+++ b/build-website
diff --git a/vagrant/provision/assets/build-tails b/vagrant/provision/assets/build-tails
index cc1c37d..5ff9425 100755
--- a/vagrant/provision/assets/build-tails
+++ b/vagrant/provision/assets/build-tails
@@ -83,7 +83,7 @@ if [ "$TAILS_CLEAN_BUILD" ]; then
fi
if [ -z "$JENKINS_URL" ]; then
- ./build-wiki
+ ./build-website
fi
BUILD_DIR=$(mktemp -d /tmp/tails-build.XXXXXXXX)
diff --git a/wiki/src/contribute.mdwn b/wiki/src/contribute.mdwn
index 6b7b0e3..2c6a352 100644
--- a/wiki/src/contribute.mdwn
+++ b/wiki/src/contribute.mdwn
@@ -135,7 +135,7 @@ Tools for contributors
- [Tasks](https://labs.riseup.net/code/projects/tails/issues)
can be filtered by type of work (see links in the sidebar)
- [[Building a Tails image|contribute/build]]
- - [[Build the website|contribute/build/website]]
+ - [[Build a local copy of the website|contribute/build/website]]
- [[Customize Tails|contribute/customize]]
- [[Debian package builder|contribute/Debian_package_builder]], to automatically build our custom packages
- [[APT repository|contribute/APT_repository]], to store our custom Debian packages
diff --git a/wiki/src/contribute/build/website.mdwn b/wiki/src/contribute/build/website.mdwn
index ad3d5f3..80eeba6 100644
--- a/wiki/src/contribute/build/website.mdwn
+++ b/wiki/src/contribute/build/website.mdwn
@@ -1,34 +1,82 @@
-[[!meta title="Build the wiki offline"]]
+[[!meta title="Build a local copy of the website"]]
-Here is how to build the wiki offline.
+The website [[https://tails.boum.org/]] is built using
+[Ikiwiki](https://ikiwiki.info) from source code that is available in
+our main Git repository, along with the rest of the Tails code.
-<div class="bug">
+You can build a local copy of the website on your computer. Building the
+website produces a set a HTML pages stored on your system that you can
+open in your usual web browser even while working offline. Doing so is
+useful for documentation writers and translators to see how their
+changes will apply on the website.
-<p>The following instructions don't work as such in Tails. See
-[[!tails_ticket 9018]] for a possible solution.</p>
+[[!toc]]
-</div>
+Build the website in Linux
+==========================
-If you have not done it before, update the list of packages known to Tails:
+1. Update the list of available packages:
- sudo apt-get update
+ sudo apt-get update
-Then install the dependencies:
+2. Install the required packages:
- sudo apt-get install libyaml-perl libyaml-libyaml-perl po4a \
- perlmagick libyaml-syck-perl ikiwiki
+ sudo apt-get install libyaml-perl libyaml-libyaml-perl po4a \
+ perlmagick libyaml-syck-perl ikiwiki
-Clone our main [[Git repository|git]]:
+3. Clone our main [[Git repository|git]]:
- git clone https://git-tails.immerda.ch/tails
+ git clone https://git-tails.immerda.ch/tails
-Then run the following command, at the root of the Git folder:
+[[!inline pages="contribute/build/website/src.inline" raw="yes"]]
- ./build-wiki
+4. Build the website:
-You can now browse the files in
+ cd tails
+ ./build-website
- ./config/chroot_local-includes/usr/share/doc/tails/website/
+[[!inline pages="contribute/build/website/languages.inline" raw="yes"]]
-To accelerate the build, you can disable some languages by editing the
-parameter `po_slave_languages` in ikiwiki.setup.
+5. You can now browse your local copy of the website in the following folder:
+
+ <span class="filename">config/chroot_local-includes/usr/share/doc/tails/website/</span>
+
+<a id="tails"></a>
+
+Build the website in Tails
+==========================
+
+1. [[Create and configure|doc/first_steps/persistence/configure]] a persistent volume and activate the following features:
+
+ - Personal Data
+ - APT Packages
+ - APT Lists
+
+2. Restart Tails, [[enable the persistence|doc/first_steps/persistence/use]], and [[set up an administration password|doc/first_steps/startup_options/administration_password]].
+
+3. Update the list of available packages:
+
+ sudo apt-get update
+
+4. Install the required packages:
+
+ sudo apt-get install libyaml-perl libyaml-libyaml-perl po4a \
+ perlmagick libyaml-syck-perl ikiwiki
+
+5. Clone our main [[Git repository|git]] in the <span class="filename">Persistent</span> folder:
+
+ cd ~/Persistent/
+ git clone https://git-tails.immerda.ch/tails
+
+[[!inline pages="contribute/build/website/src.inline" raw="yes"]]
+
+6. Build the website:
+
+ cd tails
+ ./build-website --set destdir="/home/amnesia/Persistent/Tor Browser/tails" "$@"
+
+[[!inline pages="contribute/build/website/languages.inline" raw="yes"]]
+
+7. You can now visit the following link in <span class="application">Tor Browser</span> to browse your local copy of the website:
+
+ [[file:///home/amnesia/Persistent/Tor Browser/tails/index.en.html]]
diff --git a/wiki/src/contribute/build/website/languages.inline.mdwn b/wiki/src/contribute/build/website/languages.inline.mdwn
new file mode 100644
index 0000000..4c410e2
--- /dev/null
+++ b/wiki/src/contribute/build/website/languages.inline.mdwn
@@ -0,0 +1,5 @@
+ <div class="tip">
+ <p>To accelerate the build, you can disable some languages by editing
+ the <span class="code">po_slave_languages</span> parameter in the file
+ <span class="filename">ikiwiki.setup</span>.</p>
+ </div>
diff --git a/wiki/src/contribute/build/website/src.inline.mdwn b/wiki/src/contribute/build/website/src.inline.mdwn
new file mode 100644
index 0000000..80981dd
--- /dev/null
+++ b/wiki/src/contribute/build/website/src.inline.mdwn
@@ -0,0 +1,4 @@
+ <div class="tip">
+ <p>The source code of the website is located in the
+ <span class="filename">wiki/src/</span> folder.</p>
+ </div>
diff --git a/wiki/src/contribute/git.mdwn b/wiki/src/contribute/git.mdwn
index fd1d39d..c5547aa 100644
--- a/wiki/src/contribute/git.mdwn
+++ b/wiki/src/contribute/git.mdwn
@@ -75,7 +75,7 @@ Repositories
Main repository
---------------
-This repository contains the Tails source code and the wiki source.
+This repository contains the Tails source code and the source of the website.
Anyone can check it out like this:
diff --git a/wiki/src/contribute/how/code.mdwn b/wiki/src/contribute/how/code.mdwn
index 3367a46..32f30a3 100644
--- a/wiki/src/contribute/how/code.mdwn
+++ b/wiki/src/contribute/how/code.mdwn
@@ -98,7 +98,7 @@ So you know what bug you want to fix, what feature you want to
implement. At this point, we advise you to:
1. **Gather results of previous research and discussions** on the
- topic you are interested in. Search this wiki, [[!tails_redmine ""
+ topic you are interested in. Search this website, [[!tails_redmine ""
desc="tickets on Redmine"]] and the [developers mailing-list
archive](https://mailman.boum.org/pipermail/tails-dev/).
2. **[[Tell us|contribute/talk]] about your plans** to make sure your
diff --git a/wiki/src/contribute/how/translate/team/fr.mdwn b/wiki/src/contribute/how/translate/team/fr.mdwn
index 90b4ef9..8516849 100644
--- a/wiki/src/contribute/how/translate/team/fr.mdwn
+++ b/wiki/src/contribute/how/translate/team/fr.mdwn
@@ -35,6 +35,8 @@ For French, various bits of text can be translated via Git:
* matsa: [[https://git-tails.immerda.ch/matsa/tails]]
* mercedes508: [[https://git-tails.immerda.ch/mercedes508]]
* seb35: [[https://git-tails.immerda.ch/seb35]]
+* elouann: [[http://git.tails.boum.org/elouann/tails/]]
+ * PGP fingerprint: `4C95 4E38 AC95 9C33 BD03 7A09 A29F 43F4 830F 0A36`
# Glossaries
diff --git a/wiki/src/contribute/how/translate/with_Git.mdwn b/wiki/src/contribute/how/translate/with_Git.mdwn
index d5e09e8..fc7b81f 100644
--- a/wiki/src/contribute/how/translate/with_Git.mdwn
+++ b/wiki/src/contribute/how/translate/with_Git.mdwn
@@ -18,7 +18,7 @@ If you want to use another operating system, these tools are:
* Git - manage source code
* Poedit - translate files
* OpenSSH client - publish your translations on the server
-* tools to [[build the wiki locally|contribute/build/website/]] in
+* tools to [[build a local copy of the website|contribute/build/website/]] in
order to check how it will look like
If you do not use Tails, please ensure that you use at least version 1.5 of Poedit,
diff --git a/wiki/src/contribute/l10n_tricks.mdwn b/wiki/src/contribute/l10n_tricks.mdwn
index 0571cd6..e646dd3 100644
--- a/wiki/src/contribute/l10n_tricks.mdwn
+++ b/wiki/src/contribute/l10n_tricks.mdwn
@@ -17,11 +17,11 @@ Calculate statistics on the translations
Run the [[language statistics.sh]] script.
-Build the wiki offline
-======================
+Build a local copy of the website
+=================================
-To check your translations before you send them, you may want to browse the
-wiki offline. See the [[corresponding documentation|contribute/build/website]].
+To check your translations before sending them, we recommend you [[build
+a local copy of the website|contribute/build/website]].
Search for fuzzy strings with Vim
=================================
diff --git a/wiki/src/contribute/release_process.mdwn b/wiki/src/contribute/release_process.mdwn
index 82ec8bf..7a94c19 100644
--- a/wiki/src/contribute/release_process.mdwn
+++ b/wiki/src/contribute/release_process.mdwn
@@ -306,7 +306,7 @@ matches the date of the future signature.
echo "$RELEASE_DATE" > wiki/src/inc/stable_i386_date.html
sed -ri "s%news/version_.*]]%news/version_$VERSION]]%" wiki/src/inc/stable_i386_release_notes.*
$EDITOR wiki/src/inc/*.html
- ./build-wiki
+ ./build-website
git commit wiki/src/inc/ -m "Update version and date for $VERSION."
### features and design documentation
@@ -328,7 +328,7 @@ pages that were added or changed accordingly to changes coming with
the new release. This e.g. ensures that the RC call for translation
points translators to up-to-date PO files:
- ./build-wiki && git add wiki/src && git commit -m 'Update website PO files.'
+ ./build-website && git add wiki/src && git commit -m 'Update website PO files.'
Call for translation
====================
@@ -816,7 +816,7 @@ Write the announcement for the release in
In any case
-----------
-Generate PO files for the announcements with `./build-wiki`.
+Generate PO files for the announcements with `./build-website`.
Then, send them to <tails-l10n@boum.org> so that they get translated
shortly, perhaps even soon enough to integrate them before pushing the
diff --git a/wiki/src/doc/first_steps/persistence/configure.mdwn b/wiki/src/doc/first_steps/persistence/configure.mdwn
index 092fe12..f65bc37 100644
--- a/wiki/src/doc/first_steps/persistence/configure.mdwn
+++ b/wiki/src/doc/first_steps/persistence/configure.mdwn
@@ -236,11 +236,14 @@ When this feature is activated, the packages that you install using the
If you
[[install additional programs|doc/advanced_topics/additional_software]],
this feature allows you to download them once and reinstall them
-during future working sessions, even offline. Note that those
-packages are not automatically installed when restarting Tails.
+during future working sessions, even offline.
-If you activate this feature, it is recommended to activate the
-<span class="guilabel">APT Lists</span> feature as well.
+To reinstall these packages automatically when restarting Tails, use the
+[[<span class="guilabel">Additional software packages</span> persistence
+feature|configure#additional_software]].
+
+If you activate the <span class="guilabel">APT Packages</span> persistence feature,
+it is recommended to activate the <span class="guilabel">APT Lists</span> feature as well.
<a id="apt_lists"></a>