diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CHANGES.md | 81 | ||||
| -rw-r--r-- | doc/INSTALL.md | 15 | ||||
| -rw-r--r-- | doc/THEME-ASSETS-UPGRADE.md | 7 |
3 files changed, 95 insertions, 8 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md index 45b8c3cc9..70571dbfa 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -1,3 +1,84 @@ +# rails-3-develop + +## Highlighted features + +* There is a new form for users to request that a new authority should + be added, or to request an update to the contact email used for an + authority. Site admins are emailed about these requests, and can + resolve them from the admin interface. + +## Upgrade notes + +* If your theme overrides the help/requesting template, you should + update the link in the section on requesting new authorities so the + link points to `<%= new_change_request_path %>` instead of `<%= + help_contact_path %>`. + +# Version 0.16 + +## Highlighted features + +* Upgrade of the Rails framework to 3.2.16 +* Enabling the Rails asset pipeline for managing assets (more about the + asset pipeline at http://guides.rubyonrails.org/asset_pipeline.html). +* The all authorities csv download now uses less system resources +* Ruby 2.0 is now included in the matrix of versions we run continuous + integration tests against +* When using capistrano, the RAILS_ENV can now be explicitly set from + deploy.yml +* The front page and request pages once more use fragment caching backed + by memcached to speed up serving of slow parts of these pages +* The robots.txt file has been updated to allow crawling of response + attachment files (in original and HTML versions) +* The `themes:install` rake task is kinder to developers; it no longer + removes and reclones themes, destroying local changes, and it keeps + themes as git repositories. +* Social media elements (the blog, twitter feed) are only included if + the appropriate config variables (BLOG_FEED and TWITTER_USERNAME) have + been populated. +* Some fixes to the treatment of hyphenated/underscored locales so that + public body translations are consistently stored using the underscore + format of the locale (so 'he_IL', not 'he-IL'). +* The popup message elements for temporary notices and for letting users + know about other sites have been made consistent and now use simpler + styles. + +## Upgrade notes + +* You will need to update your theme to use the asset pipeline - notes + on how to do this are in doc/THEME-ASSETS-UPGRADE.md +* The syntax of the highlight and excerpt methods has changed, so if you + use these in your theme, you may see deprecation warnings until you + update them. More information at http://apidock.com/rails/v3.2.13/ActionView/Helpers/TextHelper/highlight + and + http://apidock.com/rails/v3.2.13/ActionView/Helpers/TextHelper/excerpt +* If you don't want to use fragment caching, you can turn it off in your + config file by setting `CACHE_FRAGMENTS` to `false`. +* If you use a locale with an underscore in it, you should double check + that the locale field of your `public_body_translations` table shows + the underscore version of the locale name. +* This release includes an update to the commonlib submodule - you + should be warned about this when running rails-post-deploy +* All code has been moved out of the deprecated plugin path + `vendor/plugins`. Once you are up and running under 0.16, you should + check that your xapian databases have all been copied to + `lib/acts_as_xapian/xapiandbs` (the code in + `config/initializers/acts_as_xapian` should do this), and then check + and remove any files under vendor/plugins so that you won't get + deprecation warnings about having Rails 2.3 style plugins (deprecation + warnings can result in incoming mail getting an auto reply under some + email configs). +* If you have any custom styles that rely on the absolute positioning + of the 'banner' and 'wrapper' elements, they may need to be updated. +* Cached HTML versions of attachments in cache/attachments_production/ + will have obsolete links to `/stylesheets/main.css` and + `/images/navimg/logo-trans-small.png`. You can resolve these by either + moving the cached attachments away and allowing them to be regenerated + on demand, or by symlinking `public/stylesheets/main.css` to + `public/assets/application.css` and + `public/images/navimg/logo-trans-small.png` to + `public/assets/navimg/logo-trans-small.png`. + # Version 0.15 ## Highlighted features diff --git a/doc/INSTALL.md b/doc/INSTALL.md index f39789936..04cdb1352 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -15,16 +15,15 @@ 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 based on that AMI with -[this link](https://console.aws.amazon.com/ec2/home?region=eu-west-1#launchAmi=ami-0f24c678). +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-8603f4f1). When you create an EC2 instance based on that AMI, make sure that you choose Security Groups that allows at least inbound diff --git a/doc/THEME-ASSETS-UPGRADE.md b/doc/THEME-ASSETS-UPGRADE.md index 66a1e95f4..12c1a60d1 100644 --- a/doc/THEME-ASSETS-UPGRADE.md +++ b/doc/THEME-ASSETS-UPGRADE.md @@ -33,6 +33,8 @@ tag to use `image_tag` instead. For example, instead of: image_tag('helpmeinvestigate.png', :alt => "", :class => "rss") +If you have a favicon.ico file in your theme's `public` directory, you should move it to `assets/images` as well. + You should similarly move your stylesheets into `assets/stylesheets`. If a stylesheet refers to images, you should rename the `.css` file to `.css.scss`, and change `url` @@ -67,3 +69,8 @@ should be mentioned in `lib/alavetelitheme.rb` with: You should be left with nothing in the `public` directory after making these changes, except possibly custom error pages. + +Remove the code that symlinks the theme 'public' directory to a +subdirectory of the main application's 'public' directory from +install.rb. Also remove the code from uninstall.rb that removes that +symlink. The asset pipeline will handle making assets available. |