diff options
| -rw-r--r-- | _layouts/default.html | 11 | ||||
| -rw-r--r-- | _layouts/page.html | 3 | ||||
| -rw-r--r-- | customising/translation.md | 58 | ||||
| -rw-r--r-- | getting_started.md | 27 | ||||
| -rw-r--r-- | installing/ami.md | 15 | ||||
| -rw-r--r-- | installing/manual_install.md | 23 | ||||
| -rw-r--r-- | search.md | 7 |
7 files changed, 53 insertions, 91 deletions
diff --git a/_layouts/default.html b/_layouts/default.html index 4ab06f601..d91d754db 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -19,7 +19,18 @@ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); + (function() { + var cx = '012469947838795749698:abakbfgsmqm'; + var gcse = document.createElement('script'); + gcse.type = 'text/javascript'; + gcse.async = true; + gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + + '//www.google.com/cse/cse.js?cx=' + cx; + var s = document.getElementsByTagName('script')[0]; + s.parentNode.insertBefore(gcse, s); + })(); </script> + </head> <body> diff --git a/_layouts/page.html b/_layouts/page.html index 382c6875f..495a7cd93 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -10,6 +10,9 @@ layout: default <div class="secondary-content-column"> <nav class="sidebar"> <ul> + <li> + <gcse:searchbox-only></gcse:searchbox-only> + </li> <li><a href="{{ site.baseurl }}">Documentation</a> <ul> <li><a href="{{ site.baseurl }}glossary">Glossary</a></li> diff --git a/customising/translation.md b/customising/translation.md index 927067f89..4f3c39270 100644 --- a/customising/translation.md +++ b/customising/translation.md @@ -28,7 +28,7 @@ need to know about the one that applies to you. ## Translation process: translator's view -**If you're just working on translating Alavetli into a language you know, then +**If you're just working on translating Alaveteli into a language you know, then this section is for you.** When a developer adds a new feature to the user interface in Alaveteli, they @@ -121,59 +121,3 @@ 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. - -## Translation process: release manager's view - -**If you're responsible for coordinating translators and developers so that all -the work comes together in a new release, you're the release manager.** - -This is the most complicated of the three roles -- the chances are this doesn't -apply to you, so only read it if you want to understand how the process works. - -As the release manager, before you cut a new release branch, you must do the -following: - -### Before the release candidate date: - -* Pick a date for the release branch to be cut ("release candidate date"). -* Make an announcement to the translators (using the "announcements" - feature in Transifex) that they should ensure they have any pending - translations saved in Transifex before the release candidate date. -* Make an announcement to the developers that all new strings should - be committed before the release candidate date. - -### On the release candidate date: - -* Download all the current translations with `tx pull -a -f` and commit (important: there's no revision history in Transifex!). -* You should also commit these translations to a hotfix for the - previous version, so they are preserved against the last known - good msgids. -* Regenerate the POT file and individual PO files for each language, - using `bundle exec rake gettext:store_model_attributes`, followed by - `bundle exec rake gettext:find` - * Be careful not to include msgids from themes in `lib/themes`; - you might want to move them out of the way before running - the above commands. - * This updates the PO template, but also merges it with the - individual PO files, marking strings that have only changed - slightly as "fuzzy". -* Re-upload the POT and PO files to Transifex from the - current release branch with `tx push -s -t` - * The point of uploading the PO files is that Transifex - converts the "fuzzy" suggestions from Transifex into - "suggestions" under each source string. - * Note that Transifex *does not* preserve fuzzy strings in the - PO files it makes available for download, on the grounds - that Transifex supports multiple suggestions, whereas - gettext only allows one fuzzy suggestion per msgid. -* Remove the fuzzy strings from the local PO files (because they - make Rails very noisy), and then commit the result. You can do - this by re-pulling from Transifex. - -### On the release date: - -* Download and commit all the current translations to the current release branch. - - - - diff --git a/getting_started.md b/getting_started.md index c8dd9d0cf..2911aecf3 100644 --- a/getting_started.md +++ b/getting_started.md @@ -114,8 +114,7 @@ operating system, though any sort of Linux should do. Rackspace offer suitable cloud servers, which start out at around $25 / month. Then your tech person should follow the [installation documentation]({{ site.baseurl }}installing). -Alternatively, you could use Amazon Web Services. If you've not used them -before, you can get a free "micro" instance for twelve months. This has the +Alternatively, you could use Amazon Web Services. This has the added advantage that you can use our preconfigured [Alaveteli EC2 AMI]({{ site.baseurl }}installing/ami) to get you started almost instantly. However, it's more expensive than Rackspace, @@ -181,7 +180,7 @@ http://blogger.com and announce your project with a new blog post. Next, think about the visual identity. At a minimum, you should probably replace the default Alaveteli logo that you can see at the top left of -http://demo.alaveteli.org. It's also easy to change the colour scheme. +<http://demo.alaveteli.org>. It's also easy to change the colour scheme. If you have a bit more budget and time, you can rework the design more, with a custom homepage, different fonts, etc; however, the more you customise the @@ -218,14 +217,14 @@ therefore relevant only to the UK. You should take these pages as inspiration, but review their content with a view to your jurisdiction. The important pages to translate are: -* [About](https://github.com/mysociety/alaveteli/blob/develop/app/views/help/about.rhtml): why the website exists, why it works, etc -* [contact](https://github.com/mysociety/alaveteli/blob/develop/app/views/help/contact.rhtml): how to get in touch -* [credits](https://github.com/mysociety/alaveteli/blob/develop/app/views/help/credits.rhtml): who is involved in the site. Importantly, includes a section on how users can help the project. -* [officers](https://github.com/mysociety/alaveteli/blob/develop/app/views/help/officers.rhtml): information for the officers who deal with FOI at authorities. They get a link to this page in emails that the site sends them. -* [privacy](https://github.com/mysociety/alaveteli/blob/develop/app/views/help/privacy.rhtml): privacy policy, plus information making it clear that requests are going to appear on the internet. Let users know if they are allowed to use pseudonyms in your jurisdiction. -* [requesting](https://github.com/mysociety/alaveteli/blob/develop/app/views/help/requesting.rhtml): the main help page about making requests. How it works, how to decide who to write to, what they can expect in terms of responses, how to make appeals, etc. -* [unhappy](https://github.com/mysociety/alaveteli/blob/develop/app/views/help/unhappy.rhtml): users are taken to this page after a request that has been somehow unsuccessful (e.g. the request has been refused, or the authority is insisting on a postal request). The page should encourage them to keep going, e.g. by starting a new request or addressing it to a different body. -* [why email](https://github.com/mysociety/alaveteli/blob/develop/app/views/help/_why_they_should_reply_by_email.rhtml): a snippet of information that explains why users should insist on replies by email. This is displayed next to requests that have "gone postal". +* [About](https://github.com/mysociety/alaveteli/blob/master/app/views/help/about.rhtml): why the website exists, why it works, etc +* [contact](https://github.com/mysociety/alaveteli/blob/master/app/views/help/contact.rhtml): how to get in touch +* [credits](https://github.com/mysociety/alaveteli/blob/master/app/views/help/credits.rhtml): who is involved in the site. Importantly, includes a section on how users can help the project. +* [officers](https://github.com/mysociety/alaveteli/blob/master/app/views/help/officers.rhtml): information for the officers who deal with FOI at authorities. They get a link to this page in emails that the site sends them. +* [privacy](https://github.com/mysociety/alaveteli/blob/master/app/views/help/privacy.rhtml): privacy policy, plus information making it clear that requests are going to appear on the internet. Let users know if they are allowed to use pseudonyms in your jurisdiction. +* [requesting](https://github.com/mysociety/alaveteli/blob/master/app/views/help/requesting.rhtml): the main help page about making requests. How it works, how to decide who to write to, what they can expect in terms of responses, how to make appeals, etc. +* [unhappy](https://github.com/mysociety/alaveteli/blob/master/app/views/help/unhappy.rhtml): users are taken to this page after a request that has been somehow unsuccessful (e.g. the request has been refused, or the authority is insisting on a postal request). The page should encourage them to keep going, e.g. by starting a new request or addressing it to a different body. +* [why email](https://github.com/mysociety/alaveteli/blob/master/app/views/help/_why_they_should_reply_by_email.rhtml): a snippet of information that explains why users should insist on replies by email. This is displayed next to requests that have "gone postal". The help pages contain some HTML. Your tech person should be able to advise on this. @@ -288,9 +287,9 @@ called Transifex. This website allows teams of translators to collaborate in one place, using a fairly easy interface. The Alaveteli page on Transifex is at -https://www.transifex.net/projects/p/alaveteli/; the translations all live in a +<https://www.transifex.com/projects/p/alaveteli/>; the translations all live in a single translation file called -[`app.pot`](https://www.transifex.net/projects/p/alaveteli/resource/apppot/). +[`app.pot`](https://www.transifex.com/projects/p/alaveteli/resource/apppot/). You can set up your language and provide translations there; you can also use specialise software on your own computer (see the help pages on Transifex) @@ -311,7 +310,7 @@ review the untranslated strings. ## Step five: Test drive the site For launch, the tech person should review the [Production Server Best -Practices](FIXME). +Practices]({{ site.baseurl }}running/server). A low-key launch, where you tell just a few trusted people about the site, is a very good idea. You can then track how things work, and gauge the responses of diff --git a/installing/ami.md b/installing/ami.md index 47dd95565..e2c113eba 100644 --- a/installing/ami.md +++ b/installing/ami.md @@ -19,16 +19,15 @@ server on an Amazon EC2 instance. This creates an instance that runs in development mode, so we wouldn't recommend you use it for a production system without changing the configuration. -If you haven't used Amazon Web Services before, then you can get a Micro -instance which will be [free for a year](http://aws.amazon.com/free/). You will -find that a micro instance isn't powerful enough for anything other very basic -testing of Alaveteli, however. +Unfortunately, Alaveteli will not run properly on a free Micro +instance due to the low amount of memory available on those +instances; you will need to use at least a Small instance, which +Amazon will charge for. -The AMI can be found in the EU West (Ireland) region, with the ID ami-0f24c678 -and name “Basic Alaveteli installation 2013-10-31”. You can launch an instance +The AMI can be found in the EU West (Ireland) region, with the ID ami-8603f4f1 +and name “Basic Alaveteli installation 2014-01-29”. You can launch an instance based on that AMI with [this -link](https://console.aws.amazon.com/ec2/home?region=eu-west-1#launchAmi=ami-0f2 -4c678). +link](https://console.aws.amazon.com/ec2/home?region=eu-west-1#launchAmi=ami-8603f4f1). When you create an EC2 instance based on that AMI, make sure that you choose Security Groups that allows at least inbound HTTP, HTTPS, SSH and, if you want diff --git a/installing/manual_install.md b/installing/manual_install.md index 6d17bd8e9..a155694a4 100644 --- a/installing/manual_install.md +++ b/installing/manual_install.md @@ -7,12 +7,12 @@ title: Manual installation # Manual Installation <p class="lead"> - The following instructions describe the step-by-step process for - installing Alavetli. <em>You don't necessarily need to do it this - way:</em> it's usually easier to use the - <a href="{{ site.baseurl }}installing/script">installation script</a> - or the - <a href="{{ site.baseurl }}installing/ami">Amazon EC2 AMI</a>. + The following instructions describe the step-by-step process for + installing Alaveteli. <em>You don't necessarily need to do it this + way:</em> it's usually easier to use the + <a href="{{ site.baseurl }}installing/script">installation script</a> + or the + <a href="{{ site.baseurl }}installing/ami">Amazon EC2 AMI</a>. </p> Note that there are [other ways to install Alaveteli]({{ site.baseurl }}installing). @@ -36,7 +36,7 @@ Next, get hold of the Alaveteli source code from github: git clone https://github.com/mysociety/alaveteli.git cd alaveteli -This will get the development branch, which has the latest (possibly buggy) +This will get the rails-3-develop branch, which has the latest (possibly buggy) code. If you don't want to add or try new features, swap to the master branch (which always contains the latest stable release): @@ -209,7 +209,7 @@ configuration for an MTA is beyond the scope of this document -- see this [example config for Exim4]({{ site.baseurl }}installing/email). Note that in development mode mail is handled by mailcatcher by default so -that you can see the mails in a browser - see http://mailcatcher.me/ for more +that you can see the mails in a browser - see [http://mailcatcher.me/](http://mailcatcher.me/) for more details. Start mailcatcher by running `bundle exec mailcatcher` in your application directory. @@ -421,7 +421,7 @@ include the following in an Apache configuration file: Under all but light loads, it is strongly recommended to run the server behind an http accelerator like Varnish. A sample varnish VCL is supplied in -`../conf/varnish-alaveteli.vcl`. +`conf/varnish-alaveteli.vcl`. It's strongly recommended that you run the site over SSL. (Set FORCE_SSL to true in config/general.yml). For this you will need an SSL certificate for your @@ -455,9 +455,8 @@ Notice the line `RequestHeader` that sets the `X-Forwarded-Proto` header. This is important. This ultimately tells Rails that it's serving a page over https and so it knows to include that in any absolute urls it serves. -Some [production server best practice -notes](https://github.com/mysociety/alaveteli/wiki/Production-Server-Best-Practi -ces) are evolving on the wiki. +We have some [production server best practice +notes]({{ site.baseurl}}running/server/). ## Upgrading Alaveteli diff --git a/search.md b/search.md new file mode 100644 index 000000000..d5d4b49f3 --- /dev/null +++ b/search.md @@ -0,0 +1,7 @@ +--- +layout: page +title: Search +--- +Search documentation +==================== +<gcse:searchresults-only></gcse:searchresults-only> |