diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ADMIN.md | 10 | ||||
| -rw-r--r-- | doc/CHANGES.md | 26 | ||||
| -rw-r--r-- | doc/INSTALL.md | 15 | ||||
| -rw-r--r-- | doc/THEMES.md | 2 |
4 files changed, 40 insertions, 13 deletions
diff --git a/doc/ADMIN.md b/doc/ADMIN.md index 07fe9398d..6248e6cfc 100644 --- a/doc/ADMIN.md +++ b/doc/ADMIN.md @@ -11,11 +11,9 @@ If you want to work on the CSS, you'll want to use $ gem install compass $ compass compile --config .compass/config.rb -The javascript is included in a funky way -[for reasons explained in this commit](https://github.com/sebbacon/adminbootstraptheme/commit/45a73d53fc9e8f0b728933ff58764bd8d0612dab). -To change it, edit the coffeescript at -`lib/view/general/admin.coffee`, and then do something like: +To change the JavaScript, edit `public/admin/javascripts/admin.coffee` +and then run: - $ coffee -o /tmp/ -c app/views/admin_general/admin.coffee - $ mv /tmp/admin.js app/views/admin_general/admin_js.erb + $ coffee -c public/admin/javascripts/admin.coffee +That will update `public/admin/javascripts/admin.js`.
\ No newline at end of file diff --git a/doc/CHANGES.md b/doc/CHANGES.md index 4720e5283..9ad605559 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -1,3 +1,27 @@ +# Version 0.14 + +## Highlighted features +* There is now an option to display a public body statistics page (currently not linked to from anywhere) showing bodies with the most requests, most successful requests, fewest successful requests, most overdue requests, and bodies that reply most frequently with "Not Held" - see Upgrade notes for how to turn this option on. (Mark Longair) +* Individual incoming and outgoing messages can be made hidden, or requester_only from the admin interface. +* Zip downloads now can be run in single-threaded instances, and use send_file rather than a redirect to serve up cached zip files. +* Starting to use factory_girl to generate model instances for use in specs - hopefully in the long term removing dependencies between specs, and allowing them to run faster once we can remove the loading of fixtures each time. +* Fix to allow public body list page to use current, not default locale, with optional fallback to default [issue #1000](https://github.com/mysociety/alaveteli/issues/1000) - see Upgrade notes for fallback option (Mark Longair) +* Fix to allow request titles composed of only unicode characters [issue #902](https://github.com/mysociety/alaveteli/issues/902) +* Fix for occasional errors caused by race conditions in xapian updates [issue #555](https://github.com/mysociety/alaveteli/issues/555) +* Diagnostic errors are now not shown for local requests, so that the user-facing error pages will be shown when running Alaveteli behind a proxy in production (Henare Degan) + +## Upgrade notes +* By default, Alaveteli will now serve up request zip files itself, which will occupy a Rails process until the file has been received. To pass these files off to Apache, and free up the Rails process, install the libapache2-mod-xsendfile package, and update your httpd.conf file with the new Sendfile clause at the end of config/httpd.conf-example). +* In your production install, from the Alaveteli directory (as the Alaveteli deploy user), run the following commands to remove the zip download directory from direct access by your webserver, and preserve any cached zip files: +`mkdir cache/zips/production/` +`mv cache/zips/download cache/zips/production/download` +`rm public/download` +* This release upgrades the assumed version of Ubuntu from lucid (10.04) to precise (12.04) +* This release upgrades rubygems in config/packages - version 1.8.15 is available from squeeze-backports on Debian or by default in Ubuntu precise. This upgrade may result in "invalid date format in specification:" errors - these should be fixable by manually deleting the gems specs that are being referenced in the error and re-running rails-post-deploy +* If you would like to have a public body statistics page (this will be publicly available), set the `PUBLIC_BODY_STATISTICS_PAGE` param in general.yml to `true`. You should also add a new cron job based on the one in config/crontab-example `https://github.com/mysociety/alaveteli/blob/rails-3-develop/config/crontab-example#L29` to update the public body stats each day. +* If you would like the public body list page to include bodies that have no translation in the current locale, but do have a translation in the default locale, add a `PUBLIC_BODY_LIST_FALLBACK_TO_DEFAULT_LOCALE` param set to `true` to your config/general.yml file. + + # Version 0.13 ## Highlighted features @@ -11,7 +35,7 @@ ## Upgrade notes * Check out this version and run `rails-post-deploy` as usual. -* This release includes an update to the commonlib submodule - you should now be warned about this on running `rails-post-deploy`. You can update to the nw version with `git submodule update`. +* This release includes an update to the commonlib submodule - you should now be warned about this on running `rails-post-deploy`. You can update to the new version with `git submodule update`. * After deploying, run `rake temp:fix_bad_request_states` to find and list requests that have an inconsistent history - run `rake temp:fix_bad_request_states DRYRUN=0` to fix them. # Version 0.12 diff --git a/doc/INSTALL.md b/doc/INSTALL.md index ea8871888..e466edd55 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -1,4 +1,4 @@ -These instructions assume Debian Squeeze (64-bit) or Ubuntu 10.04 LTS. +These instructions assume Debian Squeeze (64-bit) or Ubuntu 12.04 LTS (precise). [Install instructions for OS X](https://github.com/mysociety/alaveteli/wiki/OS-X-Quickstart) are under development. Debian Squeeze is the best supported deployment platform. @@ -27,12 +27,16 @@ master branch (which always contains the latest stable release): # Package pinning -You need to configure [apt-pinning](http://wiki.debian.org/AptPreferences#Pinning-1) preferences in order to prevent packages being pulled from the debian testing distribution in preference to the stable distribution once you have added the testing repository as described below. +You need to configure [apt-pinning](http://wiki.debian.org/AptPreferences#Pinning-1) preferences in order to prevent packages being pulled from the debian wheezy distribution in preference to the stable distribution once you have added the wheezy repository as described below. -In order to configure apt-pinning and to keep most packages coming from the Debian stable repository while installing the ones required from testing and the mySociety repository you need to run the following commands: +In order to configure apt-pinning and to keep most packages coming from the Debian stable repository while installing the ones required from wheezy and the mySociety repository you need to run the following commands: echo "Package: *" >> /tmp/preferences - echo "Pin: release a=testing">> /tmp/preferences + echo "Pin: release a=squeeze-backports">> /tmp/preferences + echo "Pin-Priority: 200" >> /tmp/preferences + echo "" >> /tmp/preferences + echo "Package: *" >> /tmp/preferences + echo "Pin: release a=wheezy">> /tmp/preferences echo "Pin-Priority: 50" >> /tmp/preferences sudo cp /tmp/preferences /etc/apt/ rm /tmp/preferences @@ -48,7 +52,8 @@ If you are running Debian, add the following repositories to `/etc/apt/sources.list` and run `apt-get update`: deb http://debian.mysociety.org squeeze main - deb http://ftp.debian.org/debian/ testing main non-free contrib + deb http://ftp.debian.org/debian/ wheezy main non-free contrib + deb http://backports.debian.org/debian-backports squeeze-backports main contrib non-free The repositories above allow us to install the packages `wkhtmltopdf-static` and `bundler` using `apt`; so if you're running diff --git a/doc/THEMES.md b/doc/THEMES.md index bae7d7665..d6109cdc5 100644 --- a/doc/THEMES.md +++ b/doc/THEMES.md @@ -64,7 +64,7 @@ add custom help pages, as described below. # 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. +Alaveteli site live in `app/views/`. They use Rails' ERB syntax. For example, the template for the home page lives at `app/views/general/frontpage.html.erb`, and the template for the "about us" page is at `app/views/help/about.html.erb`. |