diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CHANGES.md | 44 | ||||
| -rw-r--r-- | doc/INSTALL.md | 14 | ||||
| -rw-r--r-- | doc/THEMES.md | 4 | ||||
| -rw-r--r-- | doc/TRANSLATE.md | 2 |
4 files changed, 39 insertions, 25 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md index 42f408bab..ae9418ef4 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -1,8 +1,22 @@ +# Version 0.6.5 +* This is a minor release, to update all documentation and example files to reflect the move of the official repository to http://github.com/mysociety/alaveteli and the alavetelitheme and adminbootstraptheme themes to http://github.com/mysociety/alavetelitheme and http://github.com/mysociety/adminbootstraptheme respectively. +* Some basic versioning has been added for themes. An ALAVETELI_VERSION constant has been added in config/environment.rb. When loading themes, `rails-post-deploy` now looks for a tag on the theme repository in the form 'use-with-alaveteli-0.6.5' that matches the ALAVETELI_VERSION being deployed - if it finds such a tag, the theme will be checked out from that tag, rather than from the HEAD of the theme repository. If no such tag is found, HEAD is used, as before [issue #573](https://github.com/mysociety/alaveteli/issues/573). +* Apache has been configured to serve cached HTML versions of attached files (and associated images) directly from the file cache, as well as the original versions [issue #580](https://github.com/mysociety/alaveteli/issues/580). +* PublicBodyCategories have a couple of new methods for more easily working with headings [issue #575](https://github.com/mysociety/alaveteli/issues/575). + +* [List of issues on github](https://github.com/mysociety/alaveteli/issues?milestone=21&state=closed) + +## Upgrade notes + +* Please update your `THEME_URLS` to point to http://github.com/mysociety/alavetelitheme and http://github.com/mysociety/adminbootstraptheme if you are using the alavetelitheme or adminbootstraptheme themes. + +* Check out this version and run `rails-post-deploy` as usual. + # Version 0.6.4 ## Highlighted features * This is a minor bugfix release, mainly to fix bugs related to external request handling. -* [List of issues on github](https://github.com/sebbacon/alaveteli/issues?milestone=18&state=closed) -* [List of commits since last release](https://github.com/sebbacon/alaveteli/compare/master...release/0.6.4) +* [List of issues on github](https://github.com/mysociety/alaveteli/issues?milestone=18&state=closed) +* [List of commits since last release](https://github.com/mysociety/alaveteli/compare/master...release/0.6.4) ## Upgrade notes @@ -22,7 +36,7 @@ customisation in themes * Themes can now provide a `post_install.rb` script that is executed by `rails-post-deploy` -* [List of issues on github](https://github.com/sebbacon/alaveteli/issues?milestone=17&state=closed) +* [List of issues on github](https://github.com/mysociety/alaveteli/issues?milestone=17&state=closed) ## Upgrade notes @@ -43,14 +57,14 @@ # Version 0.6.1 ## Highlighted features -* Fixes important security bug [issue #515](https://github.com/sebbacon/alaveteli/issues/515) +* Fixes important security bug [issue #515](https://github.com/mysociety/alaveteli/issues/515) * Show admin nav bar when browsing main site * A new API for adding requests and correspondence to an Alaveteli instance, designed for use by public bodies that wish to use Alaveteli as a disclosure log. See - [the wiki](https://github.com/sebbacon/alaveteli/wiki/API) for some + [the wiki](https://github.com/mysociety/alaveteli/wiki/API) for some documentation. -* [Full list of changes on github](https://github.com/sebbacon/alaveteli/issues?milestone=8&state=closed) +* [Full list of changes on github](https://github.com/mysociety/alaveteli/issues?milestone=8&state=closed) ## Upgrade notes @@ -87,9 +101,9 @@ and sends the user an email explaining why. * A bug which prevented locales containing underscores (e.g. `en_GB`) was fixed - ([issue #503](https://github.com/sebbacon/alaveteli/issues/503)) + ([issue #503](https://github.com/mysociety/alaveteli/issues/503)) * Error pages are now presented with styling from themes -* [Full list of changes on github](https://github.com/sebbacon/alaveteli/issues?milestone=13&state=closed) +* [Full list of changes on github](https://github.com/mysociety/alaveteli/issues?milestone=13&state=closed) ## Upgrade notes @@ -178,7 +192,7 @@ We now have a most of a Czech translation (thanks Josef Pospisil!) Finally, this release also addresses a number of small bugs, including the (potentially) important issue #408. -As usual, there is a [full list of changes on github](https://github.com/sebbacon/alaveteli/issues?milestone=9&state=closed) +As usual, there is a [full list of changes on github](https://github.com/mysociety/alaveteli/issues?milestone=9&state=closed) ## Upgrade notes @@ -194,16 +208,16 @@ As usual, there is a [full list of changes on github](https://github.com/sebbaco * When listing authorities, show all authorities in default locale, rather than only those in the currently selected locale. * Ensure incoming emails are only ever parsed once (should give a performance boost) * Added a simple rate-limiting feature: restrict the number of requests users can make per day, except if explicitly unrestricted in the admin interface -* [Full list of changes on github](https://github.com/sebbacon/alaveteli/issues?state=closed&milestone=9) +* [Full list of changes on github](https://github.com/mysociety/alaveteli/issues?state=closed&milestone=9) ## Upgrade notes -* **IMPORTANT! We now depend on Xapian 1.2**, which means you may need to install Xapian from backports. See [issue #159](https://github.com/sebbacon/alaveteli/issues/159) for more info. +* **IMPORTANT! We now depend on Xapian 1.2**, which means you may need to install Xapian from backports. See [issue #159](https://github.com/mysociety/alaveteli/issues/159) for more info. * Themes created for 0.4 and below should be changed to match the new format (although the old way should continue to work): * You should create a resources folder at `<yourtheme>/public/` and symlink to it from the main rails app. See the `install.rb` in `alaveteli-theme` example theme for details. * Your styles should be moved from `general/custom_css.rhtml` to a standalone stylesheet in `<yourtheme>/public/stylesheets/` * The partial at `general/_before_head_end.rhtml` should be changed in the theme to include this stylesheet -* [issue #281](https://github.com/sebbacon/alaveteli/issues/281) fixes some bugs relating to display of internationalised emails. To fix any wrongly displayed emails, you'll need to run the script at `script/clear-caches` so that the caches can be regenerated -* During this release, a bug was discovered in pdftk 1.44 which caused it to loop forever. Until it's incorporated into an official release, you'll need to patch it yourself or use the Debian package compiled by mySociety (see link in [issue 305](https://github.com/sebbacon/alaveteli/issues/305)) +* [issue #281](https://github.com/mysociety/alaveteli/issues/281) fixes some bugs relating to display of internationalised emails. To fix any wrongly displayed emails, you'll need to run the script at `script/clear-caches` so that the caches can be regenerated +* During this release, a bug was discovered in pdftk 1.44 which caused it to loop forever. Until it's incorporated into an official release, you'll need to patch it yourself or use the Debian package compiled by mySociety (see link in [issue 305](https://github.com/mysociety/alaveteli/issues/305)) * Ensure you have values for new config variables (see `config/general.yml-example`): * EXCEPTION_NOTIFICATIONS_FROM * EXCEPTION_NOTIFICATIONS_TO @@ -220,7 +234,7 @@ As usual, there is a [full list of changes on github](https://github.com/sebbaco See the new instructions in INSTALL-exim4.md for details of how to set this up. * Logged in users now have the ability to download a zipfile of the entire correspondence for a request * Improved UI for responding to requests. The user now has a single option to "reply" at the bottom of a request, and can adjust who they are replying to on the next page -* [Full list of changes on github](https://github.com/sebbacon/alaveteli/issues?sort=created&direction=desc&state=closed&milestone=7) +* [Full list of changes on github](https://github.com/mysociety/alaveteli/issues?sort=created&direction=desc&state=closed&milestone=7) ## Upgrade notes * Remember to `rake db:migrate` and `git submodule update` @@ -248,4 +262,4 @@ As usual, there is a [full list of changes on github](https://github.com/sebbaco * Introduce reCaptcha for people apparently coming from foreign countries (to combat spam) (requires values for new config variables `ISO_COUNTRY_CODE` and `GAZE_URL`, and existing config variables `RECAPTCHA_PUBLIC_KEY` and `RECAPTCHA_PRIVATE_KEY`) * Better admin interface for editing multiple translations of a public body at once ## Other -* [Full list of changes on github](https://github.com/sebbacon/alaveteli/issues?milestone=5&state=closed) +* [Full list of changes on github](https://github.com/mysociety/alaveteli/issues?milestone=5&state=closed) diff --git a/doc/INSTALL.md b/doc/INSTALL.md index 588f8e4fe..62c5071ca 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -1,12 +1,12 @@ These instructions assume Debian Squeeze or Ubuntu 10.04 LTS. -[Install instructions for OS X](https://github.com/sebbacon/alaveteli/wiki/OS-X-Quickstart) +[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. Commands are intended to be run via the terminal or over ssh. As an aid to evaluation, there is an -[Amazon AMI](https://github.com/sebbacon/alaveteli/wiki/Alaveteli-ec2-ami) +[Amazon AMI](https://github.com/mysociety/alaveteli/wiki/Alaveteli-ec2-ami) with all these steps configured. It is *not* production-ready. # Get Alaveteli @@ -16,7 +16,7 @@ install git-core` Next, get hold of the Alaveteli source code from github: - git clone https://github.com/sebbacon/alaveteli.git + git clone https://github.com/mysociety/alaveteli.git cd alaveteli This will get the development branch, which has the latest (possibly @@ -103,7 +103,7 @@ in certain edge conditions. Until it's incorporated into an official release, you can either hope you don't encounter the bug (it ties up a rails process until you kill it) you'll need to patch it yourself or use the Debian package compiled by mySociety (see link in -[issue 305](https://github.com/sebbacon/alaveteli/issues/305)) +[issue 305](https://github.com/mysociety/alaveteli/issues/305)) # Configure Database @@ -329,7 +329,7 @@ similar init script, which is optional and not required if you choose not to run your site behind Varnish (see below). The cron jobs refer to a program `run-with-lockfile`. See -[this issue](https://github.com/sebbacon/alaveteli/issues/112) for a +[this issue](https://github.com/mysociety/alaveteli/issues/112) for a discussion of where to find this program, and how you might replace it. @@ -351,7 +351,7 @@ server behind an http accelerator like Varnish. A sample varnish VCL is supplied in `../conf/varnish-alaveteli.vcl`. Some -[production server best practice notes](https://github.com/sebbacon/alaveteli/wiki/Production-Server-Best-Practices) +[production server best practice notes](https://github.com/mysociety/alaveteli/wiki/Production-Server-Best-Practices) are evolving on the wiki. # Upgrading Alaveteli @@ -450,7 +450,7 @@ various other things that can be automated for deployment. set document.codepage.force_assumed = 1 You should also check that your locale is set up correctly. See - [https://github.com/sebbacon/alaveteli/issues/128#issuecomment-1814845](this issue followup) + [https://github.com/mysociety/alaveteli/issues/128#issuecomment-1814845](this issue followup) for further discussion. * **I'm getting lots of `SourceIndex.new(hash) is deprecated` errors when running the tests** diff --git a/doc/THEMES.md b/doc/THEMES.md index e33371df7..6c22764fc 100644 --- a/doc/THEMES.md +++ b/doc/THEMES.md @@ -42,7 +42,7 @@ explanation. You can also install the sample theme by hand, by running: - ./script/plugin install git://github.com/sebbacon/alavetelitheme.git + ./script/plugin install git://github.com/mysociety/alavetelitheme.git The sample theme contains examples for nearly everything you might want to customise. You should probably make a copy, rename it, and @@ -112,7 +112,7 @@ locale you support. # Customising the request states As mentioned above, if you can possibly live with the -[default Alaveteli request statuses](https://github.com/sebbacon/alaveteli/wiki/Alaveteli's-request-statuses), +[default Alaveteli request statuses](https://github.com/mysociety/alaveteli/wiki/Alaveteli's-request-statuses), it would be good to do so. Note that you can set how many days counts as "overdue" in the main site config file. diff --git a/doc/TRANSLATE.md b/doc/TRANSLATE.md index 543c16cd9..abf47add3 100644 --- a/doc/TRANSLATE.md +++ b/doc/TRANSLATE.md @@ -84,4 +84,4 @@ must: # Translations: developers' view -See the [I18n guide](https://github.com/sebbacon/alaveteli/wiki/I18n-guide) on the wiki. +See the [I18n guide](https://github.com/mysociety/alaveteli/wiki/I18n-guide) on the wiki. |