diff options
| -rw-r--r-- | _layouts/page.html | 2 | ||||
| -rw-r--r-- | alaveteli-doc-master.txt | 4 | ||||
| -rw-r--r-- | developers/overview.md | 5 | ||||
| -rw-r--r-- | running/states.md | 13 | ||||
| -rw-r--r-- | running/states_informatazyrtare.md | 219 |
5 files changed, 58 insertions, 185 deletions
diff --git a/_layouts/page.html b/_layouts/page.html index 29761afd2..c82d159fb 100644 --- a/_layouts/page.html +++ b/_layouts/page.html @@ -36,7 +36,7 @@ layout: default <ul> <li><a href="{{ site.baseurl }}running/admin_manual">Admin manual</a></li> <li><a href="{{ site.baseurl }}running/server">Server checklist</a></li> - <li><a href="{{ site.baseurl }}running/states">States of requests</a></li> + <li><a href="{{ site.baseurl }}running/states">Request states</a></li> </ul> </li> <li><a href="{{ site.baseurl }}developers/">For developers</a> diff --git a/alaveteli-doc-master.txt b/alaveteli-doc-master.txt index 87a1a6cf4..f7fc316ef 100644 --- a/alaveteli-doc-master.txt +++ b/alaveteli-doc-master.txt @@ -16,7 +16,6 @@ These pages (in the wiki) have work/attention still pending: ------------------------------------------------------------ [ ] [ ] Administrator's manual TODO -- needs to be implemented -[ ] [no] Current states -- running/states TODO simplify comparison with running/states_informatazyrtare/ [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 @@ -28,7 +27,6 @@ These pages (in the wiki) have work/attention still pending: [>>] [? ] 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 -[ok] [x ] Understanding the code -- developers/overview @@ -50,6 +48,7 @@ These pages are all effetively done (i.e., definitively settled in the docs) [no] [ok] Code goals <-- (not for docs) [no] [ok] Comments as trackbacks <-- (not for docs) [no] [ok] Complaining to ombudsman feature requirements <-- (not for docs) should it be? +[ok] [no] Current states -- running/states [no] [ok] Escalating privileges system <-- (not for docs) this is a proposal/discussion [no] [ok] Escalating privileges: proposal for initial version <-- (not for docs) see above [no] [ok] Factor out "email in public" parts <-- (not for docs) this is a proposal/discussion @@ -66,5 +65,6 @@ These pages are all effetively done (i.e., definitively settled in the docs) [no] [ok] Request templates <-- actually about muckrock (and a feature request), stays on wiki [no] [ok] Roadmap <-- historical, stays on wiki [no] [ok] Rules engine for statuses <-- (not for docs) this is a proposal/discussion +[ok] [no] Understanding the code -- developers/overview [no] [ok] WhatDoTheyKnow <-- notes and diagrams for WDTK, leave on wiki (not for docs) [ok] [no] Writing a theme -- customising/themes/ diff --git a/developers/overview.md b/developers/overview.md index 7f0f30b04..ca2d27985 100644 --- a/developers/overview.md +++ b/developers/overview.md @@ -3,14 +3,13 @@ layout: page title: High-level overview --- +# High-level overview + <p class="lead"> This page describes the process and entities that make up Alaveteli. It's a high-level overview of how Alaveteli works to help you orientate yourself to the code. </p> - -# High-level overview - _See also the [schema diagram](#schema-diagram) at the bottom of this page._ The main entity is **InfoRequest**, which represents a request for information by a diff --git a/running/states.md b/running/states.md index ccc01df20..598a28d98 100644 --- a/running/states.md +++ b/running/states.md @@ -3,7 +3,7 @@ layout: page title: States of requests --- -# States of requests +# Request states <p class="lead"> A <a href="{{site.baseurl}}glossary/#request" class="glossary">request</a> @@ -19,9 +19,12 @@ customise them, you can — see ## WhatDoTheyKnow example -Requests made on the UK's Alaveteli instance, [WhatDoTheyKnow](http://www.whatdotheyknow.com), may be in any of the following states -(for comparison, Kosovo's instance uses -[slightly different states]({{ site.baseurl }}running/states_informatazyrtare)): +Requests made on the UK's Alaveteli instance, [WhatDoTheyKnow](http://www.whatdotheyknow.com), +may be in any of the states described below. + +Note that your site doesn't need to use the same states as WhatDoTheyKnow does. For example, +Kosovo's instance uses slightly different states: see +[this comparison of their differences]({{ site.baseurl }}running/states_informatazyrtare). ### States @@ -197,7 +200,7 @@ Requests made on the UK's Alaveteli instance, [WhatDoTheyKnow](http://www.whatdo <a name="user_withdrawn">user_withdrawn</a> </dt> <dd> - The requester has abandoned this request for som e reason + The requester has abandoned this request for some reason. <ul> <li>Prompt user to write message to tell authority</li> </ul> diff --git a/running/states_informatazyrtare.md b/running/states_informatazyrtare.md index a799358ed..b4cf2e81b 100644 --- a/running/states_informatazyrtare.md +++ b/running/states_informatazyrtare.md @@ -3,215 +3,86 @@ layout: page title: States of requests (InformataZyrtare) --- -# States of requests +# Request states: example comparison <p class="lead"> - A <a href="{{site.baseurl}}glossary/#request" class="glossary">request</a> - passes through different <strong>states</strong> as it is processed. These may - vary from one jurisdiction to another. + This page shows differences between states used on two different + Alaveteli instances — one in Kosovo and one in the UK. This + is a practical example showing that you can customise the states that + your site uses. </p> The request states are defined in the Alaveteli code, and we recommend you use them (provided they match the <a href="{{ site.baseurl }}glossary/#foi" -class="glossary">FOI law</a> in your own jurisdiction). But if you do need to -customise them, you can — see -<a href="{{ site.baseurl }}customising/themes">Customising the request states</a> for details. +class="glossary">FOI law</a> in your own jurisdiction). ## InformataZyrtare.org (Kosovo) example -Requests made on Kosovo's Alaveteli instance, [InformataZyrtare](http://informatazyrtare.org), may be in any of the following states -(for comparison, the UK's instance uses -[slightly different states]({{ site.baseurl }}running/states)): - -### States - -<ul class="definitions"> - <li><a href="#waiting_response">waiting_response</a></li> - <li><a href="#waiting_classification">waiting_classification</a></li> - <li><a href="#waiting_response_overdue">waiting_response_overdue</a></li> - <li><a href="#waiting_clarification">waiting_clarification</a></li> - <li><a href="#not_held">not_held</a></li> - <li><a href="#rejected">rejected</a></li> - <li><a href="#successful">successful</a></li> - <li><a href="#partially_successful">partially_successful</a></li> - <li><a href="#error_message">error_message</a></li> - <li><a href="#requires_admin">requires_admin</a></li> - <li><a href="#deadline_extended">deadline_extended</a></li> - <li><a href="#partial_rejected">partial_rejected</a></li> - <li><a href="#wrong_response">wrong_response</a></li> -</ul> +Requests made on Kosovo's Alaveteli instance, +[InformataZyrtare](http://informatazyrtare.org), use slightly different states +from those on the UK's instance, [WhatDoTheyKnow](http://www.whatdotheyknow.com) +(WDTK). +Generally, this arises simply because the local legislation, or the way the +groups running the sites work, are different in different places. Alavateli +facilitates this by allowing you to customise the states that are used. -<dl class="glossary"> +This example is to show clearly that you can use different states depending on +your local requirements, and how that might look. See [Customising the request +states]({{ site.baseurl }}customising/themes) for details on how to do this. - <dt> - <a name="waiting_response">waiting_response</a> - </dt> - <dd> - Waiting for the public authority to reply - <ul> - <li>The default initial state</li> - <li>Can't transition here from internal_review</li> - </ul> - </dd> +### States used by InformataZyrtare but not WDTK - <dt> - <a name="waiting_classification">waiting_classification</a> - </dt> - <dd> - <ul> - <li>The default state after receiving a response</li> - </ul> - </dd> + * <a href="#deadline_extended">deadline_extended</a> + * <a href="#partial_rejected">partial_rejected</a> + * <a href="#wrong_response">wrong_response</a> - <dt> - <a name="waiting_response_overdue">waiting_response_overdue</a> - </dt> - <dd> - Waiting for a reply for too long - <ul> - <li>Automatic, if today's date is after the request date + holidays + 20 days</li> - <li>When a user updates / visits an item in this state, thank user and tell them how long they should have to wait</li> - <li>Alert user by email when something becomes overdue</li> - </ul> - </dd> +### States used by WDTK but not InformataZyrtare - <dt> - <a name="waiting_clarification">waiting_clarification</a> - </dt> - <dd> - The public authority would like part of the request explained - <ul> - <li>Prompt user to write followup</li> - <li>If a user sends an outgoing message on a request in this state, automatically transitions to {{waiting_response}}</li> - <li>Three days after this state change occurs, send reminder to user to action it (assuming user isn't banned)</li> - <li>Can't transition here from internal_review</li> - </ul> - </dd> + * <a href="{{ site.baseurl }}running/states/#awaiting_description">awaiting_description</a> + * <a href="{{ site.baseurl }}running/states/#gone_postal">gone_postal</a> + * <a href="{{ site.baseurl }}running/states/#internal_review">internal_review</a> + * <a href="{{ site.baseurl }}running/states/#user_withdrawn">user_withdrawn</a> + * <a href="{{ site.baseurl }}running/states/#waiting_response_very_overdue">waiting_response_very_overdue</a> - <dt> - <a name="not_held">not_held</a> - </dt> - <dd> - The public authority does not have the information requested - <ul> - <li>Suggest user might want to try a different authority, or complain</li> - </ul> - </dd> +For more details, see all the [states used by WhatDoTheyKnow]({{site.baseurl}}running/states)) for details. - <dt> - <a name="rejected">rejected</a> - </dt> - <dd> - The request was refused by the public authority - <ul> - <li>Show page of possible next steps</li> - </ul> - </dd> - <dt> - <a name="successful">successful</a> - </dt> - <dd> - All of the information requested has been received - <ul> - <li>Suggest they add annotations or make a donation </li> - </ul> - </dd> +--- - <dt> - <a name="partially_successful">partially_successful</a> - </dt> - <dd> - Some of the information requested has been received - <ul> - <li>Suggest they make a donation; give ideas what to do next</li> - </ul> - </dd> + - <dt> - <a name="error_message">error_message</a> - </dt> - <dd> - Received an error message, such as delivery failure. - <ul> - <li>Thank user for reporting, and suggest they use a form to give new email address for authority if that was the problem</li> - <li>Mark as needs admin attention</li> - </ul> - </dd> +### Details of InformataZytare states - <dt> - <a name="requires_admin">requires_admin</a> - </dt> - <dd> - A strange response, required attention by the InformataZyrtare team - <ul> - <li>A user is confused and doesn't know what state to set, so an admin can intervene </li> - <li>Redirect to form to ask for more information </li> - <li>Mark as needs admin attention</li> - </ul> - </dd> +The states which aren't represented on [WDTK's states]({{ site.baseurl }}running/states/) are described +in a little more detail here: + +<ul class="definitions"> + <li><a href="#deadline_extended">deadline_extended</a></li> + <li><a href="#partial_rejected">partial_rejected</a></li> + <li><a href="#wrong_response">wrong_response</a></li> +</ul> +<dl class="glossary"> <dt> <a name="deadline_extended">deadline_extended</a> </dt> <dd> - <ul> - <li>If the Authority has requested deadline extension.</li> - </ul> + The Authority has requested deadline extension. </dd> - <dt> - <a name="partial_rejected">partial_rejected</a> <em>TBD</em> + <a name="partial_rejected">partial_rejected</a> </dt> <dd> - Only part of the request has being refused but the successful request to an information has not been attached - </ul> + Only part of the request has being refused but the successful request + to an information has not been attached. </dd> - <dt> <a name="wrong_response">wrong_response</a> </dt> <dd> - Authority has replied but the response does not correspond to the request + The authority has replied but the response does not correspond to the request. </dd> -</dl> - -<!-- - TODO: muckrock's states here? - -# MuckRock.com - -US FOI site MuckRock.com uses the following states: - -**Draft** -Unfinished request - -**Processing** -The MuckRock team are currently reviewing the request to decide what to do with it. - -This is necessary because a lot of requests have to be mailed or faxed or have signatures, etc. The system requires quite a lot of manual intervention. Over time the plan is to automate more, but this state will still be required at a minimum to indicate that MuckRock is the holdup, not the requester or the agency. -**Awaiting Response** -Request sent, no reply received yet - -**Fix Required** -If the authority or a MuckRock admin thinks that user needs to clarify or otherwise "fix" the request - -**Payment Required** -In the US, an authority can ask a user to make a payment to cover the costs of the request - -**Rejected** -Request rejected - -**No responsive documents** -Information not held - -**Completed** -Successfully finished request - -**Partially Completed** -Finished request, partly successful - ---> +</dl> |