diff options
Diffstat (limited to 'docs/glossary.md')
| -rw-r--r-- | docs/glossary.md | 121 |
1 files changed, 94 insertions, 27 deletions
diff --git a/docs/glossary.md b/docs/glossary.md index 29f307ca6..d35454cbf 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 on Rails</a></li> <li><a href="#sass">Sass</a></li> @@ -49,11 +51,11 @@ Definitions </dt> <dd> <strong>Alaveteli</strong> is the name of the open source software platform created - by <a href="http://www.mysociety.org">mySociety</a> for submitting, + by <a href="https://www.mysociety.org">mySociety</a> for submitting, managing and archiving Freedom of Information requests. <p> It grew from the successful FOI UK project - <a href="http://www.whatdotheyknow.com">WhatDoTheyKnow</a>. + <a href="https://www.whatdotheyknow.com">WhatDoTheyKnow</a>. We use the name <em>Alaveteli</em> to distinguish the software that runs the platform from any specific website that it is powering. </p> @@ -154,7 +156,7 @@ Definitions <p>More information:</p> <ul> <li> - how to <a href="{{ site.baseurl }}docs/installing/deploy">deploy Alaveteli</a> (and why it's + how to <a href="{{ site.baseurl }}docs/installing/deploy/">deploy Alaveteli</a> (and why it's a good idea) </li> <li> @@ -184,7 +186,7 @@ Definitions <li> censor rules may simply redact text that exactly matches a particular sentence or phrase, or may use - <a href="regexp">regular expressions</a> + <a href="#regexp">regular expressions</a> </li> </ul> </div> @@ -224,7 +226,7 @@ Definitions <p>More information:</p> <ul> <li> - Wikipedia summary of <a href="http://http://en.wikipedia.org/wiki/Freedom_of_information_laws_by_country">FOI laws by country</a>. + Wikipedia summary of <a href="http://en.wikipedia.org/wiki/Freedom_of_information_laws_by_country">FOI laws by country</a>. </li> </ul> </div> @@ -238,7 +240,7 @@ Definitions helps us track changes to the code, and also makes it easy for other people to duplicate and even contribute to our software. <p> - The website <a href="http://github.com/mysociety">github.com</a> is a central, public + The website <a href="https://github.com/mysociety">github.com</a> is a central, public place where we make our software available. Because it's Open Source, you can inspect the code there (Alaveteli is mostly written in the programming language Ruby), report bugs, suggest features and many other useful things. @@ -253,15 +255,15 @@ Definitions <p>More information:</p> <ul> <li> - See the <a href="{{ site.baseurl }}docs/installing">installation instructions</a> which will + See the <a href="{{ site.baseurl }}docs/installing/">installation instructions</a> which will clone the Alaveteli repo. </li> <li> Everything about git from the <a - href="//http://git-scm.com">official website</a>. + href="http://git-scm.com">official website</a>. </li> <li> - See <a href="http://github.com/mysociety">the mySociety projects on + See <a href="https://github.com/mysociety">the mySociety projects on github</a>. </li> </ul> @@ -269,7 +271,7 @@ Definitions </dd> <dt> - <a name="holding pen">holding pen</a> + <a name="holding_pen">holding pen</a> </dt> <dd> The <strong>holding pen</strong> is the conceptual place where responses that @@ -278,7 +280,7 @@ Definitions <p>More information:</p> <ul> <li> - see the <a href="{{ site.baseurl }}docs/running/admin_manual">admin manual</a> for + see the <a href="{{ site.baseurl }}docs/running/admin_manual/">admin manual</a> for information on dealing with emails in the holding pen </li> </ul> @@ -297,7 +299,7 @@ Definitions <p>More information:</p> <ul> <li> - see these instructions for <a href="{{ site.baseurl }}docs/installing/email">configuring your MTA</a> + see these instructions for <a href="{{ site.baseurl }}docs/installing/email/">configuring your MTA</a> (examples are for exim4 and postfix, two of the most common) </li> </ul> @@ -318,7 +320,7 @@ Definitions <li> use the <code>agent_enabled:</code> setting in the the <code>newrelic.yml</code> config file to enable the New Relic analytics. - See the <a href="{{ site.baseurl }}docs/installing/manual_install">manual installation</a> instructions. + See the <a href="{{ site.baseurl }}docs/installing/manual_install/">manual installation</a> instructions. </li> <li> see also the New Relic Ruby Agent <a href="https://github.com/newrelic/rpm">github repo</a> and @@ -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,42 @@ 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 their tag, which comprises two or + three numbers: major, minor, and — if necessary — 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> + and their explicit tags. + </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 +554,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> @@ -584,15 +652,15 @@ Definitions <p>More information:</p> <ul> <li> - <a href="{{ site.baseurl }}docs/running/states">example states for WhatDoTheyKnow</a> + <a href="{{ site.baseurl }}docs/running/states/">example states for WhatDoTheyKnow</a> (Alaveteli site running in the UK) </li> <li> - for comparison, <a href="{{ site.baseurl }}docs/running/states_informatazyrtare">example states for InformataZyrtare</a> + for comparison, <a href="{{ site.baseurl }}docs/running/states_informatazyrtare/">example states for InformataZyrtare</a> (Alaveteli site running in Kosovo) </li> <li> - to customise or add your own states, see <a href="{{ site.baseurl }}docs/customising/themes">Customising the request states</a> + to customise or add your own states, see <a href="{{ site.baseurl }}docs/customising/themes/">Customising the request states</a> </li> </ul> </div> @@ -610,8 +678,7 @@ Definitions <p>More information:</p> <ul> <li> - <a href="{{ site.baseurl }}docs/customising -/themes">about themes</a> + <a href="{{ site.baseurl }}docs/customising/themes/">about themes</a> </li> </ul> </div> |