diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/ADMIN.md | 19 | ||||
| -rw-r--r-- | doc/CHANGES.md | 57 | ||||
| -rw-r--r-- | doc/INSTALL.md | 9 | ||||
| -rw-r--r-- | doc/THEME-ASSETS-UPGRADE.md | 76 | ||||
| -rw-r--r-- | doc/TRANSLATE.md | 2 |
5 files changed, 138 insertions, 25 deletions
diff --git a/doc/ADMIN.md b/doc/ADMIN.md deleted file mode 100644 index 6248e6cfc..000000000 --- a/doc/ADMIN.md +++ /dev/null @@ -1,19 +0,0 @@ -Doing development work on the administration interface -====================================================== - -The Alaveteli admin interface uses Twitter's Bootstrap project to prettify it. - -If you want to work on the CSS, you'll want to use -[bootstrap-sass](https://github.com/thomas-mcdonald/bootstrap-sass). Do something like: - - - $ gem install bootstrap-sass - $ gem install compass - $ compass compile --config .compass/config.rb - -To change the JavaScript, edit `public/admin/javascripts/admin.coffee` -and then run: - - $ 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 45b8c3cc9..b4bed110b 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -1,3 +1,60 @@ +# 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. + # Version 0.15 ## Highlighted features diff --git a/doc/INSTALL.md b/doc/INSTALL.md index f39789936..3decb53a3 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -15,11 +15,10 @@ 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 diff --git a/doc/THEME-ASSETS-UPGRADE.md b/doc/THEME-ASSETS-UPGRADE.md new file mode 100644 index 000000000..12c1a60d1 --- /dev/null +++ b/doc/THEME-ASSETS-UPGRADE.md @@ -0,0 +1,76 @@ +This document has notes on switching your Alaveteli theme to use +the Rails asset pipeline. + +Firstly, add the following to your `lib/alavetelitheme.rb`, in +order to add the subdirectories of your theme's `assets` +directory to `config.assets.path`: + + # Prepend the asset directories in this theme to the asset path: + ['stylesheets', 'images', 'javascripts'].each do |asset_type| + theme_asset_path = File.join(File.dirname(__FILE__), + '..', + 'assets', + asset_type) + Rails.application.config.assets.paths.unshift theme_asset_path + end + +In the root of your theme, create these directories: + + assets + \ images + \ stylesheets + \ javascripts + +i.e. `assets` is at the same level as `lib` and `locale-theme`. + +Move any image files from `public/images` to `assets/images`. +Now change any references to those images with a literal `<img>` +tag to use `image_tag` instead. For example, instead of: + + <img src="/images/helpmeinvestigate.png" alt="" class="rss"> + +... you should have: + + 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` +to the sass-rails `image-url` helper. e.g. instead of: + + background-image: url(../images/mysociety.png); + +... you should have: + + background-image: image-url('mysociety.png'); + +If your only stylesheet is called `custom.css`, as in the +example theme, you shouldn't need to make any other changes to +the CSS. If you have added additional stylesheets +(e.g. `extra.css`), then you'll need to both: + +1. add them to +`lib/views/general/_stylesheet_includes.html.erb`, for example +with: + + <%= stylesheet_link_tag "extra" %> + +2. add the following in `lib/alavetelitheme.rb`: + + config.assets.precompile.push 'extra.css' + +Any custom Javascript should be moved to `assets/javascripts` in +your theme directory, and, simlarly to the additional CSS, it +should be mentioned in `lib/alavetelitheme.rb` with: + + config.assets.precompile.push 'fancy-effects.js' + +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. diff --git a/doc/TRANSLATE.md b/doc/TRANSLATE.md index 2a8b0269e..aef2cfdc9 100644 --- a/doc/TRANSLATE.md +++ b/doc/TRANSLATE.md @@ -79,7 +79,7 @@ must: language, using `bundle exec rake gettext:store_model_attributes`, followed by `bundle exec rake gettext:find` - * careful of including msgids from themes in `vendor/plugin`; + * careful of including 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 |