diff options
Diffstat (limited to 'docs/glossary.md')
| -rw-r--r-- | docs/glossary.md | 99 |
1 files changed, 49 insertions, 50 deletions
diff --git a/docs/glossary.md b/docs/glossary.md index d0e03b41d..94b29648c 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -66,14 +66,14 @@ Definitions </dt> <dd> The <strong>admin interface</strong> allows users who have - <a href="{{ site.baseurl }}docs/glossary/#super" class="glossary__link">super</a> + <a href="{{ page.baseurl }}/docs/glossary/#super" class="glossary__link">super</a> administrator privilege to manage some aspects of how your Alaveteli site runs. <div class="more-info"> <p>More information:</p> <ul> <li> - You can access your installation's <a href="{{ site.baseurl }}docs/glossary/#admin" class="glossary__link">admin interface</a> + You can access your installation's <a href="{{ page.baseurl }}/docs/glossary/#admin" class="glossary__link">admin interface</a> at <code>/admin</code>. </li> <li> @@ -83,13 +83,12 @@ Definitions </li> <li> On a newly-installed Alaveteli system, you can grant yourself - admin privilege by using the - <a href="{{ site.baseurl }}docs/glossary/#emergency" class="glossary__link">emergency + <a href="{{ page.baseurl }}/docs/glossary/#emergency" class="glossary__link">emergency user</a>. </li> <li> For lots more about running an Alaveteli site, see the - <a href="{{ site.baseurl }}running/admin_manual">adminstrator's guide</a>. + <a href="{{ page.baseurl }}/running/admin_manual">adminstrator's guide</a>. </li> </ul> </div> @@ -193,7 +192,7 @@ Definitions </li> <li> You can organise your authorities using - <a href="{{ site.baseurl }}docs/running/categories_and_tags/">categories and tags</a>. + <a href="{{ page.baseurl }}/docs/running/categories_and_tags/">categories and tags</a>. </li> </ul> </div> @@ -212,12 +211,12 @@ Definitions <ul> <li> Use the config setting - <code><a href="{{site.baseurl}}docs/customising/config/#blackhole_prefix">BLACKHOLE_PREFIX</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#blackhole_prefix">BLACKHOLE_PREFIX</a></code> to specify what this email address looks like. </li> <li> Conversely, see - <code><a href="{{site.baseurl}}docs/customising/config/#contact_email">CONTACT_EMAIL</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#contact_email">CONTACT_EMAIL</a></code> to specify the email address to which users' emails (such as support enquiries) will be delivered. </li> @@ -235,7 +234,7 @@ Definitions <p>More information:</p> <ul> <li> - <a href="{{ site.baseurl }}docs/installing/email#how-alaveteli-handles-email">How Alaveteli handles email</a> + <a href="{{ page.baseurl }}/docs/installing/email#how-alaveteli-handles-email">How Alaveteli handles email</a> </li> <li>The wikipedia page on <a href="http://en.wikipedia.org/wiki/Bounce_message">bounce messages</a> </li> @@ -253,7 +252,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="{{ page.baseurl }}/docs/installing/deploy/">deploy Alaveteli</a> (and why it's a good idea) </li> <li> @@ -282,7 +281,7 @@ Definitions authorities with specific categories. </p> More about - <a href="{{ site.baseurl }}docs/running/categories_and_tags/">categories and tags</a> + <a href="{{ page.baseurl }}/docs/running/categories_and_tags/">categories and tags</a> </dd> <dt> <a name="categorisation-game">categorisation game</a> @@ -312,7 +311,7 @@ Definitions <ul> <li> see the - <a href="{{ site.baseurl }}docs/running/admin_manual/">admin manual</a> + <a href="{{ page.baseurl }}/docs/running/admin_manual/">admin manual</a> for more about censor rules </li> <li> @@ -329,7 +328,7 @@ Definitions </dt> <dd> A <strong>dev server</strong> is one that is running your Alaveteli site - so you can <a href="{{ site.baseurl }}docs/customising/">customise it</a>, experiment + so you can <a href="{{ page.baseurl }}/docs/customising/">customise it</a>, experiment with different settings, and test that it does what you expect. This is different from a <a href="#production" class="glossary__link">production server</a>, which is the one your @@ -338,7 +337,7 @@ Definitions which is used for testing code before it goes live. <p> On your dev server, you should set - <code><a href="{{site.baseurl}}docs/customising/config/#staging_site">STAGING_SITE</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#staging_site">STAGING_SITE</a></code> to <code>1</code>. </p> </dd> @@ -357,7 +356,7 @@ Definitions <ul> <li> You can add a disclosure log URL by - <a href="{{ site.baseurl }}docs/running/admin_manual/#creating-changing-and-uploading-public-authority-data">updating authority data</a> in the admin. + <a href="{{ page.baseurl }}/docs/running/admin_manual/#creating-changing-and-uploading-public-authority-data">updating authority data</a> in the admin. </li> </ul> </div> @@ -380,18 +379,18 @@ Definitions <ul> <li> The username and password are defined by the configuration settings - <code><a href="{{site.baseurl}}docs/customising/config/#admin_username">ADMIN_USERNAME</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#admin_username">ADMIN_USERNAME</a></code> and - <code><a href="{{site.baseurl}}docs/customising/config/#admin_password">ADMIN_PASSWORD</a></code>. + <code><a href="{{ page.baseurl }}/docs/customising/config/#admin_password">ADMIN_PASSWORD</a></code>. </li> <li> For an example of using the emergency user, see - <a href="{{site.baseurl}}docs/installing/next_steps/#create-a-superuser-account-for-yourself">creating + <a href="{{ page.baseurl }}/docs/installing/next_steps/#create-a-superuser-account-for-yourself">creating a superuser account</a>. </li> <li> Disable the emergency user by setting - <code><a href="{{site.baseurl}}docs/customising/config/#disable_emergency_user">DISABLE_EMERGENCY_USER:</a> true</code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#disable_emergency_user">DISABLE_EMERGENCY_USER:</a> true</code> </li> </ul> </div> @@ -441,7 +440,7 @@ Definitions <p>More information:</p> <ul> <li> - See the <a href="{{ site.baseurl }}docs/installing/">installation instructions</a> which will + See the <a href="{{ page.baseurl }}/docs/installing/">installation instructions</a> which will clone the Alaveteli repo. </li> <li> @@ -473,7 +472,7 @@ Definitions <p>More information:</p> <ul> <li> - See more <a href="{{ site.baseurl }}docs/running/holding_pen">about + See more <a href="{{ page.baseurl }}/docs/running/holding_pen">about the holding pen</a>, including why messages end up there, and instructions on what to do with them. </li> @@ -521,12 +520,12 @@ Definitions <p> Often you don't need to worry about the details of how this is done because once you've configured your site's - <code><a href="{{ site.baseurl }}docs/customising/config/#default_locale">DEFAULT_LOCALE</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#default_locale">DEFAULT_LOCALE</a></code> Alaveteli takes care of it for you. But when you do need to work on i18n (for example, if you're customising your site by - <a href="{{ site.baseurl }}docs/customising/translation/">translating</a> it, or - <a href="{{ site.baseurl }}docs/running/admin_manual/#creating-changing-and-uploading-public-authority-data">uploading names</a> + <a href="{{ page.baseurl }}/docs/customising/translation/">translating</a> it, or + <a href="{{ page.baseurl }}/docs/running/admin_manual/#creating-changing-and-uploading-public-authority-data">uploading names</a> of the public bodies in more than one language) at the very least you may need to know the language codes you're site is using. </p> @@ -534,7 +533,7 @@ Definitions <p>More information:</p> <ul> <li> - More about <a href="{{ site.baseurl }}docs/developers/i18n/">internationalising Alaveteli</a> + More about <a href="{{ page.baseurl }}/docs/developers/i18n/">internationalising Alaveteli</a> </li> <li> See mySociety's @@ -563,7 +562,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="{{ page.baseurl }}/docs/installing/email/">configuring your MTA</a> (examples are for exim4 and postfix, two of the most common) </li> </ul> @@ -584,7 +583,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="{{ page.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 @@ -613,11 +612,11 @@ Definitions <p>More information:</p> <ul> <li> - See <a href="{{ site.baseurl }}docs/customising/translation/">translating + See <a href="{{ page.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 + See <a href="{{ page.baseurl }}/docs/developers/i18n/">Internationalising Alaveteli</a> for more technical details. </li> <li> @@ -649,7 +648,7 @@ Definitions example, caching is enabled, and debugging switched off. <a href="#rails" class="glossary__link">Rails</a> has a "production mode" which does this for you: set - <code><a href="{{site.baseurl}}docs/customising/config/#staging_site">STAGING_SITE</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#staging_site">STAGING_SITE</a></code> to <code>0</code>. Note that if you <em>change</em> this setting after you've deployed, the <code>rails_env.rb</code> file that enables Rails's production mode won't be created until you run <code>rails-post-deploy</code>. @@ -660,7 +659,7 @@ Definitions <p> You should never need to edit code directly on your production server. We strongly recommend you use Alaveteli's - <a href="{{ site.baseurl }}docs/installing/deploy/">deployment mechanism</a> + <a href="{{ page.baseurl }}/docs/installing/deploy/">deployment mechanism</a> (using Capistrano) to make changes to your production site. </p> </dd> @@ -695,7 +694,7 @@ Definitions <ul> <li> You can add a publication scheme URL by - <a href="{{ site.baseurl }}docs/running/admin_manual/#creating-changing-and-uploading-public-authority-data">updating authority data</a> in the admin. + <a href="{{ page.baseurl }}/docs/running/admin_manual/#creating-changing-and-uploading-public-authority-data">updating authority data</a> in the admin. </li> </ul> </div> @@ -716,9 +715,9 @@ Definitions <ul> <li> use the config settings - <code><a href="{{site.baseurl}}docs/customising/config/#recaptcha_public_key">RECAPTCHA_PUBLIC_KEY</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#recaptcha_public_key">RECAPTCHA_PUBLIC_KEY</a></code> and - <code><a href="{{site.baseurl}}docs/customising/config/#recaptcha_private_key">RECAPTCHA_PRIVATE_KEY</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#recaptcha_private_key">RECAPTCHA_PRIVATE_KEY</a></code> to set this up. </li> <li> @@ -747,7 +746,7 @@ Definitions <ul> <li> see the - <a href="{{ site.baseurl }}docs/running/admin_manual/">admin manual</a> + <a href="{{ page.baseurl }}/docs/running/admin_manual/">admin manual</a> for more about how and when you may need to redact information </li> <li> @@ -822,11 +821,11 @@ Definitions </li> <li> We try to coordinate releases with any active translation work too. - See <a href="{{ site.baseurl }}docs/customising/translation/">translating + See <a href="{{ page.baseurl }}/docs/customising/translation/">translating Alaveteli</a> for more information. </li> <li> - We encourage you use the <a href="{{site.baseurl}}docs/installing/deploy/">deployment + We encourage you use the <a href="{{ page.baseurl }}/docs/installing/deploy/">deployment mechanism</a>, which makes it easier to keep your production server up-to-date. </li> </ul> @@ -868,7 +867,7 @@ Definitions <a href="http://rubyonrails.org/">Ruby on Rails</a> website </li> <li> - Alavateli's <a href="{{ site.baseurl }}docs/developers/directory_structure/">directory structure</a> + Alavateli's <a href="{{ page.baseurl }}/docs/developers/directory_structure/">directory structure</a> is influenced by its use of Ruby on Rails </li> </ul> @@ -894,7 +893,7 @@ Definitions <a href="http://sass-lang.com">Sass website</a> </li> <li> - more about <a href="{{ site.baseurl }}docs/customising/themes/#changing-the-colour-scheme">changing + more about <a href="{{ page.baseurl }}/docs/customising/themes/#changing-the-colour-scheme">changing your colour scheme</a>, which uses Sass </li> </ul> @@ -918,7 +917,7 @@ Definitions <ul> <li> To add addresses to the spam address list , see - <a href="{{ site.baseurl }}docs/running/admin_manual/#rejecting-spam-that-arrives-in-the-holding-pen">Rejecting + <a href="{{ page.baseurl }}/docs/running/admin_manual/#rejecting-spam-that-arrives-in-the-holding-pen">Rejecting spam that arrives in the holding pen</a>. </li> <li> @@ -940,7 +939,7 @@ Definitions site your users visit running with live data. <p> On your staging server, you should set - <code><a href="{{site.baseurl}}docs/customising/config/#staging_site">STAGING_SITE</a></code> + <code><a href="{{ page.baseurl }}/docs/customising/config/#staging_site">STAGING_SITE</a></code> to <code>1</code>. </p> <p> @@ -950,7 +949,7 @@ Definitions <p> You should never need to edit code directly on your production or staging servers. We strongly recommend you use Alaveteli's - <a href="{{ site.baseurl }}docs/installing/deploy/">deployment mechanism</a> + <a href="{{ page.baseurl }}/docs/installing/deploy/">deployment mechanism</a> (using Capistrano) to make changes to these sites. </p> </dd> @@ -972,15 +971,15 @@ Definitions <p>More information:</p> <ul> <li> - <a href="{{ site.baseurl }}docs/customising/states/">example states for WhatDoTheyKnow</a> + <a href="{{ page.baseurl }}/docs/customising/states/">example states for WhatDoTheyKnow</a> (Alaveteli site running in the UK) </li> <li> - for comparison, <a href="{{ site.baseurl }}docs/customising/states_informatazyrtare/">example states for InformataZyrtare</a> + for comparison, <a href="{{ page.baseurl }}/docs/customising/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">Customising the request states</a> + to customise or add your own states, see <a href="{{ page.baseurl }}/docs/customising/themes/#customising-the-request-states">Customising the request states</a> </li> </ul> </div> @@ -992,11 +991,11 @@ Definitions <dd> A <strong>superuser</strong>, or <strong>administrator</strong>, is an Alaveteli user who has been granted the privilege to use all features of the - <a href="{{ site.baseurl }}docs/glossary/#admin" + <a href="{{ page.baseurl }}/docs/glossary/#admin" class="glossary__link">admin interface</a>. <p> The only way to access the admin without being an Alaveteli superuser - is as the <a href="{{ site.baseurl }}docs/glossary/#emergency" + is as the <a href="{{ page.baseurl }}/docs/glossary/#emergency" class="glossary__link">emergency user</a>, which should be disabled in normal operation. </p> @@ -1011,7 +1010,7 @@ Definitions <li> On a newly-installed Alaveteli system, you can grant yourself admin privilege by using the - <a href="{{ site.baseurl }}docs/glossary/#emergency" class="glossary__link">emergency + <a href="{{ page.baseurl }}/docs/glossary/#emergency" class="glossary__link">emergency user</a>. </li> </ul> @@ -1035,7 +1034,7 @@ Definitions <ul> <li> More about - <a href="{{ site.baseurl }}docs/running/categories_and_tags/">categories and tags</a> + <a href="{{ page.baseurl }}/docs/running/categories_and_tags/">categories and tags</a> </li> </ul> </div> @@ -1054,7 +1053,7 @@ Definitions <p>More information:</p> <ul> <li> - <a href="{{ site.baseurl }}docs/customising/themes/">about themes</a> + <a href="{{ page.baseurl }}/docs/customising/themes/">about themes</a> </li> </ul> </div> |