diff options
Diffstat (limited to 'docs/developers')
| -rw-r--r-- | docs/developers/i18n.md | 16 | ||||
| -rw-r--r-- | docs/developers/index.md | 18 |
2 files changed, 17 insertions, 17 deletions
diff --git a/docs/developers/i18n.md b/docs/developers/i18n.md index fb7f2930b..c10ebeab8 100644 --- a/docs/developers/i18n.md +++ b/docs/developers/i18n.md @@ -7,11 +7,11 @@ title: Internationalisation (for devs) <p class="lead"> This page describes some technical aspects of - <a href="{{ site.baseurl }}docs/glossary/#i18n" class="glossary__link">internationalising</a> + <a href="{{ page.baseurl }}/docs/glossary/#i18n" class="glossary__link">internationalising</a> the Alaveteli code. It's mostly aimed at devs who are working on the codebase — if you just want to translate Alaveteli into your own language, see - <a href="{{ site.baseurl }}docs/customising/translation">translating Alaveteli</a> + <a href="{{ page.baseurl }}/docs/customising/translation">translating Alaveteli</a> instead. </p> @@ -19,9 +19,9 @@ title: Internationalisation (for devs) Deployed translations for the project live in ``locale/``. -We encourage translations to be done on <a href="{{ site.baseurl }}docs/glossary/#transifex" class="glossary__link">Transifex</a> +We encourage translations to be done on <a href="{{ page.baseurl }}/docs/glossary/#transifex" class="glossary__link">Transifex</a> because translators can work through its web interface rather than needing to edit the -<a href="{{ site.baseurl }}docs/glossary/#po" class="glossary__link">`.po` and `.pot` files</a> +<a href="{{ page.baseurl }}/docs/glossary/#po" class="glossary__link">`.po` and `.pot` files</a> directly. Ultimately, Transifex just captures translators' work and turns it into the files that Alaveteli needs (using gettext). @@ -31,7 +31,7 @@ For example, to deploy English and Spanish translations at once: * Ensure their `.po` files are at ```locale/en/app.po``` and ```locale/es/app.po``` (for example, by downloading them from Transifex) - * Set <code><a href="{{ site.baseurl }}docs/customising/config/#available_locales">AVAILABLE_LOCALES</a></code> + * Set <code><a href="{{ page.baseurl }}/docs/customising/config/#available_locales">AVAILABLE_LOCALES</a></code> to <code>en es</code> ### What to do if you don't have complete translations for an older release of Alaveteli @@ -56,7 +56,7 @@ You need to do this if you've added any new strings to the code that need translations (or if you change an existing one). To update the -<a href="{{ site.baseurl }}docs/glossary/#po" class="glossary__link">`.po` or `.pot` files</a> +<a href="{{ page.baseurl }}/docs/glossary/#po" class="glossary__link">`.po` or `.pot` files</a> for each language, run: bundle exec rake gettext:store_model_attributes @@ -69,7 +69,7 @@ If `gettext:find` only creates the file `locale/im-config.pot` then you need to unset the `TEXTDOMAIN` environment variable and try again. For more details about the translations, see the page about -[translating Alaveteli]({{ site.baseurl }}docs/customising/translation/). +[translating Alaveteli]({{ page.baseurl }}/docs/customising/translation/). ## Technical implementation details @@ -173,5 +173,5 @@ The release manager will enforce a translation freeze just before a new release is cut. During such time, you must not introduce new strings to the code if your work is due for inclusion in this release. This is necessary to allow translators time to complete and check their translations against all the known -strings. See more about [translating Alaveteli]({{ site.baseurl }}docs/customising/translation/). +strings. See more about [translating Alaveteli]({{ page.baseurl }}/docs/customising/translation/). diff --git a/docs/developers/index.md b/docs/developers/index.md index f1167a22b..bcf74be16 100644 --- a/docs/developers/index.md +++ b/docs/developers/index.md @@ -16,10 +16,10 @@ title: For developers reasons, we recommend the use of [Varnish](https://www.varnish-cache.org). * To help you understand what the code is doing, read this [high-level - overview]({{ site.baseurl }}docs/developers/overview/), which includes a diagram of + overview]({{ page.baseurl }}/docs/developers/overview/), which includes a diagram of the models and how they are related. -* See the [API documentation]({{ site.baseurl }}docs/developers/api/) for how to get +* See the [API documentation]({{ page.baseurl }}/docs/developers/api/) for how to get data into or out of Alaveteli. * If you need to change or add strings in the interface, see our [guidelines @@ -40,23 +40,23 @@ title: For developers * Installing the software is a little involved, though it's getting easier. If you stick to Debian or Ubuntu, it should be possible to get a running version within a few hours. If you've got your own server, run the - [installation script]({{ site.baseurl }}docs/installing/script/), or follow the + [installation script]({{ page.baseurl }}/docs/installing/script/), or follow the instructions for a - [manual installation]({{ site.baseurl }}docs/installing/manual_install/). - Alternatively, there's an [Alaveteli EC2 AMI]({{ site.baseurl }}docs/installing/ami/) + [manual installation]({{ page.baseurl }}/docs/installing/manual_install/). + Alternatively, there's an [Alaveteli EC2 AMI]({{ page.baseurl }}/docs/installing/ami/) that might help you get up and running quickly. - [Get in touch]({{ site.baseurl }}community/) on the project mailing list or IRC + [Get in touch]({{ page.baseurl }}/community/) on the project mailing list or IRC for help. * A standard initial step for customising your deployment is [writing a - theme]({{ site.baseurl }}docs/customising/themes/). **If you only read one thing, + theme]({{ page.baseurl }}/docs/customising/themes/). **If you only read one thing, it should be this!** * Like many Ruby on Rails sites, the software is not hugely performant (see [these notes about performance issues](https://github.com/mysociety/alaveteli/wiki/Performance-issues) gathered over time with WhatDoTheyKnow). The site will run on a server with 512MB RAM but at least 2GB is recommended. Deployment behind [Varnish](https://www.varnish-cache.org) is also fairly essential. See - [production server best practices]({{site.baseurl}}docs/running/server/) for more. + [production server best practices]({{ page.baseurl }}/docs/running/server/) for more. * There's a number of [proposals for enhancements](https://github.com/mysociety/alaveteli/wiki/Proposals-for-enhancements), such as more user-focused features, but see also... @@ -76,7 +76,7 @@ title: For developers used in the past](https://www.mysociety.org/2009/09/17/whatdotheyknow-growing-pains-and-ruby-memory-leaks/) might be useful. -* If you're coding on a mac, see these [MacOS X installation notes]({{ site.baseurl }}docs/installing/macos/). <!-- [[OS X Quickstart]] --> +* If you're coding on a mac, see these [MacOS X installation notes]({{ page.baseurl }}/docs/installing/macos/). <!-- [[OS X Quickstart]] --> * We try to adhere to similar good practice across all our projects: see [mysociety.github.io](http://mysociety.github.io/) for things like our |