diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CHANGES.md | 16 | ||||
| -rw-r--r-- | doc/INSTALL.md | 23 | ||||
| -rw-r--r-- | doc/THEMES.md | 14 |
3 files changed, 37 insertions, 16 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md index 920c397de..34959f924 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -1,8 +1,24 @@ +# Version 0.6.2 +## Highlighted features + +* This is a minor release to fix small bugs in documentation and install/upgrade process +* It also includes support for [Continuous Integration using Travis](http://travis-ci.org/) + +## Upgrade notes + +* No special action required -- just check out this version and run + `rails-post-deploy` as usual. + # Version 0.6.1 ## Highlighted features * Fixes important security bug [issue #515](https://github.com/sebbacon/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 + documentation. * [Full list of changes on github](https://github.com/sebbacon/alaveteli/issues?milestone=8&state=closed) ## Upgrade notes diff --git a/doc/INSTALL.md b/doc/INSTALL.md index ef354c5ce..b71b89676 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -33,15 +33,17 @@ used to parse documents, host the site, etc. There are also packages that contain headers necessary to compile some of the gem dependencies in the next step. -If you are running Debian, you can use specially compiled mysociety -packages by adding the following to `/etc/apt/sources.list` and -running `apt-get update`: +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 -If you don't set up that mySociety Debian source (e.g. if you're -running Ubuntu), you should comment out `wkhtmltopdf-static` from -`config/packages`, as it won't install in the next step +The repositories above allow us to install the packages +`wkthmltopdf-static` and `bundler` using `apt`; so if you're running +Ubuntu, you won't be able to use the above repositories, and you will +need to comment out those two lines in `config/packages` before +following the next step (and install bundler manually). Now install the packages that are listed in config/packages using apt-get e.g.: @@ -54,7 +56,7 @@ Some of the files also have a version number listed in config/packages # Install Ruby dependencies -Install rubygems 1.6.1 (we're not using the Debian package because we +Install rubygems 1.6.2 (we're not using the Debian package because we need an older version; see "Troubleshooting" below for an explanation): @@ -316,6 +318,9 @@ like `!!(*= $this *)!!`. The variables are: * `user`: the user that the software runs as * `site`: a string to identify your alaveteli instance +There is a dumb python script at `script/make-crontab` which you can +edit and run to do some basic substitution for you. + One of the cron jobs refers to a script at `/etc/init.d/foi-alert-tracks`. This is an init script, a copy of which lives in `config/alert-tracks-debian.ugly`. As with the cron @@ -471,8 +476,4 @@ various other things that can be automated for deployment. deployments), you may need to do something like: ln -s /usr/lib/ruby/gems/1.8/bin/rake /usr/local/bin/ - - Or (Debian): - - ln -s /usr/lib/ruby/gems/1.8/bin/rake /usr/local/bin/ diff --git a/doc/THEMES.md b/doc/THEMES.md index 50335c082..e33371df7 100644 --- a/doc/THEMES.md +++ b/doc/THEMES.md @@ -36,13 +36,17 @@ places: This document is about what you can do in a theme. -To get started, install the sample theme by running +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: ./script/plugin install git://github.com/sebbacon/alavetelitheme.git -This downloads and installs the theme in -`vendor/plugins/alavetelitheme` and contains examples for nearly -everything you might want to customise. +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. # Make sure your theme is as lightweight as possible @@ -81,7 +85,7 @@ instead of the core "about us" file. Rails expects all its stylesheets to live at `<railshome>/public`, which presents a problem for plugins. Here's how we solve it: the stylesheet and associated resources for your theme live (by -convention) in at `alavetelitheme/public/`. This is symlinked from +convention) in `alavetelitheme/public/`. This is symlinked from the main Rails app -- see `alavetelitheme/install.rb` to see how this happens. |