aboutsummaryrefslogtreecommitdiffstats
path: root/docs/glossary.md
diff options
context:
space:
mode:
authorDave Whiteland <dave@mysociety.org>2014-07-03 14:25:16 +0100
committerDave Whiteland <dave@mysociety.org>2014-07-03 14:25:16 +0100
commit1b9c236ef8e5390b0bb76ab859e44946b8a348d2 (patch)
tree92164dcd1aa356166c986975da2bf9935f53db6e /docs/glossary.md
parent359582ff3d981680cc6a9997e1a96381d7341866 (diff)
parent5c7ca961e3b647ead4f1aa6722caad780cfe22f2 (diff)
Merge branch 'gh-pages-i18n' into gh-pages
Diffstat (limited to 'docs/glossary.md')
-rw-r--r--docs/glossary.md85
1 files changed, 76 insertions, 9 deletions
diff --git a/docs/glossary.md b/docs/glossary.md
index 64c75c603..7a7c5d003 100644
--- a/docs/glossary.md
+++ b/docs/glossary.md
@@ -27,12 +27,14 @@ Definitions
<li><a href="#holding_pen">holding pen</a></li>
<li><a href="#newrelic">New Relic</a></li>
<li><a href="#mta">MTA</a></li>
+ <li><a href="#po">.po files</a></li>
<li><a href="#production">production site</a></li>
<li><a href="#publish">publish</a></li>
<li><a href="#recaptcha">recaptcha</a></li>
<li><a href="#redact">redacting</a></li>
<li><a href="#regexp">regular expression</a></li>
<li><a href="#request">request</a></li>
+ <li><a href="#release">release</a></li>
<li><a href="#response">response</a></li>
<li><a href="#rails">Ruby&nbsp;on&nbsp;Rails</a></li>
<li><a href="#sass">Sass</a></li>
@@ -333,6 +335,36 @@ Definitions
</dd>
<dt>
+ <a name="po"><code>.po</code> file</a> (and <code>.pot</code> file)
+ </dt>
+ <dd>
+ These are the files needed by the gettext mechanism Alaveteli uses for
+ localisation. A <code>.pot</code> file is effectively a list of all the
+ strings in the application that need translating. Each <code>.po</code>
+ file contains the mapping between those strings, used as keys, and their
+ translations for one particular language. The key is called the
+ <em>msgid</em>, and its corresponding translation is the <em>msgstr</em>.
+ <div class="more-info">
+ <p>More information:</p>
+ <ul>
+ <li>
+ See <a href="{{ site.baseurl }}docs/customising/translation/">translating
+ Alaveteli</a> for an overview from a translator's point of view.
+ </li>
+ <li>
+ See <a href="{{ site.baseurl }}docs/developers/i18n/">Internationalising
+ Alaveteli</a> for more technical details.
+ </li>
+ <li>
+ Alaveteli is on the <a href="https://www.transifex.net/projects/p/alaveteli/">Transifex</a>
+ website, which lets translators work on Alaveteli in a browser, without needing
+ to worry about this underlying structure.
+ </li>
+ </ul>
+ </div>
+ </dd>
+
+ <dt>
<a name="production">production site</a> (also: live, production server)
</dt>
<dd>
@@ -378,15 +410,6 @@ Definitions
</dd>
<dt>
- <a name="response">response</a>
- </dt>
- <dd>
- A <strong>response</strong> is the email sent by an
- <a href="#authority" class="glossary">authority</a> in reply to
- a user's <a href="#request" class="glossary">requests</a>.
- </dd>
-
- <dt>
<a name="recaptcha">recaptcha</a>
</dt>
<dd>
@@ -482,6 +505,41 @@ Definitions
</dd>
<dt>
+ <a name="release">release</a> (also: release manager)
+ </dt>
+ <dd>
+ We issue new <strong>releases</strong> of the Alaveteli code whenever key
+ work (new features, improvements, bugfixes, and so on) have been added to
+ the core code. Releases are identified by three numbers: major, minor, and
+ &mdash; if necessary &mdash; a patch number. We recommend you always use
+ the latest version. The process is handled by the Alaveteli <strong>release
+ manager</strong>, who decides what changes are to be included in the
+ current release, and the cut-off date for the work. Currently this is
+ Alaveteli's lead developer at mySociety.
+ <div class="more-info">
+ <p>More information:</p>
+ <ul>
+ <li>
+ The latest stable release is on the
+ <a href="https://github.com/mysociety/alaveteli/tree/master">master branch</a>.
+ </li>
+ <li>
+ See a <a href="https://github.com/mysociety/alaveteli/releases">list of all releases</a>.
+ </li>
+ <li>
+ We try to coordinate releases with any active translation work too.
+ See <a href="http://localhost:4000/docs/customising/translation/">translating
+ Alaveteli</a> for more information.
+ </li>
+ <li>
+ We encourage you use the <a href="{{site.baseurl}}docs/installing/deploy/">deployment
+ mechanism</a>, which makes it easier to keep your production server up-to-date.
+ </li>
+ </ul>
+ </div>
+ </dd>
+
+ <dt>
<a name="request">request</a>
</dt>
<dd>
@@ -495,6 +553,15 @@ Definitions
</dd>
<dt>
+ <a name="response">response</a>
+ </dt>
+ <dd>
+ A <strong>response</strong> is the email sent by an
+ <a href="#authority" class="glossary">authority</a> in reply to
+ a user's <a href="#request" class="glossary">requests</a>.
+ </dd>
+
+ <dt>
<a name="rails">Ruby on Rails</a> (also Rails)
</dt>
<dd>