aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/CHANGES.md19
-rw-r--r--doc/INSTALL-exim4.md4
-rw-r--r--doc/INSTALL.md4
-rw-r--r--doc/THEMES.md12
4 files changed, 29 insertions, 10 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md
index e53dcfe0b..f0e98b1d7 100644
--- a/doc/CHANGES.md
+++ b/doc/CHANGES.md
@@ -1,3 +1,20 @@
+# Version 0.12
+## Highlighted features
+* Remove support for theme stylesheet inclusion via template (deprecated in version 0.5)
+* Addition of a simple JSON API for querying the Ruby and Alaveteli version of an Alaveteli instance - made available at /version.json (Matthew Landauer)
+* Users can now give more information when reporting a request as unsuitable (Matthew Landauer)
+* The donation url presented to users when they report their request as successful or partially successful is now option and the url itself can be configured using the config param DONATION_URL
+* Internal review request text is now translatable
+* config/crontab.ugly is now config/crontab-example
+* Search query highlighting should now work with non-ascii characters [issue #505](https://github.com/mysociety/alaveteli/issues/505) (Matthew Landauer)
+* A bug that allowed people to sign up with email addresses with spaces in them has been fixed [issue #980](https://github.com/mysociety/alaveteli/issues/980)
+
+* [List of issues on github](https://github.com/mysociety/alaveteli/issues?milestone=30&state=closed)
+
+## Upgrade notes
+* Check out this version and run `rails-post-deploy` as usual.
+* Add a DONATION_URL to your config/general.yml file if you want to use your own donation URL.
+
# Version 0.11
## Highlighted features
* Upgrade of the Rails framework to version 3.1.12 (Henare Degan, Matthew Landauer, Mark Longair, Louise Crow)
@@ -5,7 +22,7 @@
## Upgrade notes
* Manually remove vendor/rails-locales
* Themes created for 0.9 and below should be updated to work with Rails 3. See `THEMES-UPGRADE.md` for notes on upgrading your theme. You will need to manually remove your old theme directory before running `rails-post-deploy`.
-* The `config/httpd.conf` has moved to `config/httpd.conf`, as it may need customization before deploying. It also has a new line setting RackEnv to production - copy this to your config/httpd.conf file.
+* The `config/httpd.conf` has moved to `config/httpd.conf-example`, as it may need customization before deploying. It also has a new line setting RackEnv to production - copy this to your config/httpd.conf file.
* Alaveteli now uses the [mail gem](https://github.com/mikel/mail) rather than [tmail](https://github.com/mikel/tmail) to handle mail. If you're using Exim as your MTA, you'll need to use the setting `extract_addresses_remove_arguments = false` in your Exim conf (see INSTALL-exim4.md for details). This means it won't remove addresses specified with -t on command line from the mail recipient list.
# Version 0.9
diff --git a/doc/INSTALL-exim4.md b/doc/INSTALL-exim4.md
index cdc33ab12..796fb295c 100644
--- a/doc/INSTALL-exim4.md
+++ b/doc/INSTALL-exim4.md
@@ -15,7 +15,9 @@ Note that the name and location of the log files created by Exim must match
what the `load-mail-server-logs` script expects, hence the need for the extra
`log_file_path` setting. And the `check-recent-requests-sent` scripts expects
the logs to contain the `from=<...>` envelope information, so we make the
-logs more verbose with `log_selector`.
+logs more verbose with `log_selector`. The ALAVETELI_USER may need to also
+need to be added to the `trusted_users` list in your Exim config in order to
+set the return path on outgoing mail, depending on your setup.
In `/etc/exim4/conf.d/router/04_alaveteli`:
diff --git a/doc/INSTALL.md b/doc/INSTALL.md
index b6e8d2265..b356208a4 100644
--- a/doc/INSTALL.md
+++ b/doc/INSTALL.md
@@ -307,9 +307,9 @@ by setting `SKIP_ADMIN_AUTH` to `true` in `general.yml`.
# Cron jobs and init scripts
-`config/crontab.ugly` contains the cronjobs run on WhatDoTheyKnow.
+`config/crontab-example` contains the cronjobs run on WhatDoTheyKnow.
It's in a strange templating format they use in mySociety. mySociety
-render the "ugly" file to reference absolute paths, and then drop it
+render the example file to reference absolute paths, and then drop it
in `/etc/cron.d/` on the server.
The `ugly` format uses simple variable substitution. A variable looks
diff --git a/doc/THEMES.md b/doc/THEMES.md
index 8c4b927da..bae7d7665 100644
--- a/doc/THEMES.md
+++ b/doc/THEMES.md
@@ -36,15 +36,15 @@ places:
This document is about what you can do in a theme.
-By default, the sample theme ("alavetelitheme") has already been
-installed. See the setting `THEME_URLS` in `general.yml` for an
+By default, the sample theme ("alavetelitheme") has already been
+installed. See the setting `THEME_URLS` in `general.yml` for an
explanation.
You can also install the sample theme by hand, by running:
- bundle exec rails plugin install git://github.com/mysociety/alavetelitheme.git -r rails-3
+ bundle exec rails plugin install git://github.com/mysociety/alavetelitheme.git
-The sample theme contains examples for nearly everything you might
+The sample theme contains examples for nearly everything you might
want to customise. You should probably make a copy, rename it, and
use that as the basis for your own theme.
@@ -61,7 +61,7 @@ changing much in the core theme. The ideal would be if you are able
to rebrand the site by only changing the CSS. You will also need to
add custom help pages, as described below.
-# Branding the site
+# Branding the site
The core templates that comprise the layout and user interface of an
Alaveteli site live in `app/views/`. They are use Rails' ERB syntax.
@@ -158,7 +158,7 @@ unused).
`alavetelitheme/lib/config/custom-routes.rb` allows you to extend the base routes in
Alaveteli. The example in `alavetelitheme` adds an extra help page.
You can also use this to override the behaviour of specific pages if
-necessary.
+necessary.
# Adding or overriding models and controllers