diff options
| -rw-r--r-- | alaveteli-doc-master.txt | 23 | ||||
| -rw-r--r-- | docs/developers/api.md | 6 | ||||
| -rw-r--r-- | docs/installing/manual_install.md | 4 |
3 files changed, 20 insertions, 13 deletions
diff --git a/alaveteli-doc-master.txt b/alaveteli-doc-master.txt index 875cb25f3..593bde09e 100644 --- a/alaveteli-doc-master.txt +++ b/alaveteli-doc-master.txt @@ -17,19 +17,22 @@ These pages (in the wiki) have work/attention still pending: [ ] [ ] Administrator's manual TODO -- needs to be implemented [no] [??] Caching currently implemented <-- TODO if needed (seems old) -[no] [ok] Current project status <-- but TODO facts from here prob should be represented on the .org site -[??] [ ] Features <-- not sure this is for documentation, but is for the website -- see https://github.com/mysociety/alaveteli/issues/1350 -[no] [x?] I18n approach -- seems out of date, since gettext is used now, but provides historical justification for how this was done (linked-to from i18n in wiki) -[ ] [ ] I18n guide } developers/i18n maybe: see also http://mysociety.github.io/internationalization.html -[??] [do] Improved document conversion <-- some of this needs to go into docs, some is a proposal -[??] [ok] List of foi websites and projects <-- perhaps should be in the site, but not really a docs issue just now -[??] [x ] Local customization; Initial setup and administration <-- no info, but good questions: where should this go? -[>>] [? ] Marking up text for translation <-- needs writing as part of specific Alavateli i18n, but +[no] [no] Current project status <-- moved onto the intranet Twiki +[no] [no] Features -- see https://github.com/mysociety/alaveteli/issues/1350 +[no] [no] I18n approach +[ok] [no] I18n guide } developers/i18n maybe: see also http://mysociety.github.io/internationalization.html +[no] [ok] Improved document conversion kept on wiki +[ok] [ok] List of foi websites and projects <-- keep non-production alaveteli and non-alaveteli in the wiki, rest are in the site **TODO**: move the alaveteli ones to the Twiki so we keep the repo links (e.g. Hungarian fork on their own github) etc. The rest remain there -- and put a link to the "live" page on http://alaveteli.org/deployments/ +[no] [ok] Local customization; Initial setup and administration <-- no info, but good questions: where should this go? (moved into an issue #1651) +[ok] [no] Marking up text for translation <-- needs writing as part of specific Alavateli i18n, but linking to http://mysociety.github.io/internationalization.html -[>>] [no] Setting up a demo site <-- TODO should be in the docs, a useful page with some overlap +[>>] [x ] Setting up a demo site <-- TODO should be in the docs, presumably into the EC2/AMI installation page + The section on Localisation (pulling in Transifex translations) should probably end up in + http://alaveteli.org/docs/developers/i18n/#deployment-notes + since the wiki notes are more detailed than the docs at the moment -These pages are form the repo's doc/ directory +These pages are from the repo's doc/ directory ---------------------------------------------- [no] [ok] CHANGES.md diff --git a/docs/developers/api.md b/docs/developers/api.md index cbd4c7c85..1e6c15cfd 100644 --- a/docs/developers/api.md +++ b/docs/developers/api.md @@ -22,7 +22,7 @@ these ways: * Look for the RSS feed links. * Examine the `<link rel="alternate" type="application/atom+xml">` tag in the head of the HTML. -* Add `/feed` to the start of another URL. +* Add `/feed` to the start of another URL. Note that even complicated search queries have Atom feeds. You can do all sorts of things with them, such as query by authority, by file type, by date range, @@ -73,9 +73,13 @@ as follows: * as form variable `json`: * `direction` - either `request` (from the user - might be a followup, reminder, etc) or `response` (from the authority) * `body` - the message itself + * `state` - optional, allows the authority to include an updated request `state` value when sending an update. Allowable values: `waiting_response`, `rejected`, `successful` and `partially_successful`. Only used in the `response` direction * `sent_at` - ISO-8601 formatted time that the correspondence was sent * (optionally) the variable `attachments` as `multipart/form-data`: * attachments to the correspondence. Attachments can only be attached to messages in the `response` direction +* `/api/v2/request/<id>/update.json` - POST a new state for the request: + * as form variable `json`: + * `state` - the user's assessment of the `state` of a request that has received a response from the authority. Allowable values: `waiting_response`, `rejected`, `successful` and `partially_successful`. Should only be used for the user's feedback, an authority wishing to update the request `state` should use `/api/v2/request/<id>.json` instead diff --git a/docs/installing/manual_install.md b/docs/installing/manual_install.md index 5ab2103a2..9631d8e9e 100644 --- a/docs/installing/manual_install.md +++ b/docs/installing/manual_install.md @@ -19,8 +19,8 @@ Note that there are [other ways to install Alaveteli]({{ site.baseurl }}docs/ins ## Target operating system -These instructions assume Debian Wheezy or Squeeze (64-bit) or Ubuntu 12.04 LTS -(precise). Debian is the best supported deployment platform. We also +These instructions assume a 64-bit version of Debian 6 (Wheezy), Debian 7 (Squeeze) +or Ubuntu 12.04 LTS (Precise). Debian is the best supported deployment platform. We also have instructions for [installing on MacOS]({{ site.baseurl }}docs/installing/macos/). Commands are intended to be run via the terminal or over ssh. |