From a4c1489e9ea63838b803acea5024992d854e070d Mon Sep 17 00:00:00 2001 From: Daniel Karlsson Date: Wed, 16 Sep 2015 12:16:29 +0200 Subject: [PATCH 1/3] [#1494] Merged docs so far --- README.md | 128 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 122 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index db3d68ab77..cba9b7b31c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,131 @@ +# Akvo Really Simple Reporting (Akvo RSR) + +![Build status](http://ci.akvo.org/app/rest/builds/buildType:(id:SanitationCompass_Test)/statusIcon) + +[Akvo RSR](http://akvo.org/products/rsr/) (Really Simple Reporting) is an online communication, collaboration and reporting hub for development aid projects with a strong focus on [IATI](http://iatistandard.org). Akvo RSR is a web and Android-based system, this repo is the web based Django backend. The Android app can be found in [Akvo Up](https://github.com/akvo/akvo-rsr-up). + +## Quickstart +Do we need to setup .scripts/devhelpers/setup_etc_hosts.sh? + +```bash +$ cp akvo/settings/66_local.template akvo/settings/66_local.conf +$ cd vagrant +$ vagrant up +``` +Now open a browser & hit [http://rsr.locadev.akvo.org](http://rsr.locadev.akvo.org). For the test data set loaded by default use [accounts](accounts.md). In the contributing section bellow there are more examples on running Akvo RSR with development server and how to generate front end assets. + +## REST API +A REST API is available at (http://localdev.akvo.org/rest/v1/)[http://localdev.akvo.org/rest/v1/] built using [Django REST Framework](http://www.django-rest-framework.org). An API key can be generated in the Django admin. + + +## Contributing +In the large Akvo RSR has a roadmap defined by the Akvo Foundation, product designs are made in the Akvo product design repo. More focused work are managed via Github and Waffle. Github issues are clustered into Github Milestones which imply a release of Akvo RSR. Issues in the current milestone gets a ready label which makes the issues located in the ready column in Waffle. On the Waffle board issues then are moved from left to right from ready to done. + +- In progress - work are performed in a feature branch +- Needs review - there is pull request from the feature branch to develop to be reviewed +- Done - issue merged into develop (not deployed or accepted tested) + +### Tools +- [Akvo product design repo](http://github.com/akvo/akvo-product-design) +- [Github Milestones](https://github.com/akvo/akvo-rsr/milestones) +- [Github Issues](http://github.com/akvo/akvo-rsr/issues/) +- [Waffle board](http://waffle.io/akvo/akvo-rsr) + +### Code collaboration +To start work on a feature branch develop, do your work then issue a PR to develop. Before a release we create a release candidate. Once that is tested it get's merged into master and deployed to production. +The flow looks like this: +develop -> feature branch -> develop -> release candidate -> master + +'develop' works as integration branch. Work is then performed in feature branches named '#123-small-fix' where 123 is the Github issue number. The convention with a leading '#' was adopted since Waffle is happier that way. + +```bash +$ git pull origin develop +$ git checkout -b \#- origin/develop +$ git commit -m "[Fixes #] Commit message" +$ git push origin \#- +``` +Now create a PR and assign an eagle eyed Akvo developer. + +### Django development server +We'll pick up where the quick example ended. Let's stop the rsr service and start the Django development web server, this will enable console output for things like logs & email. in scripts/devhelpers there are two scripts manage.sh & supervisord.sh that proxy to the vagrant box versions of the Django manage.py and supervisord via the SSH. + +```bash +$ cd ../scripts/devhelpers +$ ./supervisord.sh stop rsr +$ ./manage.sh runserver +``` +[http://rsr.locadev.akvo.org](http://rsr.locadev.akvo.org) will now be served by the Django development server. + +### Front end assets + +If we want to make changes to JavaScript files or CSS we need to setup the front end pipeline. The asset pipeline consistes of two modules, Gulp & [Django pipeline](https://django-pipeline.readthedocs.org/en/latest/). Gulp handles watching, transpiling & linting. Django Pipeline takes the transpiled files and depending on the configuration serves them in development mode or bundles them for production usage. For development using the Django config setup in the quick start section we don't need to care about the Django Pipeline part. Pipeline modules is however configured in [40-pipeline.conf](akvo/settings/40-pipeline.conf) & one can utilise it via ./manage.sh collectstatic. + +We're using [Gulp](http://gulpjs.com) and the Gulpfile is located in scripts/devhelpers. To be able to run the gulp script Node.js & Gulp needs to be installed. There is a lot of ways to do this, depending on platform and preference. Since OS X is the most common Akvo dev platform here is an example on how to enable the asset pipeline on OS X via [homebrew](http://brew.sh). + +```bash +$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" # Do realise that this exetues a remote script +$ brew install node +$ npm install --global gulp +$ npm install # installs node modules defined ./package.json (Gulpfile dependencies) +$ gulp watch # watch akvo/rsr/static/scripts-src/ & akvo/rsr/static/styles-src/ +``` +The Gulp watch task will: + +1. compile sass files to css +2. compile jsx files to js +3. run lint on js files + +### Tests +```bash +$ ./manage.sh test akvo.rsr +``` + +### Vagrant data dump/load +data/ includes tools for dumping and loading data from the vagrantbox. The data we talk about is the database (postgres dump) & the user uploaded images & documents. + +Both of these scripts are supposed to be executed from the vagrant box as the vagrant user! + +#### dump.sh +Will generate a rsr_dump file in ./dump/rsr_dump..tar.gz. +This file consist of +- db (user uploaded images) +- rsr.dump (Postgres dump) +- rsr.json (Django dump) + +##### load.sh +Expects a file ./dump/rsr_dump.tar.gz. This files requires the db directory and the rsr.dump Postgres dump but not the Django data dump. +These scripts are supposed to be run from the vagrant box. The load.sh script expects a file in dump/rsr_dump.tar.gz. Since load.sh adds date to the file a manual rename is needed! + +#### simple-load.sh +Only loads new postgres data. Expects a postgres dump in data/dump/rsr.dump + +### Django debug toolbar +In the 66_local.conf the Django debug toolbar can be enabled by uncomment relevant lines. Do +notice that provisioning will not work if the debug toolbar is enabled & it's very easy to forget +that it's enabled! + +### Python style guide +Try and follow PEP8 & keep within 100 chars! + +### Translations + + +## Links +* [RELEASE_NOTES](RELEASE_NOTES.md) +* [AUTHORS](AUTHORS.txt) +* [LICENSE](LICENSE.md) + + + + +------------------------------------------------------------------------------ + README.md v1.3, 9 April 2014 [ogl, adriancollier] # Akvo Really Simple Reporting (Akvo RSR) ![Build status](http://ci.akvo.org/app/rest/builds/buildType:(id:SanitationCompass_Test)/statusIcon) -[![Code Health](https://landscape.io/github/akvo/akvo-rsr/develop/landscape.svg?style=flat)](https://landscape.io/github/akvo/akvo-rsr/develop) - Akvo Foundation is a non-profit foundation that builds open source internet and mobile phone software which is used to make international development cooperation and governance more effective and transparent. Akvo RSR is part of the Akvo platform. Akvo RSR is a web and Android-based system that makes it easy for international development teams to bring complex networks of projects online and instantly share progress with everyone involved and interested. @@ -21,7 +141,3 @@ More information in these files: * [LICENSE](LICENSE.md) * [DEVELOPMENT](DEVELOPMENT.md) * [INSTALL](INSTALL.md) - - - - From 1d91fa0b7c06f33776efad0e139b069a2ba174e7 Mon Sep 17 00:00:00 2001 From: Daniel Karlsson Date: Fri, 9 Oct 2015 08:16:25 +0200 Subject: [PATCH 2/3] [#1494] Updated docs. --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cba9b7b31c..673a1a3264 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,15 @@ $ git push origin \#- ``` Now create a PR and assign an eagle eyed Akvo developer. + +### Tagging a release +Pull the latest master branch to your local machine git checkout master +Merge the current release from the release/candidate branch git pull --no-ff origin release/candidate +Add the tag with the release number and name git tag -a v2.3.6 -m "Akvo RSR release v2.3.6 (Voavanga)" +Push the branch and tags git push && git push --tags +Update all the remotes git remote update + + ### Django development server We'll pick up where the quick example ended. Let's stop the rsr service and start the Django development web server, this will enable console output for things like logs & email. in scripts/devhelpers there are two scripts manage.sh & supervisord.sh that proxy to the vagrant box versions of the Django manage.py and supervisord via the SSH. @@ -105,9 +114,20 @@ notice that provisioning will not work if the debug toolbar is enabled & it's ve that it's enabled! ### Python style guide -Try and follow PEP8 & keep within 100 chars! + +- PEP8 +- line-length (Settled on 100 chars https://github.com/akvo/akvo-rsr/issues/1369) +- landscape + ### Translations +- transifex +- languages + - English (default) + - French + - Spanish +https://github.com/akvo/akvo-rsr/wiki/Notes-on-translation + ## Links @@ -117,8 +137,8 @@ Try and follow PEP8 & keep within 100 chars! - ------------------------------------------------------------------------------- +# old stuff +----------------------------------------------------- README.md v1.3, 9 April 2014 [ogl, adriancollier] From be2a6a3437e22db87f2c4358a0bea8b3fa7c1c4a Mon Sep 17 00:00:00 2001 From: Kasper Brandt Date: Fri, 9 Oct 2015 15:04:49 +0300 Subject: [PATCH 3/3] [#1494] Move all docs to wiki --- .landscape.yaml | 1 - AUTHORS.txt | 62 - DEVELOPMENT.md | 39 - INSTALL.md | 8 - LICENSE.md | 684 ---- README.md | 162 +- RELEASE_NOTES.md | 4395 ---------------------- docs/README.md | 8 - scripts/devhelpers/setup_etc_hosts.sh | 2 +- setup/dev/dev_env_setup_for_osx.markdown | 1 - 10 files changed, 9 insertions(+), 5353 deletions(-) delete mode 100644 AUTHORS.txt delete mode 100644 DEVELOPMENT.md delete mode 100644 INSTALL.md delete mode 100644 LICENSE.md delete mode 100644 RELEASE_NOTES.md delete mode 100644 docs/README.md delete mode 100644 setup/dev/dev_env_setup_for_osx.markdown diff --git a/.landscape.yaml b/.landscape.yaml index 73780b80a1..a3920d902a 100644 --- a/.landscape.yaml +++ b/.landscape.yaml @@ -1,4 +1,3 @@ -# doc-warnings: yes test-warnings: no strictness: verylow max-line-length: 100 diff --git a/AUTHORS.txt b/AUTHORS.txt deleted file mode 100644 index ea6b37227a..0000000000 --- a/AUTHORS.txt +++ /dev/null @@ -1,62 +0,0 @@ -AUTHORS.txt v1.4, 9 April 2014, pb, adriancollier - -AUTHORS of Akvo RSR - -The PRIMARY AUTHORS are (and/or have been): - -- Malte Beckmann -- Gabriel Brady -- Kasper Brandt -- Paul Burt -- Thomas Bjelkeman-Pettersson -- Mark Charmer -- Adrian Collier -- Carl Crowder -- Oliver Galloway-Lunn -- Gabriel von Heijne -- Daniel Karlsson -- Stellan Lagerström -- Gino Lee -- Peter van der Linde -- Gabriel Martin -- Ruarcc McAloon -- Iván Perdomo -- Robert Rochette -- Dan Rowden -- Loïc Sans -- Anna-Marthe Sessink -- Elizabeth Whiteside - -Translation support by: - -- Malte Beckmann -- Anke van Lenteren -- Isabelle Olivetti -- Isabel Ordonez -- Sergio Atristain -- Jura Khrapunov - -Contributors, here is an inevitably incomplete list of MUCH APPRECIATED -CONTRIBUTORS whom without, Akvo RSR would not have been the same: - -- Kathelyne van der Berg -- Luuk Diphoorn -- Akhila Jambagi -- Jeroen van der Sommen -- Mark Tiele Westra - -Further team members can be found at < http://akvo.org/about-us/team/ > - -Funding partners, without them Akvo RSR could not have happened - -- Dutch Ministry of Foreign Affairs / Schoklandfonds -- Partners for Water (PvW) -- Netherlands Water Partnership -- Rabobank and Rabobank Foundation -- ASN Bank -- Aqua for All -- Nedap -- Simavi - -Many more partners, who all have greatly contributed to Akvo RSR in -many ways can be found at: < http://akvo.org/about-us/partners/ > diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md deleted file mode 100644 index fedcc9fa8d..0000000000 --- a/DEVELOPMENT.md +++ /dev/null @@ -1,39 +0,0 @@ -# Development -For local development Vagrant is used. The development env is loaded with a small fixture data set with [available accounts](docs/RSR%20Developer%20Documentation/Environment%20Setup/Accounts.md). To get from checkout to running server use these steps: - -## Setup local settings -```shell -$ cp akvo/settings/66_local.template akvo/settings/66_local.conf -``` - -## Boot vagrant environment -This will download a vagrant box, provision the box with Puppet, download initial data and load that data. Hence this steps takes a while, -```shell -$ cd vagrant && vagrant up --provider=virtualbox -... -$ cd .. -``` -Now open a browser and visist [http://rsr.localdev.akvo.org/](http://rsr.localdev.akvo.org/). We're now using the production Gunicorn webserver. For development the Django development server which gives you code reloading is really handy. - -## Run a local devserver -To run the Django devserver with code reloading and getting prints -```shell -$ cd scripts/devhelpers -$ ./supervisorctl.sh stop rsr && ./manage.sh runserver -``` - -## Make sure assets are rebuilt on change (WIP) -To build assets we're relying on [Node.js](http://nodejs.org) and [Gulp](http://gulpjs.com). -Verify that you have node and gulp installed (paths will depend on install method and OS): -```shell -$ which node -/usr/local/bin/node -$ which gulp -/usr/local/bin/gulp -``` -Then install required node modules and set gulp to build assets on file changes: -```shell -$ cd scripts/devhelpers -$ npm install -$ gulp watch -``` diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index cdb76be37a..0000000000 --- a/INSTALL.md +++ /dev/null @@ -1,8 +0,0 @@ -INSTALL.md, v1.2, 12 Dec 2013 [adriancollier] - -Akvo RSR documentation -=== - -* [Akvo RSR documentation](https://github.com/akvo/akvo-rsr/tree/wiki-docs/docs) -* [Akvo RSR installation guide](https://github.com/akvo/akvo-rsr/tree/wiki-docs/vagrant) -* [Akvo RSR user help](http://rsrhelp.akvo.org) diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 9d5f273e85..0000000000 --- a/LICENSE.md +++ /dev/null @@ -1,684 +0,0 @@ -LICENSE.md, v1.2, 9 April 2014 [ogl, adriancollier] - -Copyright (C) 2007-2014 Stichting Akvo (Akvo Foundation) - -This file is part of Akvo RSR. - -Akvo RSR is free software: you can redistribute it and modify -it under the terms of the GNU Affero General Public License (AGPL) -as published by the Free Software Foundation, either version 3 of the -License or any later version. - -Akvo RSR is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License included below for more details. - -The license can also be seen at . - -===== - -## GNU AFFERO GENERAL PUBLIC LICENSE -### Version 3 (19 November 2007) - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -## Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - -## TERMS AND CONDITIONS - -### 0. Definitions - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - -### 1. Source Code - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - -### 2. Basic Permissions - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - -### 3. Protecting Users' Legal Rights From Anti-Circumvention Law - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - -### 4. Conveying Verbatim Copies - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - -### 5. Conveying Modified Source Versions - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - -### 6. Conveying Non-Source Forms - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - -### 7. Additional Terms - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - -### 8. Termination - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - -### 9. Acceptance Not Required for Having Copies - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - -### 10. Automatic Licensing of Downstream Recipients - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - -### 11. Patents - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - -### 12. No Surrender of Others' Freedom - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - -### 13. Remote Network Interaction; Use with the GNU General Public License - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - -### 14. Revised Versions of this License - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - -### 15. Disclaimer of Warranty - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - -### 16. Limitation of Liability - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - -### 17. Interpretation of Sections 15 and 16 - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - -## END OF TERMS AND CONDITIONS - -===== - -### How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. - -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/README.md b/README.md index 673a1a3264..83bcd47fe4 100644 --- a/README.md +++ b/README.md @@ -1,163 +1,17 @@ # Akvo Really Simple Reporting (Akvo RSR) -![Build status](http://ci.akvo.org/app/rest/builds/buildType:(id:SanitationCompass_Test)/statusIcon) - -[Akvo RSR](http://akvo.org/products/rsr/) (Really Simple Reporting) is an online communication, collaboration and reporting hub for development aid projects with a strong focus on [IATI](http://iatistandard.org). Akvo RSR is a web and Android-based system, this repo is the web based Django backend. The Android app can be found in [Akvo Up](https://github.com/akvo/akvo-rsr-up). - -## Quickstart -Do we need to setup .scripts/devhelpers/setup_etc_hosts.sh? - -```bash -$ cp akvo/settings/66_local.template akvo/settings/66_local.conf -$ cd vagrant -$ vagrant up -``` -Now open a browser & hit [http://rsr.locadev.akvo.org](http://rsr.locadev.akvo.org). For the test data set loaded by default use [accounts](accounts.md). In the contributing section bellow there are more examples on running Akvo RSR with development server and how to generate front end assets. - -## REST API -A REST API is available at (http://localdev.akvo.org/rest/v1/)[http://localdev.akvo.org/rest/v1/] built using [Django REST Framework](http://www.django-rest-framework.org). An API key can be generated in the Django admin. - - -## Contributing -In the large Akvo RSR has a roadmap defined by the Akvo Foundation, product designs are made in the Akvo product design repo. More focused work are managed via Github and Waffle. Github issues are clustered into Github Milestones which imply a release of Akvo RSR. Issues in the current milestone gets a ready label which makes the issues located in the ready column in Waffle. On the Waffle board issues then are moved from left to right from ready to done. - -- In progress - work are performed in a feature branch -- Needs review - there is pull request from the feature branch to develop to be reviewed -- Done - issue merged into develop (not deployed or accepted tested) - -### Tools -- [Akvo product design repo](http://github.com/akvo/akvo-product-design) -- [Github Milestones](https://github.com/akvo/akvo-rsr/milestones) -- [Github Issues](http://github.com/akvo/akvo-rsr/issues/) -- [Waffle board](http://waffle.io/akvo/akvo-rsr) - -### Code collaboration -To start work on a feature branch develop, do your work then issue a PR to develop. Before a release we create a release candidate. Once that is tested it get's merged into master and deployed to production. -The flow looks like this: -develop -> feature branch -> develop -> release candidate -> master - -'develop' works as integration branch. Work is then performed in feature branches named '#123-small-fix' where 123 is the Github issue number. The convention with a leading '#' was adopted since Waffle is happier that way. - -```bash -$ git pull origin develop -$ git checkout -b \#- origin/develop -$ git commit -m "[Fixes #] Commit message" -$ git push origin \#- -``` -Now create a PR and assign an eagle eyed Akvo developer. - - -### Tagging a release -Pull the latest master branch to your local machine git checkout master -Merge the current release from the release/candidate branch git pull --no-ff origin release/candidate -Add the tag with the release number and name git tag -a v2.3.6 -m "Akvo RSR release v2.3.6 (Voavanga)" -Push the branch and tags git push && git push --tags -Update all the remotes git remote update - - -### Django development server -We'll pick up where the quick example ended. Let's stop the rsr service and start the Django development web server, this will enable console output for things like logs & email. in scripts/devhelpers there are two scripts manage.sh & supervisord.sh that proxy to the vagrant box versions of the Django manage.py and supervisord via the SSH. - -```bash -$ cd ../scripts/devhelpers -$ ./supervisord.sh stop rsr -$ ./manage.sh runserver -``` -[http://rsr.locadev.akvo.org](http://rsr.locadev.akvo.org) will now be served by the Django development server. - -### Front end assets - -If we want to make changes to JavaScript files or CSS we need to setup the front end pipeline. The asset pipeline consistes of two modules, Gulp & [Django pipeline](https://django-pipeline.readthedocs.org/en/latest/). Gulp handles watching, transpiling & linting. Django Pipeline takes the transpiled files and depending on the configuration serves them in development mode or bundles them for production usage. For development using the Django config setup in the quick start section we don't need to care about the Django Pipeline part. Pipeline modules is however configured in [40-pipeline.conf](akvo/settings/40-pipeline.conf) & one can utilise it via ./manage.sh collectstatic. - -We're using [Gulp](http://gulpjs.com) and the Gulpfile is located in scripts/devhelpers. To be able to run the gulp script Node.js & Gulp needs to be installed. There is a lot of ways to do this, depending on platform and preference. Since OS X is the most common Akvo dev platform here is an example on how to enable the asset pipeline on OS X via [homebrew](http://brew.sh). - -```bash -$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" # Do realise that this exetues a remote script -$ brew install node -$ npm install --global gulp -$ npm install # installs node modules defined ./package.json (Gulpfile dependencies) -$ gulp watch # watch akvo/rsr/static/scripts-src/ & akvo/rsr/static/styles-src/ -``` -The Gulp watch task will: - -1. compile sass files to css -2. compile jsx files to js -3. run lint on js files - -### Tests -```bash -$ ./manage.sh test akvo.rsr -``` - -### Vagrant data dump/load -data/ includes tools for dumping and loading data from the vagrantbox. The data we talk about is the database (postgres dump) & the user uploaded images & documents. - -Both of these scripts are supposed to be executed from the vagrant box as the vagrant user! - -#### dump.sh -Will generate a rsr_dump file in ./dump/rsr_dump..tar.gz. -This file consist of -- db (user uploaded images) -- rsr.dump (Postgres dump) -- rsr.json (Django dump) - -##### load.sh -Expects a file ./dump/rsr_dump.tar.gz. This files requires the db directory and the rsr.dump Postgres dump but not the Django data dump. -These scripts are supposed to be run from the vagrant box. The load.sh script expects a file in dump/rsr_dump.tar.gz. Since load.sh adds date to the file a manual rename is needed! - -#### simple-load.sh -Only loads new postgres data. Expects a postgres dump in data/dump/rsr.dump - -### Django debug toolbar -In the 66_local.conf the Django debug toolbar can be enabled by uncomment relevant lines. Do -notice that provisioning will not work if the debug toolbar is enabled & it's very easy to forget -that it's enabled! - -### Python style guide - -- PEP8 -- line-length (Settled on 100 chars https://github.com/akvo/akvo-rsr/issues/1369) -- landscape - - -### Translations -- transifex -- languages - - English (default) - - French - - Spanish -https://github.com/akvo/akvo-rsr/wiki/Notes-on-translation - - - -## Links -* [RELEASE_NOTES](RELEASE_NOTES.md) -* [AUTHORS](AUTHORS.txt) -* [LICENSE](LICENSE.md) - - - -# old stuff ------------------------------------------------------ - -README.md v1.3, 9 April 2014 [ogl, adriancollier] - -# Akvo Really Simple Reporting (Akvo RSR) - -![Build status](http://ci.akvo.org/app/rest/builds/buildType:(id:SanitationCompass_Test)/statusIcon) +[![Code Health](https://landscape.io/github/akvo/akvo-rsr/develop/landscape.svg?style=flat)](https://landscape.io/github/akvo/akvo-rsr/develop) Akvo Foundation is a non-profit foundation that builds open source internet and mobile phone software which is used to make international development cooperation and governance more effective and transparent. -Akvo RSR is part of the Akvo platform. Akvo RSR is a web and Android-based system that makes it easy for international development teams to bring complex networks of projects online and instantly share progress with everyone involved and interested. +Akvo RSR is part of the Akvo platform. Akvo RSR is a web and Android-based system that makes it easy for international development teams to bring complex networks of projects online and instantly share progress with everyone involved and interested, with a strong focus on the [IATI standard](http://iatistandard.org). We believe that Akvo RSR can be used in many other scenarios, including environmental programs and monitoring. -Read more about [Akvo Products](http://akvo.org/products/). - -More information in these files: +For more information on Akvo RSR, please visit the [wiki page](https://github.com/akvo/akvo-rsr/wiki). Or use these links to go directly to one of the corresponding pages: +* [Quick install guide](https://github.com/akvo/akvo-rsr/wiki/Quick-start-guide) +* [Release notes](https://github.com/akvo/akvo-rsr/wiki/Release-notes) +* [Authors](https://github.com/akvo/akvo-rsr/wiki/Authors) +* [License](https://github.com/akvo/akvo-rsr/wiki/License) -* [RELEASE_NOTES](RELEASE_NOTES.md) -* [AUTHORS](AUTHORS.txt) -* [LICENSE](LICENSE.md) -* [DEVELOPMENT](DEVELOPMENT.md) -* [INSTALL](INSTALL.md) +Read more about other [Akvo Products](http://akvo.org/products/). \ No newline at end of file diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md deleted file mode 100644 index b2f9dd488c..0000000000 --- a/RELEASE_NOTES.md +++ /dev/null @@ -1,4395 +0,0 @@ -Akvo RSR (Really Simple Reporting) makes it easy to put any type of projects online and share status updates from your teams. - -We provide Akvo RSR as a service on your own URL and with your own branding, as well as on Akvo.org, to combat poverty by making it easy to bring development aid projects online. There you can use our open web and mobile tools to connect and share progress with funders and followers. - -Check out [Introducing Akvo Really Simple Reporting](http://akvo.org/products/rsr/). -Read more about [Akvo Products](http://akvo.org/products/). - -________ - -Akvo RSR version 3.2.3 Flying Fish Cove Hotfix ---- - -Thursday 7th May 2015, kasperbrandt - -New & Noteworthy ---- - -### Advanced filter on projects listing page -On the project listing page, we have adjusted the advanced filter. The filter is now only applied when the 'Apply filter' button is clicked, and it is now possible to type the name of an organisation in the filter which will show suggestions of organisations. - -Github issue: [#1052](https://github.com/akvo/akvo-rsr/issues/1052). - -### Clickable '+ more' link on projects listing page -On the project main page, the '+ more' link next to the partners was already clickable so that all partners of a project could be viewed on a separate page. We have now implemented the same functionality on the projects listing page. - -Github issue: [#1474](https://github.com/akvo/akvo-rsr/issues/1474). - -### New API resources for map -We have created new API resources for maps. These resources are a lot faster and provide more information in comparison to the previous location resources. - -Github issues: [#1521](https://github.com/akvo/akvo-rsr/issues/1521), [#1530](https://github.com/akvo/akvo-rsr/issues/1530). - -Bug Fixes ---- - -### Video thumbnails missing -On some pages, the thumbnails for videos of updates were missing. We have now added these. - -Github issue: [#1494](https://github.com/akvo/akvo-rsr/issues/1494). - -### Search query displayed incorrectly on MyRSR -The search query for some pages in MyRSR was displayed incorrectly when the search has no results. This has now been fixed. - -Github issue: [#1498](https://github.com/akvo/akvo-rsr/issues/1498). - -### Change password broken in MyRSR -The change password functionality in MyRSR was broken, this has now been fixed. - -Github issue: [#1511](https://github.com/akvo/akvo-rsr/issues/1511). - -Under the Hood ---- - -### Responsive design for organisation page -We have changed the layout of the organisation page, so that it is fully responsive. - -Github issue: [#1375](https://github.com/akvo/akvo-rsr/issues/1375). - -### Mark all strings as translatable -In preparation for a multi-lingual RSR v3, we have marked all strings as translatable. - -Github issue: [#1421](https://github.com/akvo/akvo-rsr/issues/1421). - -### Performance of MyRSR user management page -At times, the user management page in MyRSR was very slow. We have rewritten this page to increase the performance. - -Github issue: [#1499](https://github.com/akvo/akvo-rsr/issues/1499). - -### Performance of search in project admin -The search in the project admin could get slow when creating a search query with multiple words. We have now limited the search fields so that the performance of search is increased. - -Github issue: [#1519](https://github.com/akvo/akvo-rsr/issues/1519). - -### Performance of API and pages with updates -In general, we have increased the performance of the API. However, we have also put a limit on the API to show 30 objects per page by default, and a maximum of 100 objects per page. - -In addition, we noticed that pages showing updates were slow as well. The performance of these pages has been increased. - -Github issue: [#1523](https://github.com/akvo/akvo-rsr/issues/1523). - -### Increase the character limit on results and indicators -In preparation for paperless reporting, we have increased the character limit on descriptions and comments of the results and indicators fields. Previously these were set to 255 characters, they have now been increased to allow up to 2000 characters. - -Github issue: [#1542](https://github.com/akvo/akvo-rsr/issues/1542). - -Akvo RSR version 3.2 Flying Fish Cove ---- - -Wednesday 15th April 2015, kasperbrandt - -New & Noteworthy ---- - -### Data export options -On the project page, we have added data export options in the footer. It is possible to export project data in RSS, XML, JSON and IATI format. - -However, for the XML and JSON format it is required that the user is logged in, since this functionality uses our REST API. - -Github issue: [#993](https://github.com/akvo/akvo-rsr/issues/993). - -### IATI export -We have introduced a new section for organisation admins in MyRSR: My IATI. - -In this section it is possible to create an IATI v2.01 file, based on a selection of projects of which the users' organisation is the reporting organisation. - -The generated IATI file can be shown on the organisation page, if desired. - -Github issue: [#1351](https://github.com/akvo/akvo-rsr/issues/1351). - -Introduced Changes ---- - -### MyRSR improvements -We have extended the My Projects, My Updates and User Management sections on MyRSR with a search box. - -In addition, when a user is approved on the User Management page, this will be logged in the admin. - -Furthermore, the titles of the projects in the My Project section and updates in the My Updates section are now links to the respective project or update. - -Finally, we have improved some UI elements on the MyRSR section. Unpublished projects now have a grey background in My Projects, the table on My Projects is shown correctly in Firefox and the text in all action buttons is now visible at all times. - -Github issues: [#1079](https://github.com/akvo/akvo-rsr/issues/1079), [#1398](https://github.com/akvo/akvo-rsr/issues/1398), [#1410](https://github.com/akvo/akvo-rsr/issues/1410), [#1413](https://github.com/akvo/akvo-rsr/issues/1413), [#1418](https://github.com/akvo/akvo-rsr/issues/1418), [#1420](https://github.com/akvo/akvo-rsr/issues/1420). - -### Result data -Result and indicator data is now displayed in the accordion on the project page in a nested manner. - -Github issue: [#1267](https://github.com/akvo/akvo-rsr/issues/1267). - -### Last update on project list -In the project list, the date of the last update is now shown. When clicked, the user will be redirected to this update. - -Github issue: [#1281](https://github.com/akvo/akvo-rsr/issues/1281). - -### Organisation page improvements -We have added links to all projects and all updates of an organisation to an organisation page. - -In addition, the funding information is aligned to the right and the amounts are displayed with two decimals. - -Github issues: [#1285](https://github.com/akvo/akvo-rsr/issues/1285), [#1286](https://github.com/akvo/akvo-rsr/issues/1286), [#1416](https://github.com/akvo/akvo-rsr/issues/1416). - -### Hide updates of unpublished projects -In the updates list, the updates of unpublished projects are not shown anymore. - -Github issue: [#1323](https://github.com/akvo/akvo-rsr/issues/1323). - -### Partners of a project -We have added the logos of partners to the partner pop-up on the project page. Also, it is now possible to click the ```+ more``` button to show a new page with a list of all partners of a project. - -Github issue: [#1358](https://github.com/akvo/akvo-rsr/issues/1358). - -### Last modified sorting -The filter that was previously named 'last updated' is now named 'last modified', since it not only sorts by updates, but also by general edits of a project. - -Github issue: [#1377](https://github.com/akvo/akvo-rsr/issues/1377). - -### User employment admin improvements -We have added search and filter options for the user employment admin. - -Github issue: [#1379](https://github.com/akvo/akvo-rsr/issues/1379). - -### Custom thumbnails in the API -The Django Rest Framework-based API now supports the creation of thumbnails for the images in the Project, Organisation and ProjectUpdate models. - -The thumbnail is created on a GET request when the paramterer ```image_thumb_name``` is added. The value of image_thumb_name is one or more names of the thumbnails requested. In addition to the ```image_thumb_name``` parameter, for each image named a second parameter is added, specifying the size of each thumbnail. - -Example of an API call using this new functionality: ```http://rsr.akvo.org/rest/v1/project/?image_thumb_name=big,small&image_thumb_small_width=90&image_thumb_big_max_size=300x200``` - -The first practical use of the custom thumbnail in the API is by Akvo RSR Up, that now fetches thumbnails of the correct size for mobile. - -Github issue: [#1384](https://github.com/akvo/akvo-rsr/issues/1384). - -### Remove v3 notification -The notification of RSR v3 in the bottom right corner of the project list has been removed. - -Github issue: [#1385](https://github.com/akvo/akvo-rsr/issues/1385). - -### Rename partner filter to organisation -The filter on the project list previously named 'partner' is now named 'organisation'. - -Github issue: [#1402](https://github.com/akvo/akvo-rsr/issues/1402). - -### Donate button -The donate button on the project main page has its' own new section, including the budget needed information. - -Github issue: [#1414](https://github.com/akvo/akvo-rsr/issues/1414). - -### Map on smaller screens -We received feedback that the map on smaller screens, such as an iPad, would disappear. This is changed now so that the map is only hidden on the narrowest screen size. - -Github issue: [#1433](https://github.com/akvo/akvo-rsr/issues/1433). - -### Look and feel of search dropdown -We have changed the UI of the search dropdown on the project, update and organisation listing pages. - -Github issue: [#1434](https://github.com/akvo/akvo-rsr/issues/1434). - -Bug Fixes ---- - -### Search for special characters -We have fixed a bug that would display a server error when searching for special characters, such as ```é```. - -Github issue: [#1284](https://github.com/akvo/akvo-rsr/issues/1284). - -### Sorting of organisation names -We have fixed the sorting of organisation names. Previously, organisation 'ZZZ' would appear above 'Zaa' because of capitals. - -Github issue: [#1338](https://github.com/akvo/akvo-rsr/issues/1338). - -### Styling of update and organisation list -The red and green hovers on respectively the organisation and update list pages had been removed, but are back in now. - -Github issue: [#1380](https://github.com/akvo/akvo-rsr/issues/1380). - -Under the Hood ---- - -### Upgrade to Django 1.7 -We have upgraded our Django library to version 1.7. This will allow us to use the Django native migrations, and many other improvements. - -Github issue: [#1324](https://github.com/akvo/akvo-rsr/issues/1324). - -### Cleanup of old files -We have cleaned up the repository by removing unused files stemming from either RSR v2 or the transition to Postgres. - -Github issues: [#1234](https://github.com/akvo/akvo-rsr/issues/1234), [#1340](https://github.com/akvo/akvo-rsr/issues/1340). - -### Piwik -We have added code for tracking Akvo Pages and CNAME addresses, which was not in anymore after the RSR v3 release. - -Github issue: [#1305](https://github.com/akvo/akvo-rsr/issues/1305). - -### Akvo Pages permissions -We have added permissions for Akvo Pages, so that it is possible for organisation admins to view and edit their Akvo Page in the admin. - -Github issue: [#1365](https://github.com/akvo/akvo-rsr/issues/1365). - -### Gulp-react update -We have updated the version of gulp-react, to match the version of React used in RSR. - -Github issue: [#1371](https://github.com/akvo/akvo-rsr/issues/1371). - -Akvo RSR version 3.1 Episkopi ---- - -Thursday 18th March 2015, adriancollier - -New & Noteworthy ---- - -### Reintroduction of Project Donations -Within the v3 release we disabled project donations as there were some issues with the process that was not possible to resolve in a short enough time period. We have now had enough time to look at this and we are pleased to be able to reinstate the donation functionality. - -It will be possible again to donate to a project using iDeal or Paypal. - -Github issue: [#1265](https://github.com/akvo/akvo-rsr/issues/1265) - -### New User Process -Following on from the changes to registration and approval made in v3, we have now added some further functionality to assist Akvo users to approve and have access to all the right users. - -These changes include a new option for Akvo staff to be labelled as Support user and this means that they can make the necessary changes for all users. - -Akvo staff that are not tagged as being support staff will not receive new user notifications any more. - -Github issue: [#1042](https://github.com/akvo/akvo-rsr/issues/1042) - -Introduced Changes ---- - -### IATI Organisation ID on Organisation Page -We have added the IATI Organisation ID to the Organisation page. - -Github issue: [#1293](https://github.com/akvo/akvo-rsr/issues/1293) - -### Link to Organisation in Transactions -As Transactions on a project can be linked to a partner, we have now enabled the option for users to select an existing organisation in RSR as the linked partner for transactions. This should help with better data quality and an improved ability to follow the chain. - -Github issue: [#1317](https://github.com/akvo/akvo-rsr/issues/13117) - -### Removed Goals and Categories from Project Admin -Since we have made a replacement of Goals and Categories within the RSR data model for Results and Sectors. Now that this is the new model, we have removed the older ones from the Admin. We will retain the data for some time just to be safe, but this will not be publicly accessible for now. - -Github issue: [#1316](https://github.com/akvo/akvo-rsr/issues/1316) - -### Reporting Organisation Requirement -Due to the changes in the domain model in v3, it was unclear to many partners on the new partner types and in particular who is the reporting organisation on a project. We will be working to take our existing data and specify who is the Reporting organisation for our entire portfolio of projects shortly. In the meantime we have removed the need for this field to be filled in. - -Github issue: [#1299](https://github.com/akvo/akvo-rsr/issues/1299) - -### Related Projects to the Project Admin Form -Previously it was possible to specify related projects and their relationship, but this was done independently from the project data. We have now moved this into the project form so it's possible to specify this information at the same time as completing a project. - -Github issue: [#1290](https://github.com/akvo/akvo-rsr/issues/1290) - -Bug Fixes ---- - -### Budget Label -When users entered a custom budget item label this was not being displayed on the financial screen as it did before the v3 release. This has been fixed and now the custom label is being correctly displayed. - -Github issue: [#1261](https://github.com/akvo/akvo-rsr/issues/1261) - -### Markup on Project Descriptions -When users included markup within the text on description fields, this was not being rendered correctly on the project pages. We have now resolved this, so the markup is now correctly rendered. - -Github issue: [#1262](https://github.com/akvo/akvo-rsr/issues/1262) - -### Goals Overview -The Goals Overview section was missing from the project page despite being part of the project data set. So we've added this back in. - -Github issue: [#1264](https://github.com/akvo/akvo-rsr/issues/1264) - -### Currency amounts -We have satndardised the currency display to ensure that the alignment and presence of 2 decimal places on all financial figures is correctly visualised. - -Github issue: [#1292](https://github.com/akvo/akvo-rsr/issues/1292) - -### Budgets Shown Twice -We noticed that some budget items were being displayed twice in the Financial overview page for projects. We have now resolved this so the budget only shows up once per entry. - -Github issue: [#1347](https://github.com/akvo/akvo-rsr/issues/1347) - -### Tidying of Font Case for Sectors -We have unified the case of text for sectors within RSR. Previously some sectors were listed with all capitals, or all small letters and the subsequent order in lists was being affected. - -We have resoled this to now generate the sectors in a normalised manner and so the lists will all be truly alphabetical and it should be much easier to find the sector you are looking for. - -Github issue: [#1330](https://github.com/akvo/akvo-rsr/issues/1330) - -### Removed Partner Type Extra -We had an additional partner type field to take into account additional options within the IATI Standard that were not part of RSR. We have now pulled this data into RSR, so we have now removed the additional field. - -Github issue: [#1321](https://github.com/akvo/akvo-rsr/issues/1321) - -### Show amount received for Donations -We noticed that we were displaying the amount sent for donations, which due to transaction costs, can be lower than the amount that is received by Akvo and passed on to the project. - -To make it clear for users reading the project, we have swapped this back to displaying the amount received. - -Github issue: [#1318](https://github.com/akvo/akvo-rsr/issues/1318) - -### API Errors for Partner Website -After the v3 changes, we found an error in the API resources that made some certain calls inaccessible without implementing an API authentication key. Seeing as the information being called here has no reason to remain private we made a fix that put the resource back into the public domain that then resolved the issue. - -Github issue: [#1259](https://github.com/akvo/akvo-rsr/issues/1259) - -### Link from /update/ -We used to have a link from a project to add an update that sat at /update. In the v3 upgrade, this got changed to /add_update, so we have added a redirect to ensure that existing workflows remain working. - -Github issue: [#1308](https://github.com/akvo/akvo-rsr/issues/1308) - -### Pagination on empty lists -We discovered a bug that visually displayed a double set of results and sorting options on the listing pages even when no results were displayed. - -Github issue: [#1283](https://github.com/akvo/akvo-rsr/issues/1283) & [#1280](https://github.com/akvo/akvo-rsr/issues/1280) - -### Pagination on All Project Updates Page -We introduced a new page to display all project updates for a particular project, but we noticed that all were displayed on a single page and the pagination options displayed were not responding. This has been resolved to show a set of updates at a time and made it possible to navigate to the next page and back again. - -Github issue: [#1276](https://github.com/akvo/akvo-rsr/issues/1276) - -### Project Image Encoding Error -When project images are not able to be correctly displayed within RSR these were causing the entire page to stop loading. We have modified this function so that now the image is skipped from the carousel but the page still renders. - -Github issue: [#1312](https://github.com/akvo/akvo-rsr/issues/1312) - -Under the Hood ---- - -### Upgrade Django to v1.6.9 -A new version of Django has some security changes we wanted to include within RSR so we have updated the version we are using. - -Github issue: [#1011](https://github.com/akvo/akvo-rsr/issues/1011) - -### Upgrade Pillow for Security Release -We upgraded our version of pillow to take into account a recent security improvmeent. - -Github issue: [#1010](https://github.com/akvo/akvo-rsr/issues/1010) - -### Enable Debug Toolbar -We use the Django Debug Toolbar for assisting with development of RSR. We have now added this to the Vagrant setup so all developers on RSR will have access to this. - -Github issue: [#1018](https://github.com/akvo/akvo-rsr/issues/1018) - -### Add created_at timestamps to all Projects and Organisations -Some time ago we added created_at timestamps to Projects and Organisations that are now being populated when new items are created. We have now run a script that populates these values for all previously existing items to improve data quality. - -Github issue: [#1116](https://github.com/akvo/akvo-rsr/issues/1116) - -### Page Load Time Improvements -We have made many changes to the frrequency and efficiency of database calls within RSR in an attempt to improve the overall responsiveness and speed of the system. - -With these changes we are seeing a vast improvement when view list pages loading up to 6 times faster, and a moderate improvement across the rest of the system. - -Github issue: [#1258](https://github.com/akvo/akvo-rsr/issues/1258) - -### Update of API Import Scripts -Since the v3 changes in RSR, many more fields from the IATI Standard are now available to be stored within RSR. We have taken a look at the API Import processes we have in place and updated these to include all the newly available information. We will start to notice going forwards that projects populated through this import will have a much richer data set. - -Github issue: [#1331](https://github.com/akvo/akvo-rsr/issues/1331) & [#879](https://github.com/akvo/akvo-rsr/issues/879) - -### Github Wiki Tidy -We have made an effort towards unifying the documentation for RSR. We have now removed all documentation that used to sit directly within the repository, and now this resides within the Github Wiki for RSR. - -Github issue: [#1334](https://github.com/akvo/akvo-rsr/issues/1334) - -### Gulp Errors -The errors that were being generated by Gulp out of the box were not very informative and so made trouble shooting more complicated. With the addition of Gulp Plumber, we have been able to make these errors more intuitive to assist the development. - -Github issue: [#1333](https://github.com/akvo/akvo-rsr/issues/1333) - -### Django Nest Inlines Library -We use a library within RSR called django_nested_inlines. The version we were using was out of date and not maintained, but we located a version that has been updated, so we have switched to this new version. - -Github issue: [#1309](https://github.com/akvo/akvo-rsr/issues/1309) - -### Add Landscape Badge to Github -A tool we use called landscape has a feature that provides code quality information when making changes to the repository. We have added the code that automates this process, giving us hints on the quality changes we make while we make them. - -Github issue: [#1297](https://github.com/akvo/akvo-rsr/issues/1297) - -### Added RSR Version Number to API Responses -To better assist with troubleshooting and to provide more information to people and services connecting to RSR, we have added the version number to the header of responses. - -Github issue: [#749](https://github.com/akvo/akvo-rsr/issues/749) - -### Remove MiniCMS Model -We used to use a model within RSR called MiniCMS. This was to populate and manage the content on the Akvo.org website before we split this out from RSR. Now that the website is independently managed through the Wordpress installation, we can remove this model from RSR. - -Github issue: [#727](https://github.com/akvo/akvo-rsr/issues/727) - -________ - -Akvo RSR version 3.0.2 Hotfix 2 for Douglas ---- - -Thursday 5th March 2015, adriancollier - -Included Fixes ---- - -### Correction to API Authentication issue -We noticed that since the RSR v3 release, we were experiencing an issue with certain API calls that were requiring authentication where previously these were open. This change is to fix this to allow these resources to be fully accessible again. - -Github issue: [#1289](https://github.com/akvo/akvo-rsr/issues/1289) - --------- - -Akvo RSR version 3.0.1 Hotfix for Douglas ---- - -Friday 27th February 2015, adriancollier - -Included Fixes ---- - -### All Updates for a Project -We noticed that in the new designs there was a missing view showing all project updates belonging to a single project. We have now added this in to the project page and given it a new style to match the other pages. - -Github issue: [#1260](https://github.com/akvo/akvo-rsr/issues/1260) - -### Update Text with Links -We noticed a bug where project updates that included links were breaking the layout of the page with text ending up in the header of the page. This has now been resolved. - -Github issue: [#1257](https://github.com/akvo/akvo-rsr/issues/1257) - -### Location Target in API -We have modified the location API resource within the Django REST Framework API implementation as the lack of location target was causing errors. - -Github issue: [#1266](https://github.com/akvo/akvo-rsr/issues/1266) - --------- - -Akvo RSR version 3.0 Douglas ---- - -Thursday 26th February 2015, adriancollier - -New & Noteworthy ---- - -### New Visual Design -The biggest change in this release and for sure the part you won't be able to miss is the new visual styling that has been applied throughout the platform. We've given all pages a new look, with an emphasis on making it easier for the user to find exactly what they're looking for. - -All pages have also been coded to be responsive to the device size that's being used, so now RSR is friendly for use on mobile and tablets. - -Github issue: [#733](https://github.com/akvo/akvo-rsr/issues/733), [#744](https://github.com/akvo/akvo-rsr/issues/744), [#759](https://github.com/akvo/akvo-rsr/issues/759), [#764](https://github.com/akvo/akvo-rsr/issues/764), [#786](https://github.com/akvo/akvo-rsr/issues/786), [#806](https://github.com/akvo/akvo-rsr/issues/806), [#807](https://github.com/akvo/akvo-rsr/issues/807), [#808](https://github.com/akvo/akvo-rsr/issues/808), [#811](https://github.com/akvo/akvo-rsr/issues/811), [#825](https://github.com/akvo/akvo-rsr/issues/825), [#839](https://github.com/akvo/akvo-rsr/issues/839), [#842](https://github.com/akvo/akvo-rsr/issues/842), [#843](https://github.com/akvo/akvo-rsr/issues/843), [#847](https://github.com/akvo/akvo-rsr/issues/847), [#856](https://github.com/akvo/akvo-rsr/issues/856), [#859](https://github.com/akvo/akvo-rsr/issues/859), [#866](https://github.com/akvo/akvo-rsr/issues/866), [#909](https://github.com/akvo/akvo-rsr/issues/909), [#914](https://github.com/akvo/akvo-rsr/issues/914), [#925](https://github.com/akvo/akvo-rsr/issues/925), [#926](https://github.com/akvo/akvo-rsr/issues/926), [#933](https://github.com/akvo/akvo-rsr/issues/933), [#947](https://github.com/akvo/akvo-rsr/issues/947), [#957](https://github.com/akvo/akvo-rsr/issues/957), [#969](https://github.com/akvo/akvo-rsr/issues/969), [#971](https://github.com/akvo/akvo-rsr/issues/971), [#976](https://github.com/akvo/akvo-rsr/issues/976), [#986](https://github.com/akvo/akvo-rsr/issues/986), [#987](https://github.com/akvo/akvo-rsr/issues/987), [#989](https://github.com/akvo/akvo-rsr/issues/989), [#996](https://github.com/akvo/akvo-rsr/issues/996), [#998](https://github.com/akvo/akvo-rsr/issues/998), [#1008](https://github.com/akvo/akvo-rsr/issues/1008), [#1009](https://github.com/akvo/akvo-rsr/issues/1009), [#1012](https://github.com/akvo/akvo-rsr/issues/1012), [#1028](https://github.com/akvo/akvo-rsr/issues/1028), [#1030](https://github.com/akvo/akvo-rsr/issues/1030), [#1031](https://github.com/akvo/akvo-rsr/issues/1031), [#1057](https://github.com/akvo/akvo-rsr/issues/1057), [#1082](https://github.com/akvo/akvo-rsr/issues/1082), [#1084](https://github.com/akvo/akvo-rsr/issues/1084), [#1087](https://github.com/akvo/akvo-rsr/issues/1087), [#1088](https://github.com/akvo/akvo-rsr/issues/1088), [#1118](https://github.com/akvo/akvo-rsr/issues/1118), [#1119](https://github.com/akvo/akvo-rsr/issues/1119), [#1123](https://github.com/akvo/akvo-rsr/issues/1123), [#1126](https://github.com/akvo/akvo-rsr/issues/1126), [#1130](https://github.com/akvo/akvo-rsr/issues/1130), [#1147](https://github.com/akvo/akvo-rsr/issues/1147), [#1150](https://github.com/akvo/akvo-rsr/issues/1150), [#1162](https://github.com/akvo/akvo-rsr/issues/1162), [#1164](https://github.com/akvo/akvo-rsr/issues/1164), [#1169](https://github.com/akvo/akvo-rsr/issues/1169), [#1180](https://github.com/akvo/akvo-rsr/issues/1180), [#1197](https://github.com/akvo/akvo-rsr/issues/1197), [#1198](https://github.com/akvo/akvo-rsr/issues/1198), [#1208](https://github.com/akvo/akvo-rsr/issues/1208) & [#1212](https://github.com/akvo/akvo-rsr/issues/1212). - -### MyRSR Section -A completely new section has been added into the platform called MyRSR. This is available for all users that are logged in to their accounts, and gives direct access to the content that is available to the user. - -This is the first big step towards bringing all actions that users need to be able to perform into the front end of the platform, with carefully crafted interfaces that provide exactyl the right functionality. - -In this release MyRSR contains areas for Projects, Updates and User Management. While some tasks still require the use of the RSR Admin, we've provided more direct links to the exact places in the Admin for ease of use, and we'll continue to work on replacing many of these Admin tasks with similar front end interfaces. - -Github issue: [#780](https://github.com/akvo/akvo-rsr/issues/780), [#781](https://github.com/akvo/akvo-rsr/issues/781), [#814](https://github.com/akvo/akvo-rsr/issues/814), [#835](https://github.com/akvo/akvo-rsr/issues/835), [#852](https://github.com/akvo/akvo-rsr/issues/852), [#873](https://github.com/akvo/akvo-rsr/issues/873), [#915](https://github.com/akvo/akvo-rsr/issues/915), [#970](https://github.com/akvo/akvo-rsr/issues/970), [#1026](https://github.com/akvo/akvo-rsr/issues/1026), [#1046](https://github.com/akvo/akvo-rsr/issues/1046), [#1125](https://github.com/akvo/akvo-rsr/issues/1125), [#1188](https://github.com/akvo/akvo-rsr/issues/1188), [#1193](https://github.com/akvo/akvo-rsr/issues/1193) & [#1204](https://github.com/akvo/akvo-rsr/issues/1204). - -### Site Navigation -An important part of the new design is a new header that has been added to RSR. This gives access to different parts of the site as well as giving RSR a bit more of it's own brand identity. - -Github issue: [#942](https://github.com/akvo/akvo-rsr/issues/942), [#1111](https://github.com/akvo/akvo-rsr/issues/1111), [#1132](https://github.com/akvo/akvo-rsr/issues/1132) & [#1163](https://github.com/akvo/akvo-rsr/issues/1163). - -### Project Hierarchy -We've always been fond of the phrase "follow the money" here, and we think that it's an important element of visualising collaborative aid spending. To promote this, we have designed a new extension of the project page that called the Hierarchy. This page displays a visual representation of a project and all the projects that are related - either by funding, being funded, or coming from the same funding pool. - -We realise that initially there will not be a lot of data in this section, but we hope that partners will start populating this data and we'll start seeing some interesting mappings of projects. - -Github issue: [#904](https://github.com/akvo/akvo-rsr/issues/904), [#949](https://github.com/akvo/akvo-rsr/issues/949) & [#1039](https://github.com/akvo/akvo-rsr/issues/1039). - -### Project Data Reports -In previous releases we have made many changes to the data model of RSR to bring in more of the IATI standard into the data that we collect and hold on projects. So far, much of this data has remained hidden, but we now have a full data report for projects. - -From any project page it will now be possible to view the full project report containing all the available information we hold on a project. As an added benefit, you can also download this information in pdf format. - -Github issue: [#994](https://github.com/akvo/akvo-rsr/issues/994) & [#1196](https://github.com/akvo/akvo-rsr/issues/1196). - - -New or Improved Features ---- - -### User Registration Process -We've completely overhauled the user regsitration process, making sure that it's clear and easy to follow in the hope to reduce the number of issues our users were having while siging up for an account. - -Github issue: [#766](https://github.com/akvo/akvo-rsr/issues/766), [#783](https://github.com/akvo/akvo-rsr/issues/783), [#790](https://github.com/akvo/akvo-rsr/issues/790), [#823](https://github.com/akvo/akvo-rsr/issues/823), [#824](https://github.com/akvo/akvo-rsr/issues/824), [#884](https://github.com/akvo/akvo-rsr/issues/884), [#905](https://github.com/akvo/akvo-rsr/issues/905), [#906](https://github.com/akvo/akvo-rsr/issues/906), [#1044](https://github.com/akvo/akvo-rsr/issues/1044), [#1045](https://github.com/akvo/akvo-rsr/issues/1045), [#1078](https://github.com/akvo/akvo-rsr/issues/1078), [#1092](https://github.com/akvo/akvo-rsr/issues/1092), [#1104](https://github.com/akvo/akvo-rsr/issues/1104), [#1145](https://github.com/akvo/akvo-rsr/issues/1145), [#1200](https://github.com/akvo/akvo-rsr/issues/1200) & [#1201](https://github.com/akvo/akvo-rsr/issues/1201). - -### Password Reset -There's now a new Password Reset process within the MyRSR section. We also tidied up the previous process for those users who are not logged in. - -Github issue: [#760](https://github.com/akvo/akvo-rsr/issues/760), [#797](https://github.com/akvo/akvo-rsr/issues/797) & [#952](https://github.com/akvo/akvo-rsr/issues/952). - -### Image Management -We made some changes to the way images are managed. This includes increasing the upload size of images within updates, as well as a great new way to be able to access the original high resolution images. - -Github issue: [#893](https://github.com/akvo/akvo-rsr/issues/893), [#953](https://github.com/akvo/akvo-rsr/issues/953), [#968](https://github.com/akvo/akvo-rsr/issues/968), [#1114](https://github.com/akvo/akvo-rsr/issues/1114) & [#901](*https://github.com/akvo/akvo-rsr/issues/901). - -### Searching and Filtering -We made significant improvements to the search, filtering and sorting functionality for RSR. This is visible now within the listing pages and should give users all the tools they need to find the content they are looking for. - -Github issue: [#770](https://github.com/akvo/akvo-rsr/issues/770), [#812](https://github.com/akvo/akvo-rsr/issues/812), [#848](https://github.com/akvo/akvo-rsr/issues/848), [#939](https://github.com/akvo/akvo-rsr/issues/939), [#1041](https://github.com/akvo/akvo-rsr/issues/1041), [#1060](https://github.com/akvo/akvo-rsr/issues/1060), [#1073](https://github.com/akvo/akvo-rsr/issues/1073), [#1113](https://github.com/akvo/akvo-rsr/issues/1113), [#1120](https://github.com/akvo/akvo-rsr/issues/1120), [#1156](https://github.com/akvo/akvo-rsr/issues/1156), [#1191](https://github.com/akvo/akvo-rsr/issues/1191) & [#1192](https://github.com/akvo/akvo-rsr/issues/1192). - -### Project Documents -Added the ability to be able to upload project documents directly into RSR for them to be visible and downloadable from the project page. - -Github issue: [#1025](https://github.com/akvo/akvo-rsr/issues/1025). - -### Feedback Button -Added a new Feedback Button in the footer of every page to make it easier for users to let us know what they think. - -Github issue: [#1049](https://github.com/akvo/akvo-rsr/issues/1049) & [#1144](https://github.com/akvo/akvo-rsr/issues/1144). - -### New in RSR Notice -Created a new temporary box that informs users of the new changes and provides a link to give further information about what has changed. - -Github issue: [#1050](https://github.com/akvo/akvo-rsr/issues/1050) & [#1184](https://github.com/akvo/akvo-rsr/issues/1184). - -### Cookie Notification -We have added a new banner to inform users about the Cookies that we use within RSR and a link to the cookie policy we hold. - -Github issue: [#1051](https://github.com/akvo/akvo-rsr/issues/1051). - -### API Improvements -We made some modifications to the API to align with the other changes in RSR. - -Github issue: [#776](https://github.com/akvo/akvo-rsr/issues/776) & [#955](https://github.com/akvo/akvo-rsr/issues/995). - -### Data Model Modifications -Following on from our previous changes to the data model to move towards the IATI standard, we have made a few more changes here to move the underlying data into this new structure. The old elements remain for now, and we will be working to tidy this up over the next few releases. - -Github issue: [#872](https://github.com/akvo/akvo-rsr/issues/872), [#945](https://github.com/akvo/akvo-rsr/issues/945), [#1001](https://github.com/akvo/akvo-rsr/issues/1001), [#1003](https://github.com/akvo/akvo-rsr/issues/1003), [#1032](https://github.com/akvo/akvo-rsr/issues/1032), [#1047](https://github.com/akvo/akvo-rsr/issues/1047), [#1075](https://github.com/akvo/akvo-rsr/issues/1075) & [#1103](https://github.com/akvo/akvo-rsr/issues/1103). - -### Project Timeline -We have created a new project timeline; however we were not fully happy with the way it was being displayed so this has not been released in this version. We will be looking at this and launching the project timeline as soon as we can. - -Github issue: [#890](https://github.com/akvo/akvo-rsr/issues/890). - -### Donations -Due to the change in many of the existing processes, we have made the decision to temporarily disable the automated donation process. It is still possible to donate to a project by sending the funds in to Akvo directly, and we will be re-enabling the automated process as soon as possible. - -Github issue: [#1135](https://github.com/akvo/akvo-rsr/issues/1135). - - -Backend and Structural Changes ---- - -### Development Environment -In order to ensure that our developers can all work locally on RSR, we have needed to put some effort into getting the environment up and running with all the changes we have made. - -Github issue: -[#804](https://github.com/akvo/akvo-rsr/issues/804), [#805](https://github.com/akvo/akvo-rsr/issues/805), [#844](https://github.com/akvo/akvo-rsr/issues/844), [#885](https://github.com/akvo/akvo-rsr/issues/885), [#889](https://github.com/akvo/akvo-rsr/issues/889) & [#1187](https://github.com/akvo/akvo-rsr/issues/1187). - -### Other Backend Changes -We also had to make a whole host of smaller invisible changes to the system to manage all the front end changes we made. These vary from modifications to python libraries to fixing minor issues in the workflow of the application. - -Github issue: [#747](https://github.com/akvo/akvo-rsr/issues/747), [#751](https://github.com/akvo/akvo-rsr/issues/751), [#753](https://github.com/akvo/akvo-rsr/issues/753), [#761](https://github.com/akvo/akvo-rsr/issues/761), [#810](https://github.com/akvo/akvo-rsr/issues/810), [#813](https://github.com/akvo/akvo-rsr/issues/813), [#817](https://github.com/akvo/akvo-rsr/issues/817), [#822](https://github.com/akvo/akvo-rsr/issues/822), [#832](https://github.com/akvo/akvo-rsr/issues/832), [#841](https://github.com/akvo/akvo-rsr/issues/841), [#845](https://github.com/akvo/akvo-rsr/issues/845), [#853](https://github.com/akvo/akvo-rsr/issues/853), [#882](https://github.com/akvo/akvo-rsr/issues/882), [#902](https://github.com/akvo/akvo-rsr/issues/902), [#912](https://github.com/akvo/akvo-rsr/issues/912), [#924](https://github.com/akvo/akvo-rsr/issues/924), [#982](https://github.com/akvo/akvo-rsr/issues/982), [#991](https://github.com/akvo/akvo-rsr/issues/991), [#1101](https://github.com/akvo/akvo-rsr/issues/1101), [#1105](https://github.com/akvo/akvo-rsr/issues/1105), [#1109](https://github.com/akvo/akvo-rsr/issues/1109), [#1148](https://github.com/akvo/akvo-rsr/issues/1148), [#1159](https://github.com/akvo/akvo-rsr/issues/1159), [#1170](https://github.com/akvo/akvo-rsr/issues/1170), [#1175](https://github.com/akvo/akvo-rsr/issues/1175) & [#1178](https://github.com/akvo/akvo-rsr/issues/1178). - - --------- - -Akvo RSR ver 2.6 Conakry ---- - -Wednesday 17th December 2014, adriancollier - -New & Noteworthy ---- - -### PostgreSQL as the Database Engine - -In this release we are migrating our underlying database engine from MySQL to PostgreSQL. Following on from this change, we will begin to be able to take advantage of many of the additional pieces of functionality that PostgreSQL offers us including Materialised Views. - -Github issue: [#813](https://github.com/akvo/akvo-rsr/issues/813) & [#753](https://github.com/akvo/akvo-rsr/issues/753) - -### Minor Visual Updates - -We have made some minor changes to the data visualisation within RSR. Nothing large, but these should meet some of the demands we've been receiving. - -#### Visualise Identifiers on Project Pages - -If a project has additional identifiers, including an IATI ID or an Internal ID obtained from an external system, then these are now displayed on the Project page alongside the RSR ID. - -Github issue: [#946](https://github.com/akvo/akvo-rsr/issues/946) - -#### Start and End dates - -We are accepting 4 types of dates on a project now, start and end with both planned and actual values. We have now implemented a change to show all of these dates within the Funding page for the project. - -Github issue: [#936](https://github.com/akvo/akvo-rsr/issues/936) - -#### IATI Activity Link in Akvo Pages - -This is a minor fix to enhance the IATI Identifier (if existing) on the Funding page to direct a user towards an external source of further information (such as Openaid.nl) to match the functionality within RSR. - -Github issue: [#868](https://github.com/akvo/akvo-rsr/issues/868) - -#### Partner Name on Akvo Pages - -The Partner Name on Akvo Pages was previously only displaying the short name. We have updated this to match the layout and display of both the name and country as displayed in RSR. - -Github issue: [#729](https://github.com/akvo/akvo-rsr/issues/729) - - --------- - -Akvo RSR ver 2.5.1 Bujumbura Hotfix ---- - -Sunday 2nd November 2014, kasperbrandt - -Bug Fixes ---- - -### Update locations on maps - -We noticed a bug that showed project update locations with (0, 0) as longitude and latitude on the maps, these are now not shown anymore. - -Github issue: [#837](https://github.com/akvo/akvo-rsr/issues/837) - -### Cordaid import - -Two bugs in the Cordaid import have been fixed. One causing the import to run slowly due to the 'sync_owner' field, and another that did not import the 'date_start_planned' and 'date_end_planned' fields correctly. - -Github issue: [#865](https://github.com/akvo/akvo-rsr/issues/865) - --------- - -Akvo RSR ver 2.5 Bujumbura ---- - -Wednesday 21st October 2014, adriancollier - -Improvements ---- - -### Filtering of Updates - -The API has been modified to allow the list of updates to be filtered on timestamp. This was to ensure that the RSR API is fully compatible with the upcoming release of RSR Up. - -Github issue: [#769](https://github.com/akvo/akvo-rsr/issues/769) - -Bug Fixes ---- - -### Finalisation of PayPal Donations - -We noticed a bug that was preventing PayPal donations from being completed as the callback from the PayPal service was not being correctly read. This has been fixed and we will apply this to all affected donations. - -Github issue: [#796](https://github.com/akvo/akvo-rsr/issues/796) - -### IATI Export Activity ID - -There was a mistake in the IATI export that resulted in an incorrect IATI ID being applied to activities that has now been rectified. - -Github issue: [#799](https://github.com/akvo/akvo-rsr/issues/799) - -### Project Update Extra API Resource - -An issue was discovered that when an organisation has no location, the API resource was returning an error value. While not common, this needed to be resolved for the few instances where this is the case. - -Github issue: [#820](https://github.com/akvo/akvo-rsr/issues/820) - --------- - -Akvo RSR ver 2/4/2 Astana Hotfix II ---- - -Tuesday 30th September 2014, zzgvh - -Included changes ---- - -### Import RAIN IATI Data - -Update the import scripts with better logging, use of online source files for the import adn a bugfix for an API call needed by the RAIN import. - -Github issue: [#710](https://github.com/akvo/akvo-rsr/issues/710) - -### Project exclusion for Pages - -Using keywords introduced in 2.3.9 Yam it is now possible to exclude projects for an Akvo Pages website. - -Github issue: [#745](https://github.com/akvo/akvo-rsr/issues/745) - -### Bugfix for RSR country list - -The country list used in RSR also contains a mapping between countires and continents. The mapping for Bonaire, Sint Eustatius and Saba was missing. - -Github issue: [#748](https://github.com/akvo/akvo-rsr/issues/748) - --------- - -Akvo RSR ver 2/4/1 Astana Hotfix ---- - -Tuesday 16th September 2014, adriancollier - -Included changes ---- - -### Import RAIN IATI Data - -We have been working with our second partner RAIN Foundation to implement an import function that will allow us to take a copy of their published IATI file in order to create RSR projects to reflect their working portfolio. - -The scripts have been created and tested as part of the workflow and now need to be pushed into the live environment for final publication. - -Github issue: [#710](https://github.com/akvo/akvo-rsr/issues/710) - -### Swagger Documentation - Django REST Framework - -We have recently added the Django REST Framework to RSR to provide us with a newer API for both Read and Write functionality that we will continue to build out on. - -Within this area we are looking a lot at the documentation surrounding the API and have installed a library called Swagger that generates some documentation on the resources automatically. - -This feature will intially be available at http://rsr.akvo.org/rest/docs/ but we will continue to work on more structured documentation going forwards. - -Github issue: [#632](https://github.com/akvo/akvo-rsr/issues/632) - -### API Permissions - -We've also made some additions to the permissions when using the API to ensure that we can provide the right access to those that need it when making queries on the new Django REST Framework API. - -Github issue: [#632](https://github.com/akvo/akvo-rsr/issues/632) - - --------- - -Akvo RSR ver 2.4 Astana ---- - -Thursday 28th August 2014, adriancollier - -New and Noteworthy ---- - -### New and Improved RSR API - -We have developed a new API for RSR using the [Django REST Framework](http://www.django-rest-framework.org/). This new API allows organisations to both Read and Write data to the database using an existing RSR user account with the right permissions. The functionality will be tried and tested with a few select partners with which we will work on and implement a full set of API documentation to ensure that it can be effectively utilised. - -Github issue [#632](https://github.com/akvo/akvo-rsr/issues/632) & [#39](https://github.com/akvo/akvo-product-design/issues/39) - -### RSR Updates with Locations - -We have made the first steps in creating the functionality to have locations present with RSR Updates. With this release we can now visualise locations that are provided within RSR Updates on maps displayed within the RSR user interface. - -There is still further work to be done on modifying the Update form to enable the entry of updates, as well as releasing a new version of RSR Up that includes locations also. - -Github issue [#709](https://github.com/akvo/akvo-rsr/issues/709) & [#646](https://github.com/akvo/akvo-rsr/issues/646) - -### Piwik Tracking on Akvo Pages - -We have added some code to Akvo Pages implementations that will allow the traffic going through these to be monitored using our analytics tool Piwik. We will be rolling this out to our partners over the coming weeks to provide portals to obtain this useful user data. - -Github issue [#630](https://github.com/akvo/akvo-rsr/issues/630) - -Features ---- - -### Organisation duplicate logic on API Import - -We have now added some logic to the API import scripts being utilised by Cordaid and soon RAIN Foundation to ensure that the organisation owner flag is considered when determining if the organisation provided should be modified or created. This change will prevent additional duplicate organisations being created during imports. - -Github issue [#690](https://github.com/akvo/akvo-rsr/issues/690) - -### Project Comment timestamp creation - -The timestamp present on the project comment entries were only being generated automatically when submitting new comments using the web form. We have now updated the system so that this is created automatically also if these entries are created using any other means, such as the API. - -Github issue [#659](https://github.com/akvo/akvo-rsr/issues/659) - -Bug Fixes ---- - -### Keyword filtered Akvo Pages dropdowns - -When Akvo Pages are filtered by a keyword rather than an organisation, there was an issue that the dropdowns displayed were still being populated solely with the information relevant to that organisation. This has been resolved to provide the correct dropdown lists for the users. - -Github issue [#665](https://github.com/akvo/akvo-rsr/issues/665) - -### All project widget on Akvo Pages display issue - -We have resolved a problem with the Akvo Pages widget displaying all projects from a partner. There was a grey border that was affecting the layout that has now been removed. - -Github issue [#691](https://github.com/akvo/akvo-rsr/issues/691) - -### Add Update button on Update listing pages - -We discovered an issue where the Add Update button was not being displayed on the page where all updates for a single project are being listed. - -Github issue [#407](https://github.com/akvo/akvo-rsr/issues/407) - -Infrastructure Changes ---- - -### Refactor models.py into a package - -The existing models file that defined the structure of the data in RSR was becoming too large, so we have now refactored this into several different files to make management easier. - -Github issue [#192](https://github.com/akvo/akvo-rsr/issues/192) - - --------- - -Akvo RSR ver 2.3.10 Zambo ---- - -Thursday 31st July 2014, adriancollier - -New and Noteworthy ---- - -### IATI Fields in RSR - -We have made the first contribution to the RSR Database and Admin resources to be able to accomodate all of the IATI Standard. This now means that we can collect and store any information delivered for the IATI Standard within RSR. We are working towards visualising this information wihtin the front end of RSR. - -Github issue [#678](https://github.com/akvo/akvo-rsr/issues/678) - -Bug Fixes ---- - -### 404 page missing media - -We have corrected a bug where the 404 page was no longer displaying the image and styling. - -Github issue [#686](https://github.com/akvo/akvo-rsr/issues/686) - -### Incorrect Password on Akvo Pages - -When a user was logging into RSR via Akvo Pages and they entered their password incorrectly, the format of the page was not displaying correctly. This has now been resolved. - -Github issue [#664](https://github.com/akvo/akvo-rsr/issues/664) - -### Donate Image on PayPal Donation Screen - -The Donate button was missing its visual display button when making a donation through PayPal, so this has now been corrected. - -Github issue [#663](https://github.com/akvo/akvo-rsr/issues/663) - -### Galleria Error on Akvo Pages - -Some users were experiencing errors with images when viewing projects within Akvo Pages. This resulted in the images not being displayed and only an error message in their place. We have made some fixes that we believe should resolve this for all users, but we will be keeping an eye on this. - -Github issue [#473](https://github.com/akvo/akvo-rsr/issues/473) - -### Requesting a non existing Widget - -When a user was requesting an widget that did not exist in RSR, they were receiving a 500 error. This has been changed to correctly provide a 404 error to display that the content is not available. - -Github issue [#198](https://github.com/akvo/akvo-rsr/issues/198) - -### Cancelling donations from Akvo Pages - -When a user is within the donation process and presses the cancel button, they are now correctly redirected back to the page that they came from even if this is on an Akvo Pages instace, where previously they were only being returned to http://rsr.akvo.org. - -Github issue [#147](https://github.com/akvo/akvo-rsr/issues/147) - - --------- - -Akvo RSR ver 2.3.9.2 Yam - Hotfix 2 ---- - -Thursday 24th July 2014, adriancollier - -Included Changes ---- - -### Fixes to Import Scripts - -We made some small fixes to the import scripts to ensure that all was working correctly for the IATI XML Import processes. - -Github issue [#680](https://github.com/akvo/akvo-rsr/issues/680) - - --------- - -Akvo RSR ver 2.3.9.1 Yam - Hotfix ---- - -Tuesday 8th Juyl 2014, adriancollier - -Included Changes ---- - -### Akvo Pages Keyword Maps - -With the implementation of keywords in [#620](https://github.com/akvo/akvo-rsr/issues/620) we noticed that the headline map on Akvo Pages was not updated to display the points for these keyword projects. This has been fixed so it matches the projects being displayed. - -Github issue [#671](https://github.com/akvo/akvo-rsr/issues/671) - -### Akvo Pages Drop-down Filtering - -The drop-down filters for Akvo Pages were not being correctly populated with the keyword content. After trying some things, it appeared that this area of code needs some further investigation to ensure it runs smoothly. In the meantime, we have removed the custom filtering so now all drop-downs contain all possibilities. We AIM to resolve this as soon as possible. - -Github issue [#673](https://github.com/akvo/akvo-rsr/issues/673) - -### Keyword API Management - -We implemented some changes in the API import processes to manage kaywords but it should only be possible to add keywords using the API, existing keywords on projects should not be removed. - -Github issue [#670](https://github.com/akvo/akvo-rsr/issues/670) - --------- - -Akvo RSR ver 2.3.9 Yam ---- - -Wednesday 2nd July 2014, adriancollier - -New and Noteworthy ---- - -### Akvo Pages by Keyword - -We have implemented a big change to the way that Akvo Pages can collect a set of projects. With the addition of Keywords that can be added to projects within the RSR Admin, it will now be possible to create Akvo Pages that utilise one or more of these keywords to select the projects that are being visualised. - -This work will be expanded to also build out more API and other resources that will help our partners to use this functionality in a flexible manner. - -Github issue [#620](https://github.com/akvo/akvo-rsr/issues/620) - -### Updated search functionality - -We have improved the search functionality for searching that now used an AND function on search terms that narrows the results to help you find projects or organisations that match all of the terms entered instead of only 1 of them. -We have also added the project ID to the search options, so that you can now search for a project directly if you know its identifier. - -Github issue [#441](https://github.com/akvo/akvo-rsr/issues/441) - -### Target Group Visualisation - -After including the Target Group field in the project model, we were able to accept data being populated in this field from a file import or directly in the Admin, however this information was not being visualised. The templates have now been updated to include this content within the Project Plan tab on the project page. - -Github issue [#255](https://github.com/akvo/akvo-rsr/issues/255) - -### Akvo Manager user permissions for Organisation - -We have updated the user permissions for the Akvo Manager role so that they are able to update or change the organisation that a user belongs to. This is extremely useful in the event that a user mistakenly registers under an incorrect organisation. - -Github issue [#278](https://github.com/akvo/akvo-rsr/issues/278) - -### Bug in Editing updates on Akvo Pages - -We discovered a bug that prevented updates from being edited when viewed on a partnersite. It should be possible that within the first 20 minutes of posting an update the user can edit the content to fix any small issues with the content. This was generating an error which has now been resolved. - -Github issue [#647](https://github.com/akvo/akvo-rsr/issues/647) - -### Change in Geolocation Provider for the Admin - -We were previously using http://itouchmap.com to link partners to a map to generate their location information. After a suggestion from the Akvo Partner Team we have now swapped this link with http://mygeoposition.com/ that provides a more simple workflow for populating this information. - -Github issue [#649](https://github.com/akvo/akvo-rsr/issues/649) - -Features ---- - -### Removed Primary Location - -After some consideration and user feedback we have simplified the locations models by removing the Primary Location information from the system. It is now implicit that the first project entered into the Admin is the primary location for the project. This prevents many issues that were arising using the Admin project form. - -Github issue [#141](https://github.com/akvo/akvo-rsr/issues/141) - -### Tidying the Support Partner List - -We have made a change to the [support partner list](http://rsr.akvo.org//organisations/support/) that now means only partners with published projects are being displayed here. - -Github issue [#204](https://github.com/akvo/akvo-rsr/issues/204) - -### API Resource Documentation - -We have created [some documentation](https://github.com/akvo/akvo-rsr/blob/develop/docs/RSR%20Features/API/API-Resources.md) that provides information about the Custom API Resources we have created. This will assist developers who are wishing to onboard with the Read API by providing them with a list of the existing resources available in a consumable manner. - -Github issue [#510](https://github.com/akvo/akvo-rsr/issues/510) - -### Organisation Account Types - -We have added some new account types for the Organisation account model that will enable Akvo to tag organisations by their activty and contractual status within RSR to help with accounting and reporting purposes. - -Github issue [#608](https://github.com/akvo/akvo-rsr/issues/608) - -Bug Fixes ---- - -### Multiple languages in XML Import - -If an incoming IATI XML contained 2 tags with the same information in 2 different languages then the scripts were simply importing the last in the list. This has now been updated to actually consider the language tags that are specified in the file so that the correct contents is imported. - -Github issue [#252](https://github.com/akvo/akvo-rsr/issues/252) - -### Post Import Budget Error - -As part of the XML Import functionality there is the functionality to create the budget items included within the file. Due to a recent change in the Budget Item Labels, this process was not working correctly, so we have now made a change to fix this issue. - -Github issue [#652](https://github.com/akvo/akvo-rsr/issues/652) - -### NULL value returned for ``last_modified_at`` - -We fixed a small bug in the API that was returning an incorrect boolean value when querying on the ``last_modified_date`` field where there was no value set for the row being returned. - -Github issue [#477](https://github.com/akvo/akvo-rsr/issues/477) - - -Under the hood ---- - -### Removing old deployment scripts - -With the introduction of newer deployment scripts we have done some work to clear out the old ones that are no longer used. - -Github issue [#362](https://github.com/akvo/akvo-rsr/issues/362) - -### Move akvo.rsr.utils to akvo.utils - -We have refactored the code within akvo.rsr.utils to be compiled into akvo.utils. - -Github issue [#434](https://github.com/akvo/akvo-rsr/issues/434) - - --------- - -Akvo RSR ver 2.3.8 Xylocarp ---- - -Wednesday 11th June 2014, adriancollier - -New and Noteworthy ---- - -### Upgrade to Django 1.6 - -This latest release of Akvo RSR contains a wide variety of back end changes to upgrade the underlying framework that RSR runs on - Django. We were previously running on version 1.4, so we've performed a double staged upgrade to make use of the later features than have been developed with Django. - -Github issue [#544](https://github.com/akvo/akvo-rsr/issues/544) - - -Areas Modified ---- - -### Separated Static and User Media assets - -We have now separated the server location for static media from media that is uploaded by users. This ensures that we can manage and maintain the information in different ways if needed by the use cases of the different sources. - -Github issue [#564](https://github.com/akvo/akvo-rsr/issues/564) - -### Updated Folder Structure - -The folders structure for the application was improved in Django 1.4, but we continued to use the legacy structure. We have now updated this to bring RSR in line with the latest Django folder structure. - -Github issue [#565](https://github.com/akvo/akvo-rsr/issues/565) - -### Fixed ProjectAdmin add view - -We have updated the new project form to work with the improved standards bring implemented in Django 1.5 - -Github issue [#566](https://github.com/akvo/akvo-rsr/issues/566) - -### Upgraded Python Libraries - -We have performed updates of all dependent python libraries where possible to allow us to use the latest versions. - -Github issue [#570](https://github.com/akvo/akvo-rsr/issues/570) - -### New Markdown Solution - -We have implemented a new method of managing Markdown included within Project Updates that uses django_markup. - -Github issue [#572](https://github.com/akvo/akvo-rsr/issues/572) - -### Removed SMS Code - -We had in the past implemented a beta version of an SMS updating tool for RSR that was never fully functional. To tidy up the codebase, we have now removed this code and all references to this. - -Github issue [#574](https://github.com/akvo/akvo-rsr/issues/574) - -### URL Encoding removal - -As part of the Django 1.6 changes, we have removed the URL Encoding from ``reverse()`` arguments. - -Github issue [#575](https://github.com/akvo/akvo-rsr/issues/575) - -### Default value for Boolean Fields - -Required with the Django 1.6 upgrade, we have to specify a default value for Boolean fields within RSR. These have now been specified where previously not present. - -Github issue [#578](https://github.com/akvo/akvo-rsr/issues/578) - -### Update Django URLs - -We have updated the code to ensure that the names of views in {% url %} tag are strings. - -Github issue [#579](https://github.com/akvo/akvo-rsr/issues/579) - -### Fixes for Django 1.7 Upgrade - -While we are not yet planning to update the Django framework to 1.7 yet, we have already provided some updates to key libraries including Tastypie (which runs parts of the RSR API) to provide 1.7 compatibility. - -Github issue [#580](https://github.com/akvo/akvo-rsr/issues/580) - -### Rename ``get_query_set()`` - -A change that takes advantage of some newer features provided in Django 1.6, we have renamed this function. - -Github issue [#583](https://github.com/akvo/akvo-rsr/issues/583) - -### Change in permission methods - -We have replaced ``get_(add|change|delete)_permission`` methods with ``django.contrib.auth.get_permission_codename`` as the previous are now depreciated. - -Github issue [#584](https://github.com/akvo/akvo-rsr/issues/584) - -### Check ``ModelForms`` - -As part of the Django 1.6 upgrade we have updated ``ModelForms``. - -Github issue [#586](https://github.com/akvo/akvo-rsr/issues/586) - -### Implement ``ALLOWED_HOST`` setting - -We have added a new ``ALLOWED_HOST`` setting as needed as part of the Django 1.6 upgrade. - -Github issue [#596](https://github.com/akvo/akvo-rsr/issues/596) - --------------- - -Akvo RSR ver 2.3.7 Watermelon ---- - -Wednesday 28th May 2014, rumca - -New Features ---- - -### Country options on project list - -We have added a feature to only populate the countries dropdown on Akvo Pages with a list of countries where there are projects present. This allows the country selection to always return a project and provides a shorter list to select from. - -Github issue [#176](https://github.com/akvo/akvo-rsr/issues/176) - - -Bug Fixes ---- - -### Content owner in org admin - -The content owner field was accidentally removed during a previous release, this has been reinstated on the organisation admin now. - -Github issue [#558](https://github.com/akvo/akvo-rsr/issues/558) - -### Image/Video files positioning - -We have made a change to the way in which image or videos are positioned on RSR updates. We now only allow the media links to be placed before the update. - -Github issue [#243](https://github.com/akvo/akvo-rsr/issues/243) - -### Removal of YouTube related videos - -When YouTube videos were added to project updates they would display related videos after they had been played. We have made a change to prevent this from happening, as often times the videos were not relevant. - -Github issue [#540](https://github.com/akvo/akvo-rsr/issues/540) - -### Django version upgrade - -As an intermediary step whilst we complete a full upgrade from Django 1.4 to 1.7, we have upgraded to Django 1.4.13 from 1.4.2 to plug recently identified security vulnerabilities. - -Github issue [#522](https://github.com/akvo/akvo-rsr/issues/522) - - -Akvo RSR ver 2.3.6 Voavanga ---- - -Wednesday 14th May 2014, adriancollier - -New Features ---- - -### Add Update button change - -If a user was attempting to add an update to a project that they didn't have the permission for, then they were being served a 403 error page. We have now changed this activity to grey out the Add Update button for users that do not have permission to add updates on individual projects. - -Github issue [#150](https://github.com/akvo/akvo-rsr/issues/150) - -### Character validation in admin - -Now that we are working with XML more deeply with the API and IATI information, we have added validation to the RSR admin to check for any characters that have been included within the added fields that are not valid within XML. A warning is now displayed in the event that any of these characters are present. - -Github issue [#242](https://github.com/akvo/akvo-rsr/issues/242) - -### Back button on Akvo Pages - -We have added a custom option to Akvo Pages to allow the back button to have a different text added. So now our partners can allow this button to say something more appropriate to the location that the user will be taken to upon pressing. - -Github issue [#258](https://github.com/akvo/akvo-rsr/issues/258) - -### Sign in target location - -We have tidied up the signing in process to direct users to the main page after completing the sign in process. - -Github issue [#301](https://github.com/akvo/akvo-rsr/issues/301) - -### Organisation filter on Akvo Pages - -We had previously removed the project filter on Akvo Pages that allows any project to be viewed within a Pages instance. This has now been extended to organisations so that organisations can be visualised within an instance without the need for that organisation to be present within projects. - -Github issue [#433](https://github.com/akvo/akvo-rsr/issues/433) - -### Facebook meta information - -We have tidied up the meta information when sharing projects via Facebook to provide the information of the organisation that owns the Akvo Pages instance in place of Akvo. - -Github issue [#442](https://github.com/akvo/akvo-rsr/issues/442) - -### RSR favicon - -We have replaced the favicon being used within RSR to use the more updated icon as is present within the Akvo.org website. - -Github issue [#443](https://github.com/akvo/akvo-rsr/issues/443) - -### Donation redirect page for Akvo Pages - -We have added a new timed redirection page that users will see when completing a donation from an Akvo Pages instance. This provides information to the user to inform them that they will be leaving the previous domain and be directed to the Akvo.org donation process. - -Github issue [#480](https://github.com/akvo/akvo-rsr/issues/480) - -### Translation management process - -We have documented our process for managing the content translations with a team of external language translators. This is just a documentation update. - -Github issue [#494](https://github.com/akvo/akvo-rsr/issues/494) - -### Documentation Update - -We have performed a merging process to pull some recent documentation efforts into the main code repository to ensure that the right information is always available for users to see. - -Github issue [#512](https://github.com/akvo/akvo-rsr/issues/512) - -### Project summary pop-up Akvo Pages map widget - -We have added a project summary pop-up to the Akvo Pages map widget that displays basic information about a project to the user when they click on the pin for a specific project. - -Github issue [#505](https://github.com/akvo/akvo-rsr/issues/505) - -### Project and organisation management flags - -Following on from recent work on management flags, we have extended this functionality to projects. Now it is possible to set a flag on both projects and organisations that will prevent unwanted changes being made. - -Organisations can have an owner flag set so that any changes made by other organisations inform the user that these changes could be overwritten by the managing organisation. - -Partners can also set a flag on their organisation record to prevent their projects being modified by other organisations. Only Admins from the support partner organisation will be able to make changes to the project content for these projects. - -Github issue [#233](https://github.com/akvo/akvo-rsr/issues/233) - - -Bug Fixes ---- - -### Blank location error - -We were experiencing a problem where if new locations were added to a project but no information was completed, the admin form would not save. This has been corrected to now ignore any added but incomplete locations. - -Github issue [#312](https://github.com/akvo/akvo-rsr/issues/312) - -### Budget totals - -We previously had 2 different budget items within the dataset that referred to total budgets. This has now been consolidated so that we only have a single entry and all information will be merged to this single entry. - -Github issue [#471](https://github.com/akvo/akvo-rsr/issues/471) - -### Akvo Pages widgets layout error - -We have tidied up some layout issues with the widgets being provided for Akvo Pages. - -Github issue [#498](https://github.com/akvo/akvo-rsr/issues/498) - -### Wrapped links on project pages - -We have fixed an issue that long links provided on projects were extending beyond the box provided in the visual layout. These links will now wrap to the next line if they are too long to fit within the available space. - -Github issue [#506](https://github.com/akvo/akvo-rsr/issues/506) - -### Global maps in Internet Explorer 8 - -We have resolved some visualisation issues when viewing the global maps in IE8. Now the maps are correctly displaying the points. - -Github issue [#507](https://github.com/akvo/akvo-rsr/issues/507) - -### IATI export missing data - -We were missing some date information within the budget item export when creating IATI files. This prevented the files from validating as a correct IATI XML file. This has now been included. - -Github issue [#533](https://github.com/akvo/akvo-rsr/issues/533) - -### Live server logging - -We have made a small change to the underlying code that will provide better logging information for our system to help discover and troubleshoot any issues that occur. - -Github issue [#432](https://github.com/akvo/akvo-rsr/issues/432) - -### Using Sentry within RSR - -We have added Sentry as a tool to assist us with monitoring and logging with RSR as part of our efforts to ensure we have a great performing system and access to all the right information to investigate when things don't go entirely to plan. You can read more about Sentry [here](http://sentry.readthedocs.org/en/latest/). - -Github issue [#541](https://github.com/akvo/akvo-rsr/issues/541) - - -Akvo RSR ver 2.3.5 Uglyfruit ---- - -Wednesday 9th April 2014, adriancollier - -New Features ---- - -### IATI Export - -On popular demand we have created the first installment of the IATI Export functionality. This feature will allow us to create an IATI XML file based on the projects that an organisation has within RSR to publish within the IATI Registry. - -There will be further improvements to this functionality including visibility of files within the website, automatic publishing and historical file access over the coming weeks. - -Github issue [#334](https://github.com/akvo/akvo-rsr/issues/334) - -### Donate Buttons on Projects and Widgets - -We have had a couple of requests from partners to prevent the donate button from appearing on their projects. Primarily this is due to the organisation not wishing to accomodate donations on specific projects. We have now added the functionality for partners to be able to turn on/off the visibility of the Donate button from the Project Admin per project. - -This setting affects where the project is visible on Akvo.org, Akvo Pages and within Widgets. - -Github issue [#310](https://github.com/akvo/akvo-rsr/issues/310) & [#491](https://github.com/akvo/akvo-rsr/issues/491) - - -### Image Upload Recommendations - -We noticed that many users were unaware of the right size or dimentions of images to use when uploading to RSR projects or updates. To help guide users to have the best quality of images on their projects we have added some recommendations including the limits related to file sizes that the system imposes. - -Github issue [#219](https://github.com/akvo/akvo-rsr/issues/219) - -### Update warning on empty content - -If a user wants to post an update without any content and only a title, then we think they should be allowed to do this. However we also think it's great if users do add content and not just the title. So we have added a reminder to the form to advise users to include content in case this is a mistake. Just like if you send an email without a subject. - -Github issue [#304](https://github.com/akvo/akvo-rsr/issues/304) - -### Registrations via Akvo Pages (aka Partnersites) - -When users want to register directly from Akvo Pages they used to have to select the organisation that they want to register under. To improve integration we have now pre-selected this, so that users now automatically are registering under the organisation that owns the Akvo Pages. - -Github issue [#309](https://github.com/akvo/akvo-rsr/issues/309) - -### Organisation input guidelines - -We've made some small improvements in the documentation available for organisations wishing to import organisations using the API. - -Github issue [#425](https://github.com/akvo/akvo-rsr/issues/425) - -### Improved 404 page - -We'd prefer it if no-one sees a 404 error page, but when they do, we want it to be a nice 404 error page, so we've now added the same one we use on Akvo.org as we like it. - -Github issue [#450](https://github.com/akvo/akvo-rsr/issues/450) - -### Partner Types - -We made a change a while back to only allow partners to be added to projects where they are enabled for that particular role, e.g. Support Partner. This has created some processing issues affecting Admin users and causing a bit of a long process for maintaining projects. As a workaround for this, we have now enabled all organisations to be either Field or Funding partners on projects. As before if organisations need to be added as a Support or Sponsor partner then this will need to be approved by the Akvo Partner Team, but this small change should help a lot of project admins have a simpler time with their work. - -Github issue [#462](https://github.com/akvo/akvo-rsr/issues/462) - -### Improved API resource for Project Updates - -As we would like to display more information about project updates in different places, and as this information is stored in multiple different tables within the database, we have created a common single resource to be able to collect all this information with a single API call. - -Github issue [#463](https://github.com/akvo/akvo-rsr/issues/463) - -### Widget Improvements - -We have made several visual improvements on the Widget templates in this release based on some partner feedback from CommonSites to make them clearer and look that little bit more impressive. - -Github issue [#479](https://github.com/akvo/akvo-rsr/issues/479) - -### Better documentation on Github Process - -We've improved the developer documentation for our Github process internally to make things clearer for everyone in the team. - -Github issue [#422](https://github.com/akvo/akvo-rsr/issues/422) & [#481](https://github.com/akvo/akvo-rsr/issues/481) - -Bug Fixes ---- - -### Error in maps for Internet Explorer 8 (IE8) - -There was an issue with displaying maps in IE8 within RSR. While IE8 is being discontinued by Microsoft soon, we still notice some traffic to RSR via this browser so we have made an update to the maps code to render these maps correctly when viewed there. - -Github issue [#474](https://github.com/akvo/akvo-rsr/issues/474) - -### Links wrapping on Akvo Pages (aka Partnersites) - -Links that are added to projects to connect information from Akvopedia or other external sources were not wrapping within the field correctly. This has now been resolved. - -Github issue [#179](https://github.com/akvo/akvo-rsr/issues/179) - -### Akvo Pages (aka Partnersites) organisation Lists not paginated - -All organisations that were participating in projects in the Akvo Pages were being listed in a single page, we have now corrected this to ensure that the organisations are listed in pages containing 10 at a time. - -Github issue [#285](https://github.com/akvo/akvo-rsr/issues/285) - -### Sign In fields alignment - -Sign In fields were being displayed as too large for the box they were sitting in. We have fixed this visual bug. - -Github issue [#322](https://github.com/akvo/akvo-rsr/issues/322) - -### Donation email in Gmail - -There was a styling issue in Gmail when viewing the donation email we send to users who have completed a donation in RSR. This template now uses a table rather than floating div elements so the visuals always match what is expected of them. - -Github issue [#460](https://github.com/akvo/akvo-rsr/issues/460) - - -### External links tab use - -When opening multiple external links from a project page, the same tab or window was being used again, so only the most recent link was being displayed to you. We've resolved this to create a new tab or window for each link selected. - -Github issue [#323](https://github.com/akvo/akvo-rsr/issues/323) - -### Header Sign In & Register options in browser - -When a browser was not maximised, the Sign In and Register options were no longer visible in the header, and the scrollbar didn't allow for them to be pulled into view. This has been resolved. - -Github issue [#408](https://github.com/akvo/akvo-rsr/issues/408) - - - -Akvo RSR ver 2.3.4 Tamarine ---- - -10th March 2014, adriancollier - -New Features ---- - -###Timestamp Audit Records - -The first of a series of changes we'll be making to improve the audit tracking of RSR data. This change provides a ``created_at`` and a ``last_modified_at`` field on Projects, Organisations and ProjectUpdates as well as on PartnerSites that are used to administer Akvo Pages. The fields are currently only visible within the Admin interface; but will be useful when viewing projects in the admin or when generating our reporting information and metrics. - -Github issue [#381](https://github.com/akvo/akvo-rsr/issues/381) - -###Data Management Flag - -Another change related to audit tracking and ownership, this new feature allows Organisation records to be tagged with an owner organisation. - -This flag will generate a warning if a user belonging to an organisation that is not the owner changes data through the admin interface. Such changes risk being overwritten, now that we are working with some partners who are sending us content updates via an import file. In the future, this flag will also let the import process reject any improper changes. - -Github issue [#374](https://github.com/akvo/akvo-rsr/issues/374) - -###Organisation API Import - -Further improvements to our API Import allowing more fields to be updated when we do the import from an external file. This will ensure all of the latest information is displayed exactly the way they should be. - -Github issue [#451](https://github.com/akvo/akvo-rsr/issues/451) - -###Android App Update Identifier - -We have implemented some changes to the identification of updates provided by the new Android app. This will ensure that the app cannot post the same update more than once. This change is in preparation of our Mobile App launch later in March. - -Github issue [#445](https://github.com/akvo/akvo-rsr/issues/445) - -###Registration Usernames - -Usernames in RSR have never been able to include spaces, but there are also some unwanted characters that were not allowed. To make the registration process easier we have added some code to the validation of the username that not only prevents users from entering restricted characters but also provides a clear error message in the event that an invalid character is included within the username entered. - -Github issue [#437](https://github.com/akvo/akvo-rsr/issues/437) - -###Email Delivery Improvement - -After some reports of RSR Emails not being received, we have made some changes to the system to improve the way we handle emails. We now route the emails being delivered from RSR through the Mail Server we have running mail.akvo.org. The logging of this is delivered to us regularly so we can always track what happened to emails that are not delivered to see where the problems may lie. - -This change will also work to improve the overall stability of the mails being sent from RSR. - -This also required a change in RSR to enable the sending of mails using a service with SSL. - -Github issue [#448](https://github.com/akvo/akvo-rsr/issues/448) - - -Bug Fixes ---- - -###Clickable Links in updates - -We had an issue that was preventing some links that were included within RSR updates from being clickable within the browser. This was affecting some Akvo Pages updates as well as times when the links were not preceded by line breaks. - -The new change now scans an update after it has been submitted in order to make any links that may have not been picked up automatically clickable. This will help to ensure that users who are sharing information have great updates. - -Github issue [#438](https://github.com/akvo/akvo-rsr/issues/438) & [#419](https://github.com/akvo/akvo-rsr/issues/419) - -###Add project view in Admin bug - -During the implementation of the new Timestamp feature, we had an issue with the template for adding a new project into RSR. This required some tidying up of the fields and moving the Timestamp fields into the General field list rather than in its own section. - -Github issue [#458](https://github.com/akvo/akvo-rsr/issues/458) - - -Akvo RSR ver 2.3.3 Satsuma ---- - -21st January 2014, adriancollier - -New Features ---- - -###Organisation API Import - -We have been working with our Partners Cordaid and RAIN Foundation to build and expand on our API Write Functionality. The process of importing organisations on a large scale was previously being done via the use of local scripts. With scale however we needed a more structural solution not only to enter this data, but also to update it and allow changes to be made. - -To complete this task we have also introduced a new API tool called the Django REST Framework. This is an alternative to our existing API tool TastyPie. We believe this new tool is a more stable and long term solution to the API functionality. With this addition, we will be able to track the performances of both tools before deciding on the final solution that RSR will be taking for its application interface technology. - -Github issue [#415](https://github.com/akvo/akvo-rsr/issues/415) & [#375](https://github.com/akvo/akvo-rsr/issues/375) - -###Budgets Importing - -In a similar strain to the Organisation API Import, we have also been extending the existing Project functionality, and have enabled the feature to be able to import budget information via the API. - -Github issue [#390](https://github.com/akvo/akvo-rsr/issues/390) - -###Target Group Field - -Through conversations internally, with partners and also within the IATI community, we have made a decision to more closely align the RSR data set to the IATI standard to make publishing and comparison of these sets easier and more open. - -The latest of these changes is the inclusion of the Target Group field in the RSR Project model. At the moment this is only a backend change, so while data can be entered through the RSR Admin portal or via the API, it will not yet be visualised on the Akvo Website, Akvo Pages or Akvo Sites. This visual addition will be coming soon. - -Github issue [#311](https://github.com/akvo/akvo-rsr/issues/311) - -Bug Fixes ---- - -###Email Tracking - -We have been hearing of several incidents where activation, password or confirmation emails are not being received by users in RSR. In order to fully investigate this issue, we have enabled some detailed logging and tracking in the system to be able to inform us about emails that are sent out so we can pinpoint where the problems lies. - -Github issue [#416](https://github.com/akvo/akvo-rsr/issues/416) - -###Remove Facebook App ID From Admin - -Since we have released the Facebook sharing buttons in RSR, we have done some further investigation and determined a better way of solving this problem that no longer requires users to create their own Facebook Apps. To ensure users do not get confused we have removed the App ID field from the Admin. - -Github issue [#423](https://github.com/akvo/akvo-rsr/issues/423) - -###RSR Footer Update - -We corrected a grammar mistake in the Product roadmaps link in the footer. - -Github issue [#411](https://github.com/akvo/akvo-rsr/issues/411) - - -Akvo RSR ver 2.3.2 Rambutan ---- - -10th December 2013, adriancollier - -New Features ---- - -###Social Media Sharing Buttons - -Following on from the Meta-Data changes that we provided in the last release of RSR, we have now worked on adding in Social Media Sharing buttons for your Project, Update and Organisation pages within your Partnersite. - -We have created this functionality for Facebook and Twitter. Both of these can be turned on/off independently within the [Partnersite Admin](http://rsr.akvo.org/admin/rsr/partnersite) form. - -For Facebook there is an additional setup needed. You will need to [Create a Facebook App](http://tri.be/how-to-create-a-facebook-app-id/) and enter the App ID into the [Partnersite Admin](http://rsr.akvo.org/admin/rsr/partnersite) form. The Domain of the Facebook App should match the primary domain being used for your Partnersite, e.g. http://projects.organisation.org OR http://organisation.akvoapp.org. - -Github issue [#230](https://github.com/akvo/akvo-rsr/issues/230) - -###Github Wiki and RSR Documentation - -We have been working on improving the documentation for both internal developers, users as well as external partners, integrating organisations and the Open Source development Community. As you can imagine this is a big undertaking to ensure that everone has all the necessary information available in the right format to be suitable for its intended use. - -This is of course a work in progress and we will continue to improve this, but you can already see the summary page with an overview of what we have and where to find it [here](https://github.com/akvo/akvo-rsr/wiki) - -###Footer Changes - -We have made several changes to the Footer for RSR to match the changes that are being made within the main Akvo website. - -Github issue [#398](https://github.com/akvo/akvo-rsr/issues/398) -Github issue [#342](https://github.com/akvo/akvo-rsr/issues/342) -Github issue [#350](https://github.com/akvo/akvo-rsr/issues/350) - -###Reinstate Global Maps in RSR - -Earlier this summer we removed the functionality surrounding global maps on the platform. This was due to some performance and stability issues we were having with this portion of the site. We have now resolved these issues by implementing a Caching layer using Memcache on the API calls, as well as tidying up the API code to streamline the data being transmitted for the query involved. - -These changes have provided a big enough improvement in the performance of the system that we have been able now to turn the maps back on in RSR so you can now see all your projects or organisations in one place - as you should be able to. - -Github issue [#331](https://github.com/akvo/akvo-rsr/issues/331) - - -Bug Fixes ---- - -###Thumbnails on Partnersite Maps - -We had a reoccurrence of a previous bug in this release - maps on Partnersites were displaying a very large thumbnail in the pop-up window after clicking on a single point on the map. This meant that only a small portion of the image was visible and the thumbnail took a long time to load. - -We have resolved this by using a smaller thumbnail when pulling images into the maps. - -Github issue [#159](https://github.com/akvo/akvo-rsr/issues/159) - -###Release Notes Fixes - -The last release was pushed out with a couple of spelling mistakes in the Release Notes, these have now been corrected. - -Github issue [#372](https://github.com/akvo/akvo-rsr/issues/372) - -###Social Media Images - -When sharing Projects and other RSR Pages in Social Media sites images are passed through to be displayed. We had an issue that the images being used were not the correct format and so an inaccurate thumbnail was being displayed. This has been rectified to ensure that the right image sizes and shapes are provided to display as expected. - -Github issue [#367](https://github.com/akvo/akvo-rsr/issues/367) - -###Supervisor Log Warning - -One of the Resources in the Benchmark Models was causing some errors and so this has been fixed to prevent any further issues. - -Github issue [#364](https://github.com/akvo/akvo-rsr/issues/364) - - - -Akvo RSR ver 2.3.1 Quince ---- - -31st October 2013, adriancollier - -New Features ---- - -###Social Media Sharing Optimisation - -When you share something using modern Social Media sites, the site you are sharing to (for example Facebook) automatically collects information from the source system to display an image, description and other Meta Information. - -We have improved the Meta Data in RSR to ensure that when you share a page from RSR, the appropriate information is supplied to the Social Media site and the share looks great. - -Github issue [#196](https://github.com/akvo/akvo-rsr/issues/196) - -###Partnersite Widget CNAME - -We have recently released a new set of Partnersite Widgets, however these have now been additionally configured to use the CNAME belonging to the Partnersite itself. This means that if the Widget is collected from a CNAME domain, then they will direct Widget visitors to the same CNAME domain when clicked. - -Github issue: [#315](https://github.com/akvo/akvo-rsr/issues/315) - -Bug Fixes ---- - -###Partnersite Widget Visual Fixes - -There were a few inconsistencies with the visual elements of the new Partnersite Widgets. These included text running off the end of the widget, and the scrollbar on the Project Listing Widget. These have been resolved so now we should have pretty, error-free widgets. - -Github issue: [#316](https://github.com/akvo/akvo-rsr/issues/316) - -###Duplicates in API - -The API was occasionally returning duplicate values in the results due to circular references between tables in the originating request. To ensure this doesn't continue to happen, we have adde da Distinct Clause to the API that will clean any duplicates before returning the results to the user. - -Github issue: [#206](https://github.com/akvo/akvo-rsr/issues/206) - -###Problems Saving Project in Admin - -There was an issue where the project saving in the RSR Admin was taking some time. There was no indication as to whether this was working or not, and so if the save button was used several times, then it could result in dupliciate infomration being stored on a individual project. - -To keep the project information unique where it needs to be, we have set it now that while the project is saving the Save Button is greyed out so it cannot be pressed multiple times. - -Github issue: [#313](https://github.com/akvo/akvo-rsr/issues/313) - -###RSR and Partnersite Sing In Page Link - -We found a broken link on the sign in page that was directing users to the former Drupal content. We have corrected this to point the user to the correct page on the new Akvo.org website. - -Github issue: [#342](https://github.com/akvo/akvo-rsr/issues/342) - -###Footer Link Error - -There was a link on the Footer of RSR that directed users to a non-existant page. This has been corrected so users are pointed to the correct page on the new Akvo.org website. - -Github issue: [#350](https://github.com/akvo/akvo-rsr/issues/350) - -###Field Limit Config Setting - -Last year we implemented a change to impose the correct character limits on RSR Project fields. We made a decision not to force these limits historically, and so we added a config setting to allow projects with an ID below 478 to be exempt from these new limits. - -This config setting was lost during the migration and infrastructure work we have been doing, so in this issue we have replaced this so that older projects can continue to be edited and used as normal. - -Github issue: [#360](https://github.com/akvo/akvo-rsr/issues/360) - -Infrastructure Changes ---- - -####Reduce Downtime during Deployments - -By changing the way and order that we process all the necessary tasks during system deployment, we have been able to dramatically reduce the downtime of Akvo RSR. With releases going forwards we should always be looking at a downtime of less than 10 minutes. - -Github issue [#132](https://github.com/akvo/akvo-rsr/issues/132) - -###Migrations for Apps During Deployment - -We have made some changes to our deployment scripts so that any migrations on apps used are included in the steps, making this process a lot more complete. - -Github issue [#89](https://github.com/akvo/akvo-rsr/issues/89) - -###Upgrade TastyPie - -A newer version of TastyPie has been released. We use TastyPie for the RSR API. To ensure we can utilise the latest features of this, we have upgraded our version to the latest in this release. - -Github issue: [#157](https://github.com/akvo/akvo-rsr/issues/157) - - -Akvo RSR ver 2.3.0.1 - Passionfruit Part 2 - Hotfix ---- -21st October 2013, carlio - -Bug Fixes ---- - -The "All Projects" RSS feed now returns only the most recent 100 project updates to speed up the feed generation and prevent out-of-memory problems. - -GitHub Issue [#318](https://github.com/akvo/akvo-rsr/issues/318) and [#329](https://github.com/akvo/akvo-rsr/issues/329) - -Akvo RSR ver 2.3.0 Passionfruit ---- - -8th October 2013, adriancollier - -New Features ---- - -###Searching in the Admin on Internal ID - -We have begun to implement a foreign identification number on projects that allow an Organisation to identify their projects using the ID that exists in their own internal systems. This is an extremely useful feature as it ensures that Partners can communciate in their own terms. - -Until now however it was only possible to search in the Admin for RSR Ids. We have coded the change so that in the RSR Admin you can search on these Internal IDs and find the RSR Project that responds to that ID. - -Github issue [#254](https://github.com/akvo/akvo-rsr/issues/254) - -###Notes and Comments in the Admin - -We have added some additional notes fields to a lot of the different areas of the admin. These fields will not be visible anywhere on the site, and the content will only be available to those working on the project with access ot the Admin. So, these fields can be used to explain additional informaiton for users of the project, or to write notes about recent changes or anything in particular that someone maintaining the content of a project might need to know. - -Github issue [#151](https://github.com/akvo/akvo-rsr/issues/151) - - -Infrastructure Changes: ---- - -###Upgrade to Ubuntu 12.04, Nginx and move to CloudVPS - -In this release our live server is being moved from its current home in London with the fantastic guys at ProWeb to a new Cloud based machine at CloudVPS. Within this movement we are also updating the underlying Operating System on RSR from 8.04 to 12.04. This has a whole series of additional benefits as well as challenges, but its certainly a move in the right direction. In addition we are also changing our Web-Server from Apache to Nginx at the same time. Nginx provides a more responsive web application with a simpler configuration and a smaller footprint. - -We are aligning the environments that all our machines sit within, to improve the fidelity between our systems, as well as reducing the overhead of maintaining and administering these machines. - -We expect these changes to enable some much bigger changes in the area of performance and stability to ensure our systems are working at the top of their game. - -More to come in this area for sure! - -###Moving Virtual Environments to CloudVPS - -When we decided to choose a new hosting provider, this didn't just affect the live server, as we also have a number of additional development environments that we also need to move to ensure these work in a similar structure as the live system. Otherwise our testing has a lot less value. - -We have moved these machines to our provider CloudVPS and have setup the additional surrounding structure so that they are already tightly integrated into our devleopment process. - -Github issue [#130](https://github.com/akvo/akvo-rsr/issues/130) - - -Bug Fixes ---- - -###Register Link on Partnersites - -We uncovered a sneaky bug that caused the Register link on Partnersites to only direct people into a loop and not actually deliver users to the correct location. We've fixed this so now users can register as normal. - -Github issue [#307](https://github.com/akvo/akvo-rsr/issues/307) - -###Update Title Character Limit - -The Title field on Project Updates has a limit of 50 characters. However we were experiencing a problem with this that when you started typing into the field the display gave you a limit of 255. This was only a visual issue and luckily the form validation did not let the Update be submitted if over 50, but of course this is a very confusing situation. - -We have resolved this now, so the display correctly informs you how many characters you have left out of the actual 50 character limit. - -Github issue [#302](https://github.com/akvo/akvo-rsr/issues/302) - - -Akvo RSR ver 2.2.0.3 - Okra Part 3 - Hotfix ---- - -5th September 2013, adriancollier - -New Features ---- - -###Expansion of Write API Functionality - -We have been working on improving the process of importing IATI XML Files into the RSR Write API. These are a combination of general fixes and resolutions to Cordaid specific issues. - -Github issue [#266](https://github.com/akvo/akvo-rsr/issues/266) -Github issue [#277](https://github.com/akvo/akvo-rsr/issues/277) -Github issue [#237](https://github.com/akvo/akvo-rsr/issues/237) -Github issue [#297](https://github.com/akvo/akvo-rsr/issues/297) - -Bug Fixes ---- - -###Header to show Signed In Status - -Following on from the release of our new Akvo.org website, we needed to modify the header being used so that users can be shown within the header if they are logged into RSR or not. - -Github issue [#300](https://github.com/akvo/akvo-rsr/issues/300) - -###Previous Navigation Button Broken - -The Previous Button in RSR Lists for Organisations or Projects was not working due to some spaces instead of Tabs in the template code. We've corrected this now so users can navigate freely forwards and backwards to their heart's content. - -###CSS Regression - -We had a bug that managed to creep back into the system affecting the layout on the User Registration page on Partnersites. This has been fixed - and hopefully for the final time. - -Github issue [#205](https://github.com/akvo/akvo-rsr/issues/205) - - -Akvo RSR ver 2.2.0.2 - Okra Part 2 - Hotfix ---- - -2nd September 2013, adriancollier - -New Features ---- - -###New Headers and Footers for RSR - -We have implemented new Headers and Footers throughout RSR to coincide with the new Akvo.org Website launch. These now contain the look and feel of the new website whilst providing all the functionality necessary to navigate throughout RSR and the Akvo network pages. - -Github issue [#288](https://github.com/akvo/akvo-rsr/issues/288) - -###Automated Development Environment Setup - -To improve the ease of setting up a local instance of RSR for development, we have worked on a set of scripts and resources using Puppet and Vagrant. - -###Cordaid API Update Functionality - -We have developed an improvement to the API that allows us to update existing projects using the API Write functionality we have previously implemented. It was only possible before to create new projects. - -Github issue [#224](https://github.com/akvo/akvo-rsr/issues/224) - - -Bug Fixes ---- - -###Partnersite Routing - -We had an issue within our Middleware that resulted in an incorrect domain being set for Partnersites that were using CNAME entries to embed these into their Organisation's websites. -This has now been resolved, fixing issues related to Widgets not containing pins, as well as incorrect links throughout Partnersites. - -Github issue [#291](https://github.com/akvo/akvo-rsr/issues/291) - - -###Mistakes in Unpublished Project Notification - -We implemented a Banner to be displayed to users that are viewing an unpublished project. This banner contained some errors which have now been resolved. - -Github issue [#257](https://github.com/akvo/akvo-rsr/issues/257) - -Akvo RSR ver 2.2.0.1 - Okra ---- -29th August 2013, adriancollier - -New Features ---- - -###RSR Moved to Subdomain - -In light of moving to a new website and structure, we have decided modify the underlying source of the RSR codebase. All RSR pages used to be displayed at http://akvo.org/rsr/ where we have now changed this to http://rsr.akvo.org. This allows us to separate out our products more easily and include more in-line information from Akvo's other products including FLOW and Akvopedia in a standard way going forwards. All the existing links and permalinks will continue to work, with the user being redirected to the new page automatically. - -Github issue [#139](https://github.com/akvo/akvo-rsr/issues/139) - -###Added Piwik Tracking Code - -We have implemented an Analytics Traffic counting system Piwik throughout Akvo. We added the tracking information to RSR to allow traffic to be counted from within this new system to replace our previous solution HitList. - -Github issue [#268](https://github.com/akvo/akvo-rsr/issues/268) - -###Temporary Replacement Homepage - -We are intending shortly to implement a new Akvo.org website. In addition we are also planning to move RSR to a new hosting provider and separate out the different parts of the current Live Server to create a more service based architechture. In order to do this, we needed to replace the current homepage which was being delivered by Django in a piece of functionality we called the MiniCMS. -We have built a temporary Hoempage solution using Wordpress that gives us the flexibility to carry on with this work unhindered. - -Bug Fixes ---- - -###Remove Labs Footer Link - -There was a link to an Akvo Labs page within the footer where the page is no longer in use, so the Footer link has been removed. - -Github issue [#280](https://github.com/akvo/akvo-rsr/issues/280) - - -###Interactive Global Maps Disabled - -We were experiencing problems with our API calls that resulted in excessive memory being used on our servers when these pages were displayed to users. While we work on the cause of the problem, we have disabled the maps and placed static maps in their stead to retain the visual elements, even though we are aware of the reduction in functionality. - -Github issue [#279](https://github.com/akvo/akvo-rsr/issues/279) - -###ISO Country Name - -Palestein was listed as an Occupied Territory in RSR based on an older version of the ISO3166 list. We have now corrected this to State of. - -Github issue [#215](https://github.com/akvo/akvo-rsr/issues/215) - -###Water and Sanitation Text in RSR Admin - -The headline text in the RSR Admin when creating a project mentioned Water and Sanitation projects. This is legacy from when RSR was only involved with these types of projects. We have now replaced this with a more general headline text. - -Github issue [#216](https://github.com/akvo/akvo-rsr/issues/216) - -###Add Update to Submit Update - -On the Project Update Form within RSR, the button below the Update Form had the same Text "Add Update" as the button on the right side of the page to enter the form, leading to confusion. We have now changed the lower button to read "Submit Update" to make the difference between these more clear. - -Github issue [#251](https://github.com/akvo/akvo-rsr/issues/251) - - -Akvo RSR ver 2.1.5.2 - hotfix for Nectarine ---- -8th August 2013, adriancollier - -###Adding a Country via the RSR Admin - -We inherited a bug which prevented Countries from te ISO list being added to the available country list in the RSR Admin. - -Github issue [#256](https://github.com/akvo/akvo-rsr/issues/256) - -###Registration page in Partnersites - -We made some fixes to the Regsiitartion page included modifying the layout to match the style better, and fixing some issues with the links that were not working once ported from Core RSR. - -Github issue [#260](https://github.com/akvo/akvo-rsr/issues/260) - -Akvo RSR ver 2.1.5.1 - hotfix for Nectarine ---- -24 July 2013, adriancollier - -###Add Organsiation Loading Info - -We needed a little more code to process the Organisation Import File from Cordaid. - -Github issue [#250](https://github.com/akvo/akvo-rsr/issues/250) - -Akvo RSR ver 2.1.5 Nectarine ---- -8th July 2013 - adriancollier - -New Features ---- - -###Partnersite Widgets - -We build a set of Widgets some time ago to enable our Partners to visualise information from one or more of their projects on any website via the use of an iframe. These Widgets provide a link directly to the project page on Akvo.org. - -We have now built a new set of widgets that are redirecting users to the Project page on the Partnersite of the Organisation that collected the Widget. - -This allows Partners to direct users to the right places they want, and makes the user experience more streamline remaining in the Partners domain or website look and feel. - -Github Issue: [#154](http://github.com/akvo/akvo-rsr/issues/154) - -###Restyled Widgets - -As well as creating a set of Partnersite widgets, we also set our Designer to work on the visuals for these. The result is a new set of Widgets with a fresh and clean look. They're available in Light and Dark styles, so you should be able to locate the widget that looks exactly right on the site you want to place it on. - -Github Issue: [#181](http://github.com/akvo/akvo-rsr/issues/181) -Github Issue: [#188](http://github.com/akvo/akvo-rsr/issues/188) -Github Issue: [#182](http://github.com/akvo/akvo-rsr/issues/182) -Github Issue: [#185](http://github.com/akvo/akvo-rsr/issues/185) -Github Issue: [#186](http://github.com/akvo/akvo-rsr/issues/186) - -###New Get a Widget Page - -And in case you thought we hadn't done enough with Widgets in this release, we have created a new Get a Widget page for Partnersites that display the available widgets and allow you to customise and collect the code for your Widget of choice. - -Github Issue: [#193](http://github.com/akvo/akvo-rsr/issues/193) - -###Comments field in Partnersite Admin - -To allow us to maintain a better grasp on which Partnersites we have active, who is responsible for these and what Demo Partnersites we have implemented, we have added a notes field to this record so that we can provide some additional information which running our Admin. - -Github Issue: [#207](http://github.com/akvo/akvo-rsr/issues/207) - -###Partner Type Selection - -We found recently within RSR that some of our Partners were being assigned to roles that the Partner was not authorised to be able to undertake. To solve this problem we have implemented a choice selection within our backend Admin, that allow us to pre-select the different roles that a Partner is able to fulfill on Projects in RSR. - -Github Issue: [#203](http://github.com/akvo/akvo-rsr/issues/203) - -Russian Translation - -Working with one of our Partners UNDP, we have developed a set of User Interface translations that allow RSR Partnersites to be viewed locally in Russian. This now makes 6 languages we support in the User Interface of RSR: - -- English -- Dutch -- French -- German -- Spanish -- Russian - -Github Issue: [#138](http://github.com/akvo/akvo-rsr/issues/138) - -###Subdomain RSR - -In preparation for our move to a new hosting provider, we are making some changes to the underlying structure of RSR. In this release we are moving the RSR core code from the location of http://akvo.org/rsr to http://rsr.akvo.org. - -This allows us to physically separate the various components of RSR and find stable and efficient hosting solutions for each part. All on the way to a smooth and flexible development process. - -Github Issue: [#139](http://github.com/akvo/akvo-rsr/issues/139) - -###Homepage API Resource - -Also related to our move of hosting providers, this new addition to the API has been added to populate the "Right now in Akvo" box on the Homepage. This resource can be customised as time goes on to be able to generate more Analytics/KPI type information to be displayed within our Public Website pages. - -Github Issue: [#180](http://github.com/akvo/akvo-rsr/issues/180) - -###Remove old API - -We have been working for some time on a working Read and Write API for RSR. We are pleased that we are now at the point when we have this in place. We are still making improvements and customisations but in the meantime we have decided it's time for us to remove the previous API we had in place to ensure that all Partners using this are using the correct feature and can access all of the right information. - -The correct API Documentation can be found on our [Github Wiki here](https://github.com/akvo/akvo-rsr/wiki/Akvo-RSR-API-developer-documentation). - -Github Issue: [#61](http://github.com/akvo/akvo-rsr/issues/61) - -###Update API to allow new version of Tastypie - -When trying to perform an upgrade of Tastypie which runs our new RSR API eature, we experienced an error as the models within RSR were not compatible with the latest Tastypie features. - -To resolve this we have fixed the dependencies so that we can upgrade Tastypie and make the most out of this technology. - -Github Issue: [#165](http://github.com/akvo/akvo-rsr/issues/165) - -###Registration Links on Partnersites - -If you go to add an update to a project on Akvo.org then you get a screen asking you to login and if you don't have an account there is an easy link to register for a new account right there on the page. - -However if you try to do the same thing from a Partnersite, there is no registration link available. In this release we have resolved this and now the Login page has the same Registration information displayed. - -Github Issue: [#205](http://github.com/akvo/akvo-rsr/issues/205) - -###Photo Credit on Project Image - -When adding a photo to a project via an Update, you can enter both a Caption and Credit for the photo, allowing you to describe the image and ensure that the photographer is credited for their work. - -Now you can do the same when adding a photo to a project. Both the Caption and Credit fields are available to complete to ensure your images have the most up to date and accurate information you know at the time. - -Github Issue: [#212](http://github.com/akvo/akvo-rsr/issues/212) - -Bug Fixes ---- - -###Fix to Global Maps - -There were 2 visual issues affecting the Global Maps page. As more pins are collected from the API, the position of the map on the screen and the zoom level was resetting. This has been fixed now to provide a steady map view. - -Github Issue: [#113](http://github.com/akvo/akvo-rsr/issues/113) - -###Fix Partners Column in Widget -In the standard RSR Widget, the Project List Widget had a column called Partners that was not being populated. This has been resolved so that this again shows the list of current partners working on the project being displayed on the Widget. - -Github Issue: [#15](http://github.com/akvo/akvo-rsr/issues/15) - -###Test Bug - Cannot create new org in Admin - -When testing this release, we discovered an issue preventing Organisations from being created within the Admin. This was resolved before we pushed the release to live, so no such bug will be affecting our users after this release. - -Github Issue: [#244](http://github.com/akvo/akvo-rsr/issues/244) - - -Akvo RSR ver 2.1.4 - mangosteen ---- -25 June 2013, adriancollier, zzgvh - -New features & changes ----- - -###Akvo RSR Write API - -We have added functionality to our API to be able to import projects from an external source. This is hugely beneficial for our partnerships with larger partners such as Cordaid.org, who are currently working on implementing their entire project portfolio (500+ projects) into RSR. - -The process involves sending an IATI Formatted XML File to RSR, which is then translated and imported into the system to create the projects based on the file's contents. - -We will continue to work on improving and strengthening this process, but the first projects are being added via the API for Cordaid's initial run. In this we're adding over 130 new projects to RSR. - -Github issue: [121](https://github.com/akvo/akvo-rsr/issues/121) - -###Internal Organisation ID - -We needed a way for Organisations to label other organisations and identify them on an ongoing basis. We have implemented this field which allows a partner to reference all of their working partners and provide a unique code for this. In the long term we believe we will be replacing this field for the IATI Organisation Identifier, but until this is more commonly in use, we will be using a custom identifier selected by the submitting organisation. - -Github issue: [178](https://github.com/akvo/akvo-rsr/issues/178) - -###Migrate Organisation to use the IATI Code List - -We were previously using an Organisation type list of 4 types: - -- NGO -- Governmental -- Commercial -- Knowledge Institution - -We have now implemented an additional type field to use the [existing IATI List](http://iatistandard.org/codelists/organisation_type/). We will shortly be working on migration to update all existing Organisations we have to use the new field. - -Github issue: [149](https://github.com/akvo/akvo-rsr/issues/149) - -###API Caching - -We have reduced the Caching solution we are using for the API to Memcached only, as our previous solution had stability issues. We now have a simple cache for Maps provided by Tasypie, and will work on what additional changes need to be implemented. - -Github issue: [136](https://github.com/akvo/akvo-rsr/issues/136) - -Bug fixes ----- - -###Cordaid Data Importing - -We experienced an issue with the data import which was caused by a missing Business Unit in the implementation details. This was added and the problem resolved. - -Github issue: [197](https://github.com/akvo/akvo-rsr/issues/197) - -###IATI Organisation Identifier NULL Duplicates - -When we added the IATI Identifier to the Organisation records, we wanted to prevent duplicates from being created so we implemented validation on the field. The issue was that the validation included a NULL value so 2 Organisations both without any ID were showing as duplicates. As it is possible to have an Organisation without an identifier we have removed this validation constraint to ignore NULL values. - -Github issue: [208](https://github.com/akvo/akvo-rsr/issues/208) - - -Akvo RSR ver 2.1.3.1 - hotfix for leek ---- -11 March 2013, zzgvh - - -###Fix project update form in RSR - -The project update form was missing the newly added language field, rendering the form un-postable. This is now fixed. - -Github issue [162](https://github.com/akvo/akvo-rsr/issues/162) - -###Fix the middleware for partner sites using CNAME domains - -The partner site routing middleware generated an exception when accessing a site using a CNAME domain. This is now fixed. - -Github issue [164](https://github.com/akvo/akvo-rsr/issues/164) - -Akvo RSR ver 2.1.3 - leek ---- -4 February 2013, adriancollier - - -###Project Admin Rework - -We have made some changes to the ordering and display of the Project Form in the Admin. This is to make the order more logical so that entering a project is easier. - -We are working on an update to the manual project form which is currently in PDF format, which will also utilise the same ordering of fields to make the process even more seamless. - -Github issue: [145](https://github.com/akvo/akvo-rsr/issues/145) - -###API Caching - -We have implemented a Caching solution to our API to store results of requests to pull information for the Global Maps in RSR. This works by storing a copy of the data for the maps on the server and only renewing this information if the existing data is expired. This not only speeds up the request but also dramatically reduces the load on the server. - -For this we have used the Django library Cacheback. - -Github issue: [136](https://github.com/akvo/akvo-rsr/issues/136) - -###Multilingual Content Translations - -We have successfully implemented the Google Translate Widget into Akvo RSR for Partnersites. This functionality is by default turned off, but can easily be switched on within the RSR Admin. - -Once activated, the Widget appears in the top right hand corner of the page and allows users to select any of the 64 supported languages to translate the entire page and contents into. - -This is a machine translation, and is not fully verified, but it should provide enough information for viewers of the project to understand the intention of the project and it's overall aims and goals. - -It is also possible to submit better translations to Google via the translated page, increasing the accuracy of the translated content for future viewers. - -Github issue: [101](https://github.com/akvo/akvo-rsr/issues/101) - -###Closing the Donation Loop on Partnersites - -An improvement in both Partnersites and the Donation process that captures the Partnersite users were on when they began the process, and returns them there once they finished. Previously, a user of the site would always be returned to Akvo RSR regardless of which site they started their donation on. - -Github issue: [93](https://github.com/akvo/akvo-rsr/issues/93) - - -Akvo RSR ver 2.1.2.1 - Donations Hotfix release notes ---- -4 February 2013, adriancollier - -###Funding Projects to 100% with the Donation Engine - -We have made a change to the way payment amounts are being calculated when including fees. There has been an existing legacy issue for some time that due to the fees deducted from PayPal or iDeal, a project could not be fully funded using the donation engine alone. A manual payment was neeeded to be made in the Admin to complete the project funding. - -Now we have re-engineerd the fees so that these are added to the amount required to complete a project. The donor can make the payment and the actual fees charged are deducted from the payment before the remaindfer is applied to the chosen project. - -It may occur infrequently that the project is over-funded by a small fraction as the fees incurred could differ from the fees calculated. Where this occurs the funds are provided to the project budget. - - -Github issue: [120](https://github.com/akvo/akvo-rsr/issues/120) - -Akvo RSR ver 2.1.2 release notes ---- -10 December 2012, (Code name: Kiwi) kardan, adriancollier, zzgvh - -Overview ----- -... - -New features & changes ----- - -###End to End Transparency with Openaid.nl and Akvo RSR - -In this release we have made a firm link between the Financial Information published by the Dutch Government at Openaid.nl and Akvo RSR. Pending a change in the Openaid.nl source code which should be pushed later this week, you will now be able to navigate between Funding Activities in Openaid.nl and projects being implemented using those funds on Akvo RSR. - -So, links on the Openaid.nl site will provide you with a list of RSR projects or a list of participating organisations. From the Funding Pages on Akvo RSR you'll be able to go directly to the original funding activity in OpenAid.nl. - -You can read more about this on our [Blog Post](http://www.akvo.org/blog/?p=7962) on this feature! - -Github issue: [69](https://github.com/akvo/akvo-rsr/issues/69) & [87](https://github.com/akvo/akvo-rsr/issues/87) - -###Donation Initial Page Restyle/Addition - -On the first page of the donation process (http://www.akvo.org/rsr/project/613/donate/) there is currently the option of donating by PayPal or iDeal. At the bottom of the page there is also the option to donate as an Organisation which follows a different process. - -This alternative process has been made more apparent to ensure organisations follow the correct path rather than to participate in the workflow that is aimed at individual donors. - -Github issue: [98](https://github.com/akvo/akvo-rsr/issues/98) - -###API Changes - -We have added the "primary_location" field as inline data to the "project" and "organisation" resources in the API. This allows for the primary location to be collected directly when obtaining the project and organisation resources. Being one of the more useful pieces of information that is not part of the project or organisation database tables it makes a lot of sense to make this information accessible as a part of these resources directly. - -In JSON the "primary_location" looks like this: - -```js - "primary_location": { - "address_1": "", - "address_2": "", - "city": "Freetown", - "country": "/api/v1/country/42/", - "id": 779, - "latitude": 8.371664, - "longitude": -13.189087, - "postcode": "", - "primary": true, - "project": "/api/v1/project/672/", - "resource_uri": "/api/v1/project_location/779/", - "state": "" - }, -``` - -Github issue: [124](https://github.com/akvo/akvo-rsr/issues/124) - -We have also expanded the "current_image" field of the "project" resource and the "logo" field of the "organisation" to include a sub-object with two fields, "original" which is the URI for the original image, and "thumbnails" which is an object with named thumbnails of the image. Currently there is only one thumbnail, "map_thumb" that is used by RSR itself for some of the maps. With this change it will be easy to add other thumbnail formats in the future. - -In JSON the new format for "current_image" (and "logo" in the organisation) is: - -```js - "current_image": { - "original": "http://uat.akvo.org/rsr/media/db/project/672/Project_672_current_image_2012-11-06_15.22.42.jpg", - "thumbnails": { - "map_thumb": "http://uat.akvo.org/rsr/media/db/project/672/Project_672_current_image_2012-11-06_15.22.42_jpg_160x120_autocrop_detail_q85.jpg" - } - }, -``` - -Github issue: [123](https://github.com/akvo/akvo-rsr/issues/123) - -###Sorting on country - -The ability to sort projects in a list based on which country they are located in was disabled some time back when we made changes to the location model. It has now been reinstated, so it'll be easier once more to find projects in the same country. We have also fixed the sorting direction to use logical defaults for all columns of the project listing pages. - -Github issue: [99](https://github.com/akvo/akvo-rsr/issues/99) - -###Map Images - -Previously we were pulling and displaying original project images on our maps. This looked fine in general, but it had a huge impact on performance as all the images needed to be downloaded when the map was displayed to the user...not the most efficient. - -Seeing as the images are small on the map pop-up anyway, we have modified the interface to use the thumbnail image rather than the original image. Reducing the loading time for users, and the impact on our server resources - for which we are grateful. - -Github issue: [65](https://github.com/akvo/akvo-rsr/issues/65) - -###Map Scrolling - -This improvement is a great addition. We have enabled Global map zooming in and out using the scrollwheel on your mouse. If you don't use the scrollwheel on your mouse, then you'll probably not notice anything. If you do use it - then I hope you get as excited about this as I did! - -Github issue: [43](https://github.com/akvo/akvo-rsr/issues/43) - -###Akvo RSR in German - -Working closely with one of our Partners Mars Chocolates, we have made significant progress in translating the Akvo RSR User Interface into German. We have checked this well, but we are still ironing out all of the kinks and making sure it all makes sense. If you spot any inaccurately translated items, please let us know. Online translation tools don't let you see things in context, so it's a lot of guesswork until it's seen in action. - -Github issue: [116](https://github.com/akvo/akvo-rsr/issues/116) - -###Automated Donation Testing Scripts - -We have written some powerful Lettuce scripts allow us to run through the Donation Process automatically in under 2 minutes. They check that everything's working as expected, that all the numbers and figures are adding up and the connections are still responsive. It's a great addition to our testing process and will save hours of manual testing in the weeks, months and years to come. - -Github issue: [131](https://github.com/akvo/akvo-rsr/issues/113) - -Bug fixes ----- -###Image slider thumbs not faded on initialisation -There was a slight UI issue with the image slider on project pages. - -Github issue: [50](https://github.com/akvo/akvo-rsr/issues/50) - -###Video Updates Scrollbar - -We found that some videos were being bordered by scrollbars when showing on the RSR Update page. This made them look more than a little messy. So after some poking, we've fixed it and removed those unsightly bars. - -Github issue: [104](https://github.com/akvo/akvo-rsr/issues/104) - -###Unpublished Projects Administration - -After making some major changes to the way unpublished projects are visible in RSR, we have made a further change to allow easier administration and maintenance by Akvo Staff of these projects. In short, it's now possible to do the things we need to do, without any jiggery-pokery. - -Github issue: [91](https://github.com/akvo/akvo-rsr/issues/91) - -###Translation of Listing Headings - -A while back we made a large effort to translate our user interface into multiple languages. Almost all of the non-user-generated content within RSR is now available in different languages. Some items however missed out... - -We have now updated this so that the project listing pages such as http://akvo.akvoapp.org have all the column titles translated - not just the select ones from before. - -Github issue: [48](https://github.com/akvo/akvo-rsr/issues/48) - -###Duplication of Partners on Project Page - -The list of partners presented on the Project page was for a while showing the same organisations multiple times when this partner was connected to a project with multiple roles - such as Support Partner and also as Funding Partner. We've fixed the filter again now so no matter how many times a parter is linked they will be shown just the once. If however you go through to the Partners page for that project, you'll be able to see each partner and the roles they perform. So we've not lost anything, just tidied it all up a little. - -Github issue: [127](https://github.com/akvo/akvo-rsr/issues/127) - ---------------------------------------------- - -Akvo RSR ver 2.1.1 release notes ---- -17 September 2012, (Code name: Jujube) ac - -Overview ----- -We have release several items in this version focusing around permissions and IATI identification. Along with a few bug fixes for good measure. - -New features & changes ----- - - -###Extension of the Akvo API -We have improved the functionality of the Akvo API to improve usability all-round. This feature now enables users to authenticate their access using an API key linked to an Akvo RSR User account. This allows a little more access in terms of information as now user details can also be passed through a correctly authenticated access request. -We've also included a "depth" option to the querying. This enables the requester to choose how much information is pulled alongside the item they are looking at - for example linking to a project, you will also want to pull information from tables linked to the project table. The depth option provides this opportunity. - -Further information on the API is available in the [Github Akvo RSR Wiki](https://github.com/akvo/akvo-rsr/wiki/Akvo-RSR-API) - -Github issue: [72](https://github.com/akvo/akvo-rsr/issues/72) & [75](https://github.com/akvo/akvo-rsr/issues/75) - -###IATI Identifiers -This feature is to implement the ability to add an IATI activity identifier to Projects and IATI identifiers for Organisations. - -This is the first step in an end-to-end transparency initiative to enable navigation from the original funding source present on the OpenAid website at http://openaid.nl through to the RSR Organisations and Projects where this money is being spent. - -Github issue: [69](https://github.com/akvo/akvo-rsr/issues/69) & [74](https://github.com/akvo/akvo-rsr/issues/74) - -### Partner Identifier -Partners are now able to add an Identifier to projects via the Akvo RSR Admin. This field can be used by Partner Administrators to track the identity of their own projects. This can be anything the Partner wishes, but the main purpose we expect is to use the Id that is being used for the project in their internal systems. - -This Id is usable in the API, allowing partners to query their data in RSR using the Ids in their own systems. - -Github issue: [86](https://github.com/akvo/akvo-rsr/issues/86) - -###Public viewing of Unpublished projects -This developed feature is in multiple parts. - -A change has been made to make unpublished projects in RSR only visible to those who are logged in to RSR AND are connected to the project. This moves the functionality in line with what most people expect - unpublished means that it is not public. - -If you are not logged into RSR at all, then when you view an unpublished project [such as project 609](http://akvo.org/rsr/project/609/) then you are presented with a [404 Error - page does not exist](https://raw.github.com/akvo/akvo-rsr-docs/master/image/404_not_found_unpublished.png). - -If you are logged into RSR, but are not connected to the project then you are presented with a [403 Error - forbidden access](https://raw.github.com/akvo/akvo-rsr-docs/master/image/403_no_access_to_unpublished.png). - -If you are logged in and connected to an unpublished project, then you are able to access the page, but this displays clearly that [the project is not live](https://raw.github.com/akvo/akvo-rsr-docs/master/image/access_to_unpublished.png). - -Github issue: [39](https://github.com/akvo/akvo-rsr/issues/39) - -Bug fixes ----- - -###Add Update Page Layout Issue -There was a slight mis-alignment of the foem fields on the Add an Update page. This has now been corrected. - -Github issue: [83](https://github.com/akvo/akvo-rsr/issues/83) - -###Incorrect Errors in Update process -We noticed that on certain actions when trying to add Updates to projects, the wrong error message was being displayed. We have corrected this so that if the issue is related to permissions then this is displayed. - -Github issue: [39](https://github.com/akvo/akvo-rsr/issues/39) - -###Akvo Stats Page -There was an error in the Overview page following an update to the database fields. This has been rectified, so we now see all the data on [this page](http://www.akvo.org/rsr/data/overview/) again! - -Github issue: [68](https://github.com/akvo/akvo-rsr/issues/68) - -###Global Map Info Window Scrollbar -When pictures in portrait format were displayed in the info windows for the global project or organisation map, then a scrollbar was appearing on the right hand side of the window. This was not necessary as the window resized to accommodate the image - so we've removed it. - -Github issue: [66](https://github.com/akvo/akvo-rsr/issues/66) - -Akvo RSR ver 2.1.0 release notes ----- -2 August 2012, (Code name: Iyokan) ac - -Overview ----- -This release contains improvements to the map functionality that was implemented in the previous release. As well as some structural changes to the database to facilitate this functionality. We've also squeezed in more than a handful of bug fixes as well. - -New features & changes ----- - -###TastyPie API -This release brings the first prototype of our new API into play. This is a simple model to begin with, but we will be working with some close partners to pad out the functionality to provide exactly what everyone wants from this functionality. -More information about this can be found on this subject on the Github wiki page for the [Akvo RSR API](https://github.com/akvo/akvo-rsr/wiki/Akvo-RSR-API). -The existing API will shortly be depreciated in favour of this one. - -Github issue: [21](https://github.com/akvo/akvo-rsr/issues/21) - -###Text Formatting in Project Updates -We have added the ability to use some Markdown formatting when submitting project updates to RSR. We have restricted the language to a relevant sub-set and will be providing partners with information on how to utilise this feature in the update process. - -Github issue: [24](https://github.com/akvo/akvo-rsr/issues/24) - -###Map info bubbles -In our last release we introduced a new style of maps. In this release the info windows contained only a link to the object. Now we have embellished this a little further to also include the primary image for the object. Further work on these windows is still to be completed. - -###Map zoom level outliers - -We have implemented a new style of maps on the system which will enable us to use more geospacial tools and tricks going forwards. However there was an issue that for Partner Sites which had only 1 project, the map zoomed so far that it occasionally looked as though there was no map loaded in the background. We have now applied a default zoom level to maps that only have a single pin. - -GitHub issue: [46](https://github.com/akvo/akvo-rsr/issues/46) - -###People who get... - -We have removed the 'People who get' box from Organisation pages as this was often providing misleading results. We will be working to determine what information should be displayed in this location. - -GitHub issue: [10](https://github.com/akvo/akvo-rsr/issues/10) - -###Searching on secondary locations - -Within the work we have done on locations, we have improved the search filter in the application to include the information in secondary locations. - -GitHub issue: [18](https://github.com/akvo/akvo-rsr/issues/18) - -###Location Refactor - -We have changed the way locations are stored and served in the system. Now a location can be either a project location or an organisation location. This provides us with the additional flexibility required to provide better information and functionality in maps and location functions. - -GitHub issue: [27](https://github.com/akvo/akvo-rsr/issues/27) - -###Adding Kosovo to our country list - -Kosovo declared [independence](http://en.wikipedia.org/wiki/2008_Kosovo_declaration_of_independence) in 2008, however to date it has not been allocated an ISO country code. We have recently partnered with an organisation working in Kosovo and so have added it to our country list. - -GitHub issue: [56](https://github.com/akvo/akvo-rsr/issues/56) - -###AJAX Loading Animation - -While we have made many changes to improve the speed and performance of the site, it still occasionally happens that a map needs some time to load in the browser before being visible. In this instance we needed a loading animation, so we put one in. If you want to see this then you'll need to be quick as it doesn't hang around for long. - -GitHub issue: [42](https://github.com/akvo/akvo-rsr/issues/42) - -Bug fixes ----- - -###Multiple Primary Locations Bug - -We fixed an issue which created an error when a project was labelled with multiple primary locations. All duplicates have now been removed and the fix also prevents this from reoccurring. - -GitHub issue: [7](https://github.com/akvo/akvo-rsr/issues/7) - -###PayPal Donations blank confirmation page - -PayPal changed it's methods to use HTTP GET in place of HTTP POST. This had an effect that after making a donation, the confirmation page was not served to the user. - -GitHub issue: [63](https://github.com/akvo/akvo-rsr/issues/63) - -###Runtime error when removing projects - -We fixed an issue which caused errors when making major changes to projects and the connected database items. - -GitHub issue: [59](https://github.com/akvo/akvo-rsr/issues/59) - -###Partner Map Widget Error - -The Map Widgets for Partner Sites were not working due to an error in the templates. This is resolved and they have been fully functional for several weeks now, but the full fix is being checked in with this release. - -GitHub issue: [45](https://github.com/akvo/akvo-rsr/issues/45) - -###Resolving some display issues - -Some organisations had contact details such as websites or email addresses, which were too long for the fields in the application. So we've made a change to truncate these items whilst continuing to provide the full clickable link. -[How it used to look](https://www.dropbox.com/s/pvlxism0hdkkfij/Screen%20Shot%202012-07-25%20at%2013.51.20%20PM.png) and [how it looks now]{(https://www.dropbox.com/s/gvps4pbfufn2zqo/Screen%20Shot%202012-07-25%20at%2013.51.26%20PM.png) - -GitHub issue: [36](https://github.com/akvo/akvo-rsr/issues/36) - -We noticed that in some partner sites, the funding box on project pages was over-running it's boundaries and obscuring the figures. We made a change to hide some of the text when this spills over to preserve the numbers. -[Originally](https://www.dropbox.com/s/0cxjsu8e3upvlfx/Screen%20Shot%202012-07-25%20at%2013.55.10%20PM.png) and now [with the fix.](https://www.dropbox.com/s/oe6vo8sqqgyl738/Screen%20Shot%202012-07-25%20at%2013.56.23%20PM.png) - -GitHub issue: [40](https://github.com/akvo/akvo-rsr/issues/40) - -###Project to organisation relationship duplicates - -We have fixed an error in the system which was caused by a project being linked to an organisation twice with the same type of relationship. This had the knock-on effect of doubling amounts related to funding and budgets for the project. It is no longer possible to create this situation, and we have resolved all the previous instances. - -GitHub issue: [35](https://github.com/akvo/akvo-rsr/issues/35) & [58](https://github.com/akvo/akvo-rsr/issues/58) - -Non-functional changes ----- - -###Python 2.7 Upgrade - -Various Python packages are no longer supported on Python 2.5, so we needed to upgrade our servers to use the 2.7 version. - -GitHub issue: [9](https://github.com/akvo/akvo-rsr/issues/9) - -###Web server to use mod_wsgi - -The web server components have been upgraded to use the newer [mod_wsgi](https://docs.djangoproject.com/en/1.4/howto/deployment/wsgi/modwsgi/) app handler since mod_python is now [deprecated](https://docs.djangoproject.com/en/1.4/howto/deployment/modpython/) and support will be removed in Django 1.5. - -GitHub issue: [55](https://github.com/akvo/akvo-rsr/issues/55) - -Akvo RSR ver 2.0.7 release notes ----- -29 June 2012, (Code name: Hawthorn) pb - -Overview ----- -This release contains improvements to the way global maps are rendered in Akvo RSR. These maps are now rendered using AJAX calls resulting in dramatically reduced template size and rendering times for the pages in question. - -New features & changes ----- -### New global project and organisation maps -The global projects and organisations maps (including the small map on the akvo.org home page) are now rendered using JSON data and AJAX. This has resulted in dramatic speed improvements to these pages. - -GitHub issue: -[38](https://github.com/akvo/akvo-rsr/issues/38) - -### "People who get..." box removal - -The "People who get..." box has been removed on all Organisation pages. - -GitHub issue: -[10](https://github.com/akvo/akvo-rsr/issues/10) - -### Partner site error pages - -Specific HTTP status code 403, 404 and 500 error pages now exist for partner sites. - -GitHub issue: -[31](https://github.com/akvo/akvo-rsr/issues/31) - -### Partner site widget wording - -The page for getting a PS Widget, displays incorrect information about how to widget will work. It says that the widget will redirect back to the Akvo.org page and it will redirect back to the original partner site page. The wording on this widget has been fixed. - -GitHub issue: -[25](https://github.com/akvo/akvo-rsr/issues/25) - -Bug fixes ----- -### Partner list navigation -The navigation of multiple pages of partners in Akvo RSR was not working correctly. This has been fixed. - -GitHub issue: -[26](https://github.com/akvo/akvo-rsr/issues/26) - -### Sorting on continent/country in listing widget -Due to complexity in the way we are currently storing location data, continent and country sorting in listing widgets is broken. This sorting has been disabled until we change the way location data is handled in the system. - -GitHub Issue: -[11](https://github.com/akvo/akvo-rsr/issues/11) - -Akvo RSR ver 2.0.6 release notes ----- -7 June 2012, (Code name: Guava) gvh - -Overview ----- -This release contains the Beta Version of our Multi-Lingual Interface for Partner Sites and also the first Partner Site Widget, with a Map. Additionally, we have also performed several important de-normalisation modifications to the system to improve performance throughout the site. - -New features & changes ----- -###Multi-lingual Partners Sites Beta -Partner Sites introduces beta support for different lanugages. The URLs now have a lanauge code prefix (en/es/fe/nl) which sets the user interface language. This means it is now possible to link to a specific lanauge. The language can be changed from a drop down menu at the top right of the site. - -Pivotal Tracker Stories: -[29702725](https://www.pivotaltracker.com/story/show/29702725) and [29625905](https://www.pivotaltracker.com/story/show/29625905) - -###Create Partner Site Map Widget -We have created a new Map Widget which is available via Projects visible in Partner Sites. This has been implemented using async map loading and an API. - -Pivotal Tracker Story: -[23693093](https://www.pivotaltracker.com/story/show/23693093) - -###De-normalise Financial Information for Projects and Organisations -Some de-normalisation of Database Information that is referenced within Akvo RSR has been performed to speed up the provision of web pages. As an example the loading time of Akvo.org homepage has been significantly reduced. To achieve this improvement, jonny-cache has been implemented. - -Pivotal Tracker Story: -[27249075](https://www.pivotaltracker.com/story/show/27249075) - -###Refactor the API for Financial Information -As part of the de-normalisation being done in the system, the API to transfer information internally has been refactored to allow Financial Information to be delivered. - -Pivotal Tracker Story: -[27250173](https://www.pivotaltracker.com/story/show/27250173) - -###Conversion of LICENSE file -The LICENSE File in Guthub has been converted to Markdown format, and the root docs have been updated. - -Pivotal Tracker Story: -[30320839](https://www.pivotaltracker.com/story/show/30320839) - -Bug Fixes ----- -###Set Initial Partnership Inline to User's Organisation -When a user creates a new Project now, the Organisation they belong to is automatically added as one of the Partners for the Project. - -Pivotal Tracker Story: -[25288719](https://www.pivotaltracker.com/story/show/25288719) - -###Budget Items within RSR Admin Missing -A problem with Permissions caused certain Data Items not to appear in RSR Admin to Users and Administrators. This has now been resolved. - -Pivotal Tracker Story: -[29704531](https://www.pivotaltracker.com/story/show/29704531) - -###Ensure Deployment Directories have Applicable Web Group Permissions -The Deployment Process Home and other Relevant Deployment Directories are now created with Web Group File System Permissions and Access. - -Pivotal Tracker Story: -[23664419](https://www.pivotaltracker.com/story/show/23664419) - -###Resolve Translation Issues -A variety of issues, queries and feedback items have been resolved resulting from the previous Translation Implementation. - -Pivotal Tracker Stories: -[29976705](https://www.pivotaltracker.com/story/show/29976705) and -[28720359](https://www.pivotaltracker.com/story/show/28720359) - -###Donation Engine on Test Site not working -We have fixed a bug in the Test System caused the Donation Process to direct to the Live Donation Site. - -Pivotal Tracker Stories: -[30559557](https://www.pivotaltracker.com/story/show/30559557) - -Akvo RSR ver 2.0.5 release notes ----- -15 May 2012, (Code name: Fennel) pb, ogl, ac - -Overview ----- -This release addresses a problem whereby certain project fields were not being constrained in length consistently. Django >= 1.4 is now a requirement of Akvo RSR and, as such, several parts of the system have been upgraded to support it. - -New features & changes ----- -### New translations -Initial preparation work has been done to support Dutch, French and Spanish localisations. - -Pivotal Tracker stories: -[25221481](https://www.pivotaltracker.com/story/show/25221481), -[26502217](https://www.pivotaltracker.com/story/show/26502217) and -[26786625](https://www.pivotaltracker.com/story/show/26786625) - -### Project goals improvements -In order to support custom goals within a project, a new Goal model has been created. - -Pivotal Tracker story: -[27515615](https://www.pivotaltracker.com/story/show/27515615) and -[28809041](https://www.pivotaltracker.com/story/show/28809041) - -### Project field constraints -Due to a problem whereby certain project fields were not being consistently constrained, several changes have taken place under the hood to limit these fields going forward whilst maintaining support for the old data. - -More information about this problem can be found [here](http://www.akvo.org/blog/?p=5262). - -Pivotal Tracker stories: -[25606657](https://www.pivotaltracker.com/story/show/25606657) and -[27251477](https://www.pivotaltracker.com/story/show/27251477) - -### Project fields renamed -To improve consistency between the Project PDF form and the Project sections of the Django admin interface, certain Project fields were renamed. - -Pivotal Tracker stories: -[27010245](https://www.pivotaltracker.com/story/show/27010245), -[27011303](https://www.pivotaltracker.com/story/show/27011303), -[29704721](https://www.pivotaltracker.com/story/show/29704721) and -[29907631](https://www.pivotaltracker.com/story/show/29907631) - -### Project details -Improved the layout for project details summary. - -Pivotal Tracker story: -[27008303](https://www.pivotaltracker.com/story/show/27008303) - -### Partner site routing middleware improvements -It is now possible to configure in settings files which domain names the partner sites routing middleware will operate on. Previously this was hardcoded into the middleware. In addition to this, the routing middleware has been updated to work together with the Django Sites framework so as not to break third party applications which depend on the functionality of the Sites framework. - -Pivotal Tracker stories: -[22953583](https://www.pivotaltracker.com/story/show/22953583) and -[27234363](https://www.pivotaltracker.com/story/show/27234363) - -### Partner site UI improvements -Improved the Add Update and Get a Widget UI components. - -Pivotal Tracker story: -[26903241](https://www.pivotaltracker.com/story/show/26903241) - -### User permissions admin -Improved the Admin UI for managing user permissions and groups and updated permissions for use with Django 1.4. - -Pivotal Tracker story: -[28126391](https://www.pivotaltracker.com/story/show/28126391) - -### Project admin -Corrected project listing order subsequent to Django 1.4 upgrade. - -Pivotal Tracker story: -[28107129](https://www.pivotaltracker.com/story/show/28107129) - -### Project Page UI Changes -In addition to some of the field changes, there have been some important modiofications in the layout and design of the Project Page. Within the Summary area this includes restricting the amount of space available for the Summary and adding a View More button for the Project Indicators, allowing the viewer to choose if they want to see all of the Indicators. Further in the Project Page, a new Tab has been added called Goals, and moved some of the information within these tabs to be more evenly distributed. The tabs are set out in chronological order, so it reads more like a story from left to right with the past, present and future. - -Fixes ----- -### Project updates -The "Sign in to add update" textual hint now disappears as expected when a user is already signed in. - -Pivotal Tracker story: -[26983111](https://www.pivotaltracker.com/story/show/26983111) - -### RSR admin -Replaced project goals overview in project admin. Corrected project listing order subsequent to Django 1.4 upgrade. - -Pivotal Tracker stories: -[28105979](https://www.pivotaltracker.com/story/show/28105979), -[28107129](https://www.pivotaltracker.com/story/show/28107129), -[28110191](https://www.pivotaltracker.com/story/show/28110191) and -[28874085](https://www.pivotaltracker.com/story/show/28874085) - -### Partner sites -Partner site project update edit form now retains previously entered data. Budget line item text is now displayed as expected. -Fixed the sign-in process when partner sites are hosted on partner's own domain. - -Pivotal Tracker stories: -[23990641](https://www.pivotaltracker.com/story/show/23990641), -[29684439](https://www.pivotaltracker.com/story/show/29684439) and -[29907575](https://www.pivotaltracker.com/story/show/29907575) - -### Akvo blog posts -Corrected markup for blog posts so that they appear as expected on the Akvo home page. - -Pivotal Tracker story: -[22517473](https://www.pivotaltracker.com/story/show/22517473) - -Non-functional changes ----- -### Upgrade to Django 1.4 -The latest version of Django contains several backwards incompatible changes across the framework. Release 2.0.5 of Akvo RSR has been updated to support Django 1.4. In addition, some third-party Django apps also had to be patched or upgraded to support the upgrade to Django 1.4. - -Pivotal Tracker stories: -[26809039](https://www.pivotaltracker.com/story/show/26809039), -[27784115](https://www.pivotaltracker.com/story/show/27784115), -[27833485](https://www.pivotaltracker.com/story/show/27833485), -[27835435](https://www.pivotaltracker.com/story/show/27835435), -[27893279](https://www.pivotaltracker.com/story/show/27893279) and -[28673101](https://www.pivotaltracker.com/story/show/28673101) - -### Deployment automation -Improvements were made to the RSR deployment process so that RSR instances can now be deployed automatically for testing purposes. - -Pivotal Tracker stories: -[21406319](https://www.pivotaltracker.com/story/show/21406319), -[23633289](https://www.pivotaltracker.com/story/show/23633289), -[26763721](https://www.pivotaltracker.com/story/show/26763721) and -[29670447](https://www.pivotaltracker.com/story/show/29670447) - -Akvo RSR ver 2.0.4 release notes ----- -27 March 2012, (Code name: Eggplant) ogl - - -Overview ----- -This is primarily a maintenance release. - -New features & changes ----- -### Switched the 'Get a widget' button and 'Add update' link -[PT story 25207905](https://www.pivotaltracker.com/story/show/25207905) The 'Get a widget' button and 'Add update' link in the 'Tools for this page' section of a project page have been switched around since users would more frequently be viewing a project page to provide project updates rather than to get project widgets. - -Fixes ----- -### Corrected display of global organisation map -[PT story 26632783](https://www.pivotaltracker.com/story/show/26632783) The global organisation map now displays without errors. - -### Corrected highlighted text colour for selected text on partner sites -[PT story 24968667](https://www.pivotaltracker.com/story/show/24968667) The highlighted text colour on partner sites is now blue, as is the convention for selected text, instead of pink. - -### Corrected validation process when entering video project updates on partner sites -[PT story 24054429](https://www.pivotaltracker.com/story/show/24054429) The validation process now waits for the video URL to be entered before validating. - -### Corrected styling on project update pages for parter sites -[22289553](https://www.pivotaltracker.com/story/show/22289553) Corrected colour differences of photo and video captions and credits on partner sites. - - - -Akvo RSR ver 2.0.3 release notes -------------------------------------------- -22 February 2012, (Code name: Dewberry) bw - - -New features & changes ----------------- -### Expanded and customizable budget line items -This release reworks how line items for project budgets are handled within RSR. Up to this point there have been 6 budget line items: building, employment, maintenance, management, training and other. Release 2.0.3 removes "other" and adds the fields other 1, other 2, other 3. Organisation administrators and project editors can enter custom labels for these line items in their budgets. - -Additionally, Akvo's administrators now have the flexibility to expand the list of common budget items. The list of choices should be expanded cautiously as the commonly-used forms become obvious. Having a standard list helps users compare & understand financial plans across multiple projects and organisations. - -### Size of photos and videos in updates. -The photos and embedded videos on an individual update page are now larger, making details easier to see. - -### Custom landing page URLs redirected to appropriate partner sites. -Landing page functionality is deprecated in favor of partner sites. - - -Bug fixes ---------- -### Enter/Return does not post form on Sign in page. -Certain browsers did not post the sign in form when Enter/Return key was hit; this is now fixed. - -### Latest Updates missing on project comments page. -Fixed a bug where Latest Updates section did not appear on the project comments page. - -### Funding amounts field appears for non-funding partners. -Fixed a bug in the changed partner types code whereby it was possible to set funding amounts for other partner types. - -### Map display when there are no projects or none fitting selection criteria. -The main partner site page includes a map displaying all organisation projects. When there were not yet any projects or filtering returned no matching projects the map completely disappeared, leaving only a display glitch. This is now fixed. - -### Partner site workflow issues when signing in to add an update. -Fixed page routing to match expectations. - - - -Akvo RSR ver 2.0.2 release notes -------------------------------------------- -30 January 2012, (Code name: Carrot) bw - -Overview ------------- -The release adds the ability to sign in and add updates to Akvo RSR from a partner site. It also contains a reworking of the way in which organisations are internally linked to projects in RSR. We've also updated our version of JQuery. - -New features & changes ----------------- -### Partner site sign in and add updates capability. -Users with Akvo RSR accounts can now sign in to Akvo RSR on partner site pages. Signed-in users can add updates to projects on a partner site just as they do on the main Akvo site project pages. This includes adding text, a photo, or video URL to the update, and the ability to edit updates for a limited time after update creation. - -### Rework of relationship between organisations and projects. -Organisations can be linked to projects making them project partners. There are 4 types of links, or partnership types: Field partner, Funding partner, Sponsor partner and Support partner. The current code proved to be inefficient and needed to be changed. - -Users no longer need to enable a particular partnership type on the Organisation form. Instead partnership type is set directly on a project by choosing the organisation and then setting the type of partnership. It is possible for the same organisation to have multiple types of partnership on the same Project. Tip: In the organisation list on a project, press the first letter of an organisation's name to scroll the list forward. - -There is a Funding amount field visible regardless of type of partner chosen. Only Funding partner amounts are recorded and used in RSR. In a future release the field will be hidden unless the partnership type is set to Funding. - -### Updated JQuery to version 1.7.1. - - -Bug fixes ---------- -### Cannot upload image file names same as thumbnails. -Fixes an issue loading image files with the same name format used by RSR thumbnails. - -### Fixed home page WordPress issues. -The home page was only presenting blog posts in the partners category. Now it will display the last 2 posts from any category. - -### Partner site breadcrumb, logo and courtesy back link. -Added code to handle the case when no return URL is specified for the partner site, nor has a URL been specified for the organisation. In this situation the logo and the breadcrumb text are no longer links and the organisation courtesy link is completely suppressed. - -### Miscellaneous partner site ui and usability tweaks. -This includes adding the Powered by Akvo logo and centering the Donate button. - -### Changed tax status page on donation pages and messages. -Fixes an issue whereby misleading information was given in donation templates and emails pertaining to the tax deductible status of certain types of donations in the United States of America. - -### Remove PvW/DWS template files. -Removed old template files associated with the PvW/DWS project, which will be managed as its own branch from now. - ---- - - -Akvo RSR ver 2.0.1 release notes -------------------------------------------- -29 November 2011, (Code name: Elderberry) kad - -Overview ------------- -The release's biggest feature is extended RSS feeds. Besides that the images on the updates list page have been sized to match videos as on partners sites. - -Several related bugs around the presentation of funding have been fixed. - -New features ----------------- - -### RSS feed with images and media extensions -The RSS feed for project updates has been upgraded to include any images that are part of the update. The image is included in the field as an and will be shown as part of the update text in most feed readers. - -Currently the Akvo RSS includes three kinds of feeds: - -* **/rsr/rss/updates/NNN** where NNN is the ID of a Project. - - Returns all updates for that project. An RSS icon for this feed can be found on the main page of each project. - -* **/rsr/rss/org-updates/NNN** where NNN is the ID of an Organisation - - Returns all updates for all projects that the organisation is a partner to. An RSS icon for this feed can be found on each organisation page. - -* **/rsr/rss/all-updates/** - - Returns all project updates in RSR. An RSS icon for this feed can be found on the home page. - -All feeds are in reverse chronological order. - -All feeds are extended using the [Media RSS module defined by Yahoo](http://video.search.yahoo.com/mrss) for easy retrieval of the images available through the feeds. - -The feed has also been extended to include the author of the project update. - -### Increase size of images in updates list -Backport partner sites photo thumbnail size on /updates/ list page to akvo.org's /updates/ list page. The increase makes them the same size as video - -### Renamed RELEASE_NOTES.txt to RELEASE_NOTES.md -To make Github understand and apply the correct format to the Markdown file it is renamed to .md. - -Bug fixes ---------- - -### Removed self referencing "funding details" link -Removed self referencing "funding details" link in the funding box. - -### Added funding details box to partner site's funding page -Funding details page were missing funding/status box. - -### Link to funding details have disappeared from the funding box -Link to funding details have disappeared on Partner Sites. - ---- - -Akvo RSR ver 2.0 release notes -------------------------------------------- -28 October 2011, (Code name: Garlic) tbp - -Overview ------------- -Akvo RSR 2.0 is a preview release that introduces a major new feature to Akvo RSR, multitenancy, which we call Partner sites. Partner sites allows an organisation which already has projects on the Akvo RSR system to display all of these projects on their own website. This will be done by useing the Akvo RSR tools on their own designated URL, with their own branding and styling. We believe that this will be the main way most people will think of Akvo RSR in the future. - -Being a preview release means that all the features we are expecting on a Partner site in the future are not ready yet, there are some rough edges, but we consider the features that are available suitable enough to start experimenting with. - -The Akvo RSR tools available on the aggregated site (Akvo.org) have not changed for this release, except for a minor bug fix. - -New features ----------------- -### Partner sites, multitenancy -The Partner sites features allow you to have your own projects on your own website with a separate URL, with your own branding and styling. - -A Partner site will live under a separate domain. The default URL for a new Partner site for Akvo.org will be a subdomain under akvoapp.org, for example: [http://connect4change.akvoapp.org](http://connect4change.akvoapp.org). The partner site can also be setup to be displayed under another appropriate domain, for example: [http://projects.connect4change.nl](http://projects.connect4change.nl). - -Your own Partner site can be configured and managed by a user with organisation administrator privileges (initial setup you need to request the Akvo.org team to do during the preview period). - -### Notes about Akvo RSR Partner sites multitenancy -The Akvo RSR multitenancy implementation has a shared data space for the application. Information that is shared between partners is also shared between Partner sites as well as shown on the aggregation site (i.e. Akvo.org). - -For example: the information about one a project is shared between all organisations that collaborate on that project. An update to a project will show up on all the various Partner sites which are showing that particular project. Likewise, if an organisation changes its logo on the organisation page the logo will also change on all Partner sites displaying this organisation, as well as on Akvo.org. - -### New functionality -The following functions are new to Akvo RSR 2.0 preview of Partner sites and don’t exist on Akvo RSR on Akvo.org. Some of these functions may be added to the aggregated site (Akvo.org) later. - -- A Partner site will live under a separate domain, distinct from the aggregate domain -- A Partner site can be displayed under a custom domain (CNAME) -- Filtering also reflects the projects marked on the map on the Partner site home page (i.e. filtering for Africa will only show projects in Africa on the map) -- Ability to style content with CSS on the Partner site -- Ability to add a picture and HTML content for the description of an organisation on the home page of their Partner site -- Filtering displays the number of projects displayed and what filter is applied -- Ability to add a custom back link to another website - -### Limited functionality -The following features have not been completely implemented yet in Akvo RSR 2.0 preview of Partner sites, but will be updated at a later stage. - -- Funding box on project page has limited layout -- Latest updates display on project page (banner is missing) -- Project partners listing -- Donations, you will be sent to the Akvo.org site to do a donation and not returned to the Partner site - -### Excluded functionality -The following functions have not been implemented yet in Akvo RSR 2.0 preview of Partner sites, but will be implemented at a later stage, in some fashion. - -- Widgets -- Comments -- Focus areas and categories -- RSS feeds -- Sign in, you can sign in on Akvo.org to administer your account and your projects -- Add update, you can still sign in on Akvo.org to make an update -- Partner listing showing a partners role in a project - -### Akvo.org specifics for Partner sites -On Akvo.org you can request organisation administrator privileges by emailing partners@akvo.org, if your organisation is on a paid services plan. - -Bug fixes ---------- -The link to the latest blog news article was not shown on the home page. -[Lighthouse RSR ticket 247](https://akvo.lighthouseapp.com/projects/46515/tickets/247) - ---- - -Akvo RSR ver 1.0.11 release notes -------------------------------------------- -17 October 2011, (Code name: Rhubarb) pb & bw - -Overview ------------- -The release fixes a bug in password reset, and expands existing functionality related to embedded video updates and editing updates. It adds the ability to use an existing project as the basis for a new project. Several internal changes to Akvo RSR have also been made, including use of ISO 3166 country codes in location fields, a different sorting method on listing pages, RSR settings file changes, and a move to using South for data migration. - -New features ------------- -### Save existing project as new project -In the admin you can now create a copy of an existing project. The "Save and add another" button is replaced by "Save as new". Use this button to create a new project with most of the same information as the current one. Location data, project image, updates, individual donations and comments are not copied. All benchmark values are set to 0. - -### Improved project update form -When editing a project update, the update form now displays thumbnails of any video or photo included with the original update. The original video or photo can be replaced, or the video removed. The photo cannot (yet) be completely removed. - -### Updates with video now thumbnails on Akvo home page and project page -Updates with embedded video now display thumbnails of the video on the project page. - -Recently posted project updates with videos are now displayed on the home page. Previously only updates with photos were displayed. Updates containing both a photo and video will display the video thumbnail to represent the update. - -### Refactor of country data -Refactoring of how we handle countries in the data model. We now use the ISO-3166-1 alpha-2 list of countries as the base for the country list. The only outward facing change is a slight modification in how the filter on the project listing page (/rsr/projects/all/) behaves. Selecting a continent no longer automatically restricts the countries displayed on the country pulldown. -Instead the relevant continent is always set when a country is selected in the filter. - -### Rework RSR settings -Internal RSR settings have been updated to a more flexible arrangement. This also fixes issue with serving multiple versions of RSR with the same code base. - -### Changed version of django-sorting library used by RSR. -Changing the library also uncovered several SQL issues, now fixed. - -Bug fixes ---------- -### Server error bug when generating password reset email message has been fixed. -[Lighthouse RSR ticket 227](https://akvo.lighthouseapp.com/projects/46515-akvo-rsr/tickets/227-error-with-password-reset) - -### Fix to text filtering of user profiles in RSR Admin. -[Lighthouse RSR ticket 169](https://akvo.lighthouseapp.com/projects/46515-akvo-rsr/tickets/169-search-user-profile-listfielderror) - - ---- - - -Akvo RSR ver 1.0.10 release notes -------------------------------------------- -17 October 2011 / Deployed 4 July 2011, (Code name: Granite) pb - -New features ------------- - -This release contains no new features. - -Bug fixes ---------- - -### Broken link in project listing widget - -A broken link reference in the project listing widget template was causing 500 errors on partner websites. This has been fixed. - -### Benchmarks list rendering issue - -Fixed broken benchmarks list which caused the project page to render incorrectly in some older browsers. - -### Cron script to handle stale invoices - -After the addition of the SMS gateway application, the cron script to detect stale invoices was no longer able to run. The script now functions as expected. - - -Akvo RSR ver 1.0.9 release notes -------------------------------------------- -28 June 2011, (Code name: Quadrant) pb - -New features ------------- - -### Ability to edit project updates - -The release adds the ability to edit project updates. Up until now, once a project update had been created it could no longer be edited in any way. Now the user who created a project update may also now edit it for up to 30 minutes after its original creation time. - -### Improved handling of embedded videos - -Several improvemenets have been made to video embedding in project updates. Short-form YouTube URLs are now supported so a user can now enter both youtube.com and youtu.be URLs. - -Shortly after the release of RSR 1.0.8, Blip.TV made several backwards-incompatible changes to their API meaning that supporting blip.tv video URLs was no longer possible. This situation has now been rectified and RSR 1.0.9 handles both old-style and new-style blip.tv video URLs. Users should, however, only use the new-style URLs in project updates. - -In addition to displaying full embedded Flash videos, this release also handles displaying static thumbnail images of video objects. This results in faster page loads for pages displaying multiple videos. - -### Templates updates to new Django syntax - -To ensure compatibility with future releases of Django, RSR's templates now use the new-style template syntax released with version 1.3 of Django. This change is, however, not visible to users of the site. - -More information about the new template syntax can be found [here](https://docs.djangoproject.com/en/dev/releases/1.3/#changes-to-url-and-ssi). - ---- - -Akvo RSR ver 1.0.8 release notes -------------------------------------------- -29 April 2011, (Code name: Blockbuster) bw - -Overview ------------- -The release adds the ability to embed video in updates made via the web. The first generation SMS code is also included, with access restricted to certain users for testing purposes. - -New features ------------- - -### Ability to embed videos in updates - -When creating an update one may now embed a video as well as add text and a photo. URLs from Youtube, Blip and Vimeo are currently accepted. - -### SMS update, alpha for testing ONLY -First steps toward the ability for users to send text updates from a particular mobile phone to a particular project. There are no user-visible changes at this point in time. - ---- - -Akvo RSR ver 1.0.7 release notes -------------------------------------------- -5 April 2011, (Code name: Lustre) bw - -** INTERNAL RELEASE ONLY ** - -Overview ------------- -The Dutch Water Sector site and Akvo RSR code have been updated to run on the same codebase. Different configurations and views allow the sites to operate in their own incarnations when deployed. Akvo-specific changes are listed first, and DWS changes follow below. - -Akvo changes and fixes ---------- -### Help text and links on donations pages have been fixed, expanded and/or clarified. -This includes tagging optional fields (campaign code), specifying format for amounts, correcting links to privacy and donation policy/ Terms and Conditions information, and adding a link to information for institutional donors. -[Lighthouse RSR ticket 94](https://akvo.lighthouseapp.com/projects/46515/tickets/94) -[Lighthouse RSR ticket 135](https://akvo.lighthouseapp.com/projects/46515/tickets/135) -[Lighthouse RSR ticket 189](https://akvo.lighthouseapp.com/projects/46515/tickets/189) -[Lighthouse RSR ticket 192](https://akvo.lighthouseapp.com/projects/46515/tickets/192) - -### Presentation of the option to donate anonymously has been changed. -For usability reasons this was changed to present a pre-checked box "List name next to donation." -[Lighthouse RSR ticket 8](https://akvo.lighthouseapp.com/projects/46515/tickets/8) - -### Error messages for mismatching email addresses on donation pages were incorrect. -When the email address and confirmation email address text did not match, the error message returned was correct, but labelled as being for the Amount field instead of the email address field. - -### Presentation of information in balloon pins of global organisation map changed to match that of global project map. -Clicking the pinned location balloons on the organisation map presented individual organisation info under a large red "Organisation" header. The display now matches that of the projects' pins on global project map. - -### Global map on home page is dislocated under Firefox 4. -The global map was not being rendered in the proper place under Firefox 4. -[Lighthouse website ticket 15](https://akvo.lighthouseapp.com/projects/49157/tickets/15) - -DWS changes and fixes ---------- -### Organisation and project search capability. -This has now been added on the organisation and project list pages respectively. - -### "Deliverables" heading now appears when there is a list of deliverables. -When a project does not have any deliverables, the header does not appear. - -### Project images on the main project page should display a caption. -If a caption has been written for the image, it will now be displayed. - -### The lead partner on a project needs to be more obvious on the project page. -A separate box now distinguishes lead partner(s) from other partners on a project. - -### If there are no updates, then Goals tab should be selected on the main project page. -When updates have been made to a project, the project page displays the Updates tab; if there are no updates yet, the Goals tab is displayed instead. - -### Original deprecated locations fields in Admin have been removed. -These out-of-date fields were still showing up in Admin, though public site uses new Locations model fields. To avoid confusion for users entering project data, they have been removed. - -### Template and media file names have now been renamed from "pvw_take2" to "dws." -References to filenames have been updated to new name as well. - -### Toolbar display issues in Internet Explorer. -The orange Holland logo to the left of the Dutch Water Sector name is in certain circumstances mis-positioned. It has been verified to appear correctly in both Internet Explorer 7 and 8 in a Windows 7 environment, and Internet Explorer 6 and 7 in an XP environment. - -### Global map code now works as in Akvo RSR. -Maps have all the same capabilities as they do in Akvo RSR. - -### The embedded video on the DWS home page was displaying as a broken link img in IE. -IE was not playing object elements; the video was switched to use Youtube-style iframes. - -### "Akvo" appearing in multiple places on the registration/sign up pages. -These have been removed. - -### An iframe on the project page was causing trouble for users. -The iframe was removed from the project page. - -### Get random widget was broken, and has now been fixed. -The organisation selection menu was greyed out at all times for the random project widget. - -### All update photos were appearing at the top of the update, regardless of setting. -Update photos set to display at the end of the update are now behaving properly. - ---- - -Akvo RSR ver 1.0.6 release notes -------------------------------------------- -15 Mar 2011, (Code name: Sextant) kad - -New Features ------------- -### A new setting to the map widget at the get a widget page -At the get a widget page one can now set the map widget to either static or dynamic. In dynamic mode zoom and bubble interaction is enabled. - -Bug Fixes ---------- -### Fixed broken arrows in Internet Explorer 7 on XP -In Internet Explorer 7 on Windows XP arrows used in the interface was not rendered correctly. Those arrows have now been changed to an unicode character that is supported in a clean Windows XP installation. -[Lighthouse ticket 170](https://akvo.lighthouseapp.com/projects/46515/tickets/170) - -### Updated automatic Thank you email -When someone donated to a project that belonged to the Focus Area Health they received a Thank you email that is dedicated to Water & Sanitation. This is now changed to a more appropriate wording. -[Lighthouse ticket 144](https://akvo.lighthouseapp.com/projects/46515/tickets/144) - -### Photos do not appear at first project page view in IE7 -In Internet Explorer 7 the mini gallery of project photos on the project page would not be displayed at first request, only after a refresh. Project photos does now appear at first request. -[Lighthouse ticket 180](https://akvo.lighthouseapp.com/projects/46515/tickets/180) - ---- - -Akvo RSR ver 1.0.5 release notes ------------------------------- -9 Mar 2011, (Code name: Encore) tbp - -New features ------------- - -### Landing page for Rabobank - -A landing page for the Rabobank microfinance projects. (This is most likely the last landing page we do. We are going to focus on the generic solution to this via a new feature codenamed Subsites.) - -### Other changes - -Modified the formatting of the release notes for release 1.0.1-1.0.4 to be more like the previous notes. - ---- - -Akvo RSR ver 1.0.4 release notes ------------------------------- -28 Feb 2011, (Code name: Crossbow) pb - -Akvo RSR v 1.0.4 also contains all of the features and bug fixes from v 1.0.3. See below for more details. - -New Features ------------- - -### Update to Django 1.2.5 - -More information on the [Django 1.2.5 release](http://docs.djangoproject.com/en/dev/releases/1.2.5/). - -### New map widget - -A new widget showing a Google Map of all of an organisation's projects is now available. You must be logged into a Plus Account in order to use this feature. - -### Admin location changes - -City, State and Country fields in a project or organisation's Location data are now optional. Only Latitude and Longitude coordinates are required. - -### "Campaign code" - -An optional "Campaign code" field has been added to the donation system. - -### Donation product description changed - -The product description has been modified to show an identical string for both PayPal and iDEAL donations. The string is "Akvo--". Note that the Mollie/iDEAL API will always truncate this string at 29 characters. PayPal is unaffected by this limitation. - -### Presentation of project and organisation information in large maps - -The information bubbles which appear when you click on a location marker in the global project and organisation maps have been updated to display the information in a much smaller space. This reduces screen clutter. - -Bug fixes ---------- - -### Javascript bug in IE7 - -A bug in the image gallery code on the project main page resulted in a rendering issue on Internet Explorer 7. This was resolved by the addition of custom CSS rules for IE7. - ---- - -Akvo RSR ver 1.0.3 release notes ------------------------------- -9 Feb 2011, (Code name: Primrose) bw - -** INTERNAL RELEASE ONLY ** - -Akvo RSR v 1.0.3 was not released publicly. The following bugs were discovered which prevented release: - -- A regression in the maps-handling code meant that location markers were no longer being displayed. -- The RSR database was not being initialised properly because of an incorrectly configured setting. - -These have been addressed in release 1.0.4. See above. - -New Features ------------- -### Admin: Latest update column -A "Latest update" column has added to the Administrator Project Listing page. This column shows: - -- The date of the most recent update as a link back to that update on the public project page. -- The email address of the user who made the update, as a send-to link. -- A list of support and funding partners for the project, by partnership type, with names as links to the organisation's public page. - -### Admin: By status filter -A "By status" filter has been added to the Administrator Project listing page. The filter allows administrators to view only projects with particular status settings, for example, only projects with the status "Needs funding." - -Bug fixes ---------- -### Duplicate search results -Certain searches on the organisation listing page returned duplicate entries. This has been fixed. -[Lighthouse ticket](https://akvo.lighthouseapp.com/projects/46515/tickets/139) - ---- - -Akvo RSR ver 1.0.2 release notes ------------------------------ -18 Jan 2011 (Code name: Hailstorm) ogl - -Bug fixes ---------- -### Widget location bug -Widgets now display all location information as expected (esp. continent and country details). -[Lighthouse ticket](https://akvo.lighthouseapp.com/projects/46515/tickets/146) - -### Home page IE6 bug -The Akvo home page will now display as expected in Internet Explorer 6. -[Lighthouse ticket](https://akvo.lighthouseapp.com/projects/46515/tickets/129) - -### Get a Widget page display bug -The Get-a-Widget page now has the Projects menu tab selected. -[Lighthouse ticket](https://akvo.lighthouseapp.com/projects/46515/tickets/128) - -### All updates page bug -The All Updates page for a particular project now displays titles for all updates in the list even if some information was missing when a particular update was submitted. -[Lighthouse ticket](http://akvo.lighthouseapp.com/projects/46515/tickets/142) - ---- - -Akvo RSR ver 1.0.1 release notes -------------------------------------------- -14 Jan 2011, (Code name: Indigo) bw -Note: The original 16 Dec 2010 release notes have been edited to better document changes made in 1.0.1. - -New Features ------------- -### Markdown is now available for adding formatting to text used in the MiniCMS text boxes and Focus area description fields. - -Bug Fixes ---------- -### People served calculation -The "People Served" calculation on the Akvo home page now counts only the largest "people affected" benchmark from any category for each project. For any given project, it is likely that the people affected in different categories have some overlap, so calculations for numbers affected should take only the larger number. Currently people affected numbers come only from the Water and Sanitation categories. - -### MiniCMS -The following fixes have been made to the MiniCMS. - -- Map box has been removed. -- Lower section height renamed to Focus areas accordion height. -- Help text has been added regarding HTML tags that can be used in MiniCMS fields. - -Other Changes -------------- -### Load time of organisation listing page decreased. -The data calculations for the columns Requested and Still needed were having a severe impact on its load time, so have been removed. The page loads much faster now. - -### Removed legacy data fields for Location, Category and Benchmark. -Content of the previous data fields were imported into new models in the 1.0.0 release; the old fields have now been removed. - -### MiniCMS -The following improvements have been made to the MiniCMS. -- Name field for instances of the MiniCMS has been added. - ---- - -Akvo RSR ver 1.0.0 release notes -------------------------------------------- -4 Nov 2010, (Code name: One Oh) tbp - -This is the first major release of Akvo RSR since we publicly launched 0.9 on the 8th January 2009. This release is an overhaul of several parts of the system. - -Overview ------------- -We have created a completely new design for Akvo RSR which is visually more attractive and a much better design, and we think it is easier to use and understand. This means we have created a full new set of templates for Akvo RSR. As usual, we have integrated the new template system with Mediawiki, Wordpress and Drupal. - -We have added the ability to add new types of projects to the system. Previously you could only add water and sanitation projects. Now we have a dynamic system where projects belong to something called focus areas, and they are associated with new categories and measure new benchmarks, all which are created dynamically from the administration function. For Akvo.org, Focus areas describe areas in which development aid tries to improve the world around us; Categories describe the type of improvements to be made and Benchmarks indicate the manner in which progress will be measured. - -There is a new nearly completely data and forms driven home page for the system, which means that you don’t have to modify the home page template to add new content. - -We made a mapping system integration for projects and organisations, where the first version uses Google Maps. - -New features ------------- - -### New design and templates -The new Akvo RSR design touches every page, except for the administration pages. Here is an overview of some of the changes this includes: - -- the template system is more modular, and easier to modify and extend -- HTML “snippets” caching is used extensively in the new templates -- breadcrumb trails are available for each page -- new CSS infrastructure -- a mini-sitemap is in the footer of each page - -### Project pages - -Project pages have been re-designed to present a better overview of the project. New features include: - -- picture gallery of project and update pictures -- interactive map and latitude/longitude coordinate display -- page view counter -- new Latest update display - -### Update pages - -Updates now appear both all together on a listing page and each on their own individual pages, much like a tweet in Twitter has its own unique page. This gives each Update a unique URL. - -### Organisation pages - -Organisation pages have been improved with the following new features: - -- link to a searchable project list displaying all projects related to an organisation -- interactive map of organisation’s location - -### Data and forms driven home page - -In an Akvo RSR system we expect RSR to drive the home page of the site. There may be a touch of megalomania in this, but it has made it significantly easier to integrate the key features of Akvo RSR to the front page. We have been dabbling with the idea of letting another CMS drive the front page, but we are not there yet. So as a compromise we have created a feature called MiniCMS, which drives some of the content on the front page, more about that below. - -The areas which are not powered by MiniCMS are pulling content from Akvo RSR or Wordpress. These are: - -- Most recent project updates: shows the latest project updates, with picture -- Right now in Akvo.org...: shows stats from the projects in the Akvo RSR system -- the global Google Map, showing project locations from data in Akvo RSR. -- Project focus areas: takes Focus area content from Akvo RSR -- Recent blog posts: displays the last two blog posts from Wordpress -- Latest news: shows content from Wordpress marked with the category News - -The Right now in Akvo.org... data is self-explanatory, except perhaps for People served. This is the number of people who benefit from projects in Akvo RSR (people getting water and/or sanitation for example), and includes “People affected.” If a project has different numbers for water and sanitation benchmarks, the higher number is used (not everyone gets all services, but all get at least one). People served will also pick up the new Benchmarks data from the new Focus areas. - -With the multiple database support which was introduced in Django 1.2 we can now fetch the blog post data for the homepage directly from the Wordpress database, improving the performance of the home page. - -### Home page CMS, or MiniCMS. - -The MiniCMS allows you to populate the “Feature box” with a picture and HTML. It has some features like scrims and layout tools specifically for the box. The “Top right box” also takes HTML. - -The “Lower section height” controls the height of the Focus area accordion; how high it should be depends on how many Focus areas there are. - -The “Map box text” is already deprecated and will be removed in a later release. - -We are considering whether to add capabilities to the MiniCMS or whether to integrate with a separate CMS like Django CMS, but the jury is out on that at the moment. - -### Maps - -We have created an integration with a map system, at the moment using Google Maps. There are two global maps, one showing all projects and the other all organisations in Akvo RSR. There are also location maps for each organisation page and each project page. We are expect to do a lot more with maps in the future. - -We have created new location models for this, which over time will take over from the old address data fields. We anticipate doing this in the next couple of releases. We did want this to be a two-step process to speed up implementation, allowing us to reschedule some tricky testing that otherwise would need to be done. - -### Classification system and benchmarks - -Akvo RSR has been expanded to work with projects beyond the water and sanitation sector it was originally designed to serve. That gave us an opportunity to change the way you look for projects in the system. First we created a flexible classification system for projects, and then we started creating ways of searching for projects based on that classification. - -The classification system has three interlocking parts. - -- Focus areas -- Categories -- Benchmarks - -Each project belongs to something called a Focus area, which could be Water and sanitation, or Economic Development, or Healthcare, for example. Each Focus area can be associated with one or more Categories, such as Water, Training or Maintenance. Each Category has Benchmarks (aka Key Performance Indicators) associated with it , such as Number of people trained, Water systems installed or Hospitals built. - -Focus areas, Categories and Benchmarks can all be created in the administration user interface in Akvo RSR by a Superuser administrator, thereby enabling us to add any type of project to the system without having to do any customisation. - -For a detailed technical description of the new [classification syste](http://www.akvo.org/labs/index.php?title=Akvo_RSR_project_classification_system). - -### Filters and sorting for listing pages - -Project and organisation listings now have filters which can be used to search projects or organisations. - -- [Listing of all projects](http://www.akvo.org/rsr/projects/all/) -- [Listing of all organisations](http://www.akvo.org/rsr/organisations/all/) - -The projects listing can filter on continent, country and organisation, through pull-down menus. You can also search for keywords in the project title and subtitle. - -The organisation listing can be searched for short name, long name, or keywords in either. - -Both lists allow sorting on a number of columns as well. The fields which can be sorted have a link on the column name; when sorted this way the project listing displays the direction of the sort. - -### Page view counter - -A number of pages now have page view counters implemented. The counters were introduced in 0.9.18, but haven’t been displayed until now. The counters record how many visits have been made to a particular project. A display of the project page, funding details page or widget counts as a view of the project. Individual Update pages also have a view counter and are counted separately. - -### Widgets available for all - -All widgets except for the Project list widget can now be accessed by any user. The Project list widget requires you have a Plus account. The three new widgets accessible for any users are: - -- Project widget with updates (202 pixels wide by 900 pixels high) -- Project with Donation Link (202 pixels wide by 570 pixels high) -- Small project (170 pixels wide by 312 pixels high) - -### Akvo at a glance - -The Akvo at a glance data, which was shown previously on the home page, has been replaced by the Right now in Akvo.org... . The Akvo at a glance data has been [moved to this place](http://www.akvo.org/rsr/data/overview) This is a temporary holding page for this information and we will be extending the data view pages in the future. - -Minor features -------------------- - -### Add project ID to Project __unicode__ method. - -The __unicode__ method for Project instances should show the Project's ID as well as its name so that individual projects can be easily identified from other objects' admin pages. -[Pivotal story.](https://www.pivotaltracker.com/story/show/5632494) - -Bug fixes ------------- - -### When you sign out of Akvo RSR in Safari you still look like you are signed in -Fixed. [Lighthouse ticket 12](https://akvo.lighthouseapp.com/projects/46515-akvo-rsr/tickets/12) - -### Completed projects do not show on the organisation page in Akvo RSR -Fixed with a new project listing for organisations. [Lighthouse ticket 11](https://akvo.lighthouseapp.com/projects/46515-akvo-rsr/tickets/11) - -### Cancelled project widgets have text "Funding" at bottom. -Widgets for Cancelled projects have gray text "Funding" at bottom below separator where donation box was. This doesn't really seem to serve a purpose; think we can get rid of it entirely. Fixed. [Pivotal story.](https://www.pivotaltracker.com/story/show/5425890) - -### Widgets for projects w/ status Archived should probably not show donation box -Donation boxes show up on these widgets, probably don't want donations coming in to them. Cancelled project widgets also need examining. -Fixed. [Lighthouse ticket 74](https://akvo.lighthouseapp.com/projects/46515-akvo-rsr/tickets/74) - -### Widget machinery pgs for Cancelled projects projects -Go to Cancelled project page, click Get a widget (not signed in, FWIW). Some of the widgets on machinery page display Donate box, some do not; none should display it, as those widgets do not either. -Fixed. [Pivotal story.](https://www.pivotaltracker.com/story/show/5426105) - -### Using back button when selecting widget gives 500 error -Fixed. [Lighthouse ticket 76](https://akvo.lighthouseapp.com/projects/46515/tickets/76) - -Known issues ------------------- -As this is a major new release we have a number of known issues, and we’ll be working on them soon. We released when we didn’t have any more major known bugs, but there are always improvements that can be made. Some of our planned improvements are listed below. You can enter your own suggestions by starting a discussion at: [http://help.akvo.org/](http://help.akvo.org) - -### MiniCMS -The new home page MiniCMS tool will have the following improvements: - -- Map box text isn’t used and will be removed -- Lower section height renamed to Focus areas accordion height -- Name field for instances in the MiniCMS (currently no way to name, although you can have more than one) -- Help text is incomplete - -### Maps - -We are migrating the location data from the old location models to the new location models in a two-step process. This means old location data models and fields will remain in the Akvo RSR admin pages until we have finished the transition. - -We want to create an easy to use longitude/latitude selector for the location. For now you have to enter the decimal longitude and latitude. - -### Organisation page - -People who get, box is only showing water and sanitation Benchmarks. This needs to be extended to show generic benchmarks. - -### Admin page for organisation - -We have duplicate of fields for organisation location as we are moving from the old text fields to the new location model. The old fields will be deprecated (removed) when we are happy all data has migrated and that we have removed all references to the old fields in the templates. - -### Admin page for project - -We have duplication of fields for Benchmarks, Categories and project location, as we are moving from the old fields to new models. The old fields will be deprecated (removed) when we are happy all data has migrated and that we have removed references to the old models in the templates. - -### Old templates - -We are still in a process of removing old templates from the system. A lot has changed and there are a lot of old files which will be removed in a forthcoming release. - -### Wordpress posts on the home page - -There are some issues with certain characters in blog posts on the home page. The character set conversions do not happen as they should. We dug quite deep into this but we have to come back to it later. - ---- - -Akvo RSR v 0.9.19 release notes -------------------------------------------- -4 Oct 2010, (Code name: Magic) bethw - -This release adds a new project status to Akvo RSR, fixes a bug in the donations process and includes a point release update of the Django framework. - -New features ------------- - -### Project Status -A new project status has been added, Archived. Projects set to Archived will no longer appear in Akvo at a Glance figures, project lists or organisation pages. Donations boxes still appear on widgets; this is Lighthouse ticket #74. - -### Django 1.2.3 -Akvo RSR now runs on Django version 1.2.3. The security fix in 1.2.2 caused some problems with which have been remedied in this release. Additionally, to run Akvo RSR, you will want get zzgvh patch here: - -http://github.com/zzgvh/django/tree/1.2.1_patched - -which fixes Django ticket 10046. http://code.djangoproject.com/ticket/10046 - -Bug fixes ------------- - -### Donation emails not being sent. -A code regression prevented donations from proceeding to Complete status. As a result, confirmation emails and funding totals in the Akvo at a Glance portlets were not appropriately updated. This has now been fixed. - ---- - -Akvo RSR v 0.9.18 release notes -------------------------------------------- -6 Aug 2010, (Code name: Supercharge) gvh - -This release introduces page counters in Akvo RSR. We are also updating the version of Django that Akvo RSR runs on to 1.2. - -New features ------------- - -### Page counters -In this first iteration page counters are created for projects, project updates and widgets showing one project. The counters record how many visits to a particular project have been made. However we are still only gathering the page count data for these objects, it is not shown in the interface. This will be added in a later release. - -### Django 1.2 -Akvo RSR now runs on Django version 1.2. The new version of Django required changes to forms handling. The changes should be backwards compatible however and we have not introduced any new features requiring 1.2 yet. - -### Pip requirements -We use pip whenever possible for installing python libaries. We have added scripts/deployment/pip-requirements.txt describing all python components needed to run Akvo RSR. We use this together with virtualenv to set up our environment. While not technically necessary to run Akvo RSR it is warmly recommended. -Note: On Ubuntu you may need developer versions of certain python bindings: we had to - -sudo aptitude install libxml2-dev libxslt-dev libmysqlclient-dev - -to get lxml and MySQL-python to install. Similar upgrades may be needed on other *nixes. - - ---- - -Akvo RSR v 0.9.17 release notes -------------------------------------------- -11 May 2010, (Code name: Bolero) bw - -This release implements a new feature on the Akvo home page whereby selected updates appear as Staff picks. Ongoing work with Walking for Water is also now highlighted on the home page. - -New features ------------- - -### New Staff picks-featured updates on the Akvo home page -The home page now displays 3 of the most recent updates with images. These updates are selected from a pool of updates Akvo has chosen to feature. - -### Walking for Water box now on home page. -Links in this box now provide entry to latest blog entries and projects connected to Walking for Water. - -Bug fixes ------------- - -### Text overflow in widgets under certain types of browsers. -Bugs relating to certain layout issues for widgets in Opera and similar browser have been fixed. - -### Internet Explorer problems on RSR pages -These problems were traced back to the use of Javascript to open the Help & Support link. - -### Reformatting layout on pages with donor names to accommodate longer names. -Long names were breaking oddly. This fix attemptes to address that issue. - ---- - -Akvo RSR v 0.9.16 release notes ------------------------------- -13 April 2010, (Code name: Performance) tbp -This is primarily an initial release of page fragment caching and an Akvo RSR API beta test. - -We also implemented caching for the Akvo blog. While not directly affecting Akvo RSR, this does significantly improve performance of the Akvo home page, which fetches RSS feeds from the Akvo blog. - -New features ------------- - -### Caching - -Caching for page fragments has been implemented in this release. Whole pages cannot be cached, as that type of implementation conflicts with the i18n language machinery in Django: essentially every user would run a separate customised session, and no user would encounter the same cache information as another. We have only implemented caching for certain heavy or higher traffic pages, such as project listings. The cache timeout is 5 minutes: if the last request for a page is more than 5 minutes ago then your request will regenerate it. - -A more detailed discussion about the cache implementation can be found here: http://akvo.org/labs/index.php/Caching_in_RSR - -### Akvo RSR API - beta test - -A beta test of the Akvo RSR API has been released. The API can publish information about projects and updates using either XML or JSON. -Basic information about how the API works can be found in the Akvo Labs wiki. http://www.akvo.org/labs/index.php/Akvo_RSR_API - -Before writing applications using the Akvo RSR API, please read the Code of Conduct. http://www.akvo.org/web/akvo-rsr-api-code-of-conduct - -### Individual donor list - -Individual donors using PayPal or IDEAL to donate money to a project in Akvo RSR are now listed with the amount they donated. If the donor elected to remain anonymous, the donation will be listed as such. An example can be seen here: http://www.akvo.org/rsr/project/64/funding/ - -### Help and Support widget link - -A link to the new Akvo help and support system has been placed on the home page and on all Akvo RSR pages. The link brings up a widget, at the top of the page, with a search tool and discussion starter. The help and support system can be found here: http://help.akvo.org/ - -Bug fixes ------------- - -### Comments broken - -The way we handle URLs for Post forms changed. This meant the old URL for a comment ending "comment" didn't handle the new URL ending "comments/" properly. Fixed through the use of URL tags. - -### Internet Explorer and IDEAL - -Some Internet Explorer users had the Donate button greyed out (inaccessible) due to incorrect loading order of the Javascript guaring against duplicate donations. We disabled the Javascript, as we have protection against double donations through the "stale invoice" feature. - -### Project comments broken -Project comments couldn't be made. The form's action URL has become invalid after a change in urls.py. - ---- - -Akvo RSR v 0.9.15 release notes -------------------------------------------- -5 March 2010, (Code name: Avonmouth) tbp - -Adding one more custom sponsor portal page. The first one was introduced in 0.9.12, this one is for Walking for Water. - -New features ------------- - -### New custom sponsor portal page -Sponsor portal page, a page which is different from the organisation page, but has branding and a project list related to the sponsor - -The new sponsor functionality is possible to enable or disable in the settings.py file, as well as identifying with organisation number is the sponsor partner which the features will be linked to. This is still considered experimental and we want to generalise this feature so you can set up these type of portals from the admin user interface. -http://www.pivotaltracker.com/story/show/2396373 - -### README.md -Added a README.md file which displays nicely on the project page on Github. - ---- - -Akvo RSR v 0.9.14 release notes -------------------------------------------- -29 January 2010, (Code name: Firebrand) pb - -This release introduces support for donations via the iDEAL payment system for users in the Netherlands as well as a number of architectural changes. - -New features ------------- - -### iDEAL payment system -The donation subsystem has been extended to support donations via the Dutch iDEAL online payment system. Akvo RSR provides this functionality by interfacing with the APIs provided by [Mollie.nl](http://www.mollie.nl/). - -### Code namespace changes -Providing an additional payment system resulted in a fair number of architectural changes behind the scenes. - -### Move to virtual Python environment -Akvo RSR is now installed into and run from a Python virtual environment (or "virtualenv") separate from the system Python installation. This is achieved using the tools [pip](http://pypi.python.org/pypi/pip/) and [virtualenv](http://pypi.python.org/pypi/virtualenv/). The advantages of this pip/virtualenv setup are increased deployment flexibility and standardisation of software requirements for each release. - -### "All updates" RSS Feed -An RSS feed for updates from all Akvo projects has been set up at http://www.akvo.org/rsr/rss/all-updates. Further RSS features are in the works. - -### Image thumbnails refactor. -Further refinements have been made to the way RSR handles the various image types (project, update, organisation logos, maps), creating appropriately-sized thumbnails, and cases where images do not exist. - -### HTTP Referrer -Support for capturing HTTP referrer information has been added to parts of RSR for use in future planned RSR reporting tools. - -### Admin help text -Further improvements to help text in the RSR Administration tools for organisations. - ---- - -Akvo RSR v 0.9.13 release notes ------------------------------- -2 November 2009, (Code name: Anakim) kad - -This is primarily a bug fix release, and some minor new features. - -New features ------------- - -### Partners entry on sitewide toolbar -Added a "Partners" entry to the toolbar (site wide). Linked the "Partners" entry to -/web/partners -http://www.pivotaltracker.com/story/show/1321046 - -### The top akvo logo is a link to the front page -it now links to the front page from all subsystems. -http://www.pivotaltracker.com/story/show/1289374 - -### Replaced the main Akvo logo -The logo now have the new tagline "See it happen" -http://www.pivotaltracker.com/story/show/1543983 - -### Changed the page title on the front page to "Akvo.org - See it happen" -Updated with our new tagline. -http://www.pivotaltracker.com/story/show/1579950 - -### Add Management costs to Funding budget item -Added 'Management cost' to the Budget item ITEM_CHOICES tuple. -http://www.pivotaltracker.com/story/show/1407959 - -### The version of Django that is running is visible in the source -One can now in the front page source see which version of Django that is runnig. e.g. "«!-- -Akvo RSR runs on Django, version: Django/1.1.1 (http://www.djangoproject.com) --»". -http://www.pivotaltracker.com/story/show/1464719 - -### Humanised funding boxes. -Currently only the funding aggregates are humanised. This needs to be extended across the -system to all areas where currency amounts are displayed. -http://www.pivotaltracker.com/story/show/1469524 - -### Organisation project count needed cancelled projects -In the organisation activities the projects count does now have a line for cancelled -projects making for an non incorrect sum if the org is associated with a cancelled project. -http://www.pivotaltracker.com/story/show/817414 - -### Organisation listing widget for internal use -Created an "Organisation listing" widget for internal use only. This widget is used on the -Partners page in Drupal. -http://www.pivotaltracker.com/story/show/1321040 - -### Moved the page tools up on the partner pages -To make the get a widget link more apparent, we moved the page tools section up. -http://www.pivotaltracker.com/story/show/1543990 - -### Script cleaning out old images -The script removes old images from Organisation, Project and ProjectUpdate and renames any -that haven't been renamed properly. (See also bug -http://www.pivotaltracker.com/story/show/1510571) -http://www.pivotaltracker.com/story/show/1510576 - -### void_invoice() view function needs conditional redirect. -The void_invoice() view function now have the keyword redirect=False set in its signature -which is then used to determine where it will redirect to. -http://www.pivotaltracker.com/story/show/1458419 - -### Hide "Action" menu in user list for Organisation admins -As they couldn't delete users anyway. -http://www.pivotaltracker.com/story/show/616357 - -### User attribute on UserProfile is now a OneToOneField. -Changed the relationship between the UserProfile and User models. (No visible change) -http://www.pivotaltracker.com/story/show/1480363 - - -Bug fixes ------------- -### Donation page displayed error message while loading -Switched from using JavaScript's hide function to use the "noscript" tag for warning about -no javascript. -http://www.pivotaltracker.com/story/show/1448535 - -### Removed debug info when in production mode. -The debug info about context and sql queries was showned at the bottom of the source in all -RSR pages. This should only be visible when settings.DEBUG == True. -http://www.pivotaltracker.com/story/show/1468582 - -### Own org could be deleted from project -A non-super-user could sneak past the checks that their own org is among the partners when -saving a project. This is accomplished by checking the delete check-box for the own org in -the partner inline form. -http://www.pivotaltracker.com/story/show/1424820 - -### Uploaded images didn't get renamed -When uploading an image to an existing project or organisation the renaming of the image -didn't work. This was because of a change in how sorl.thumbnail handles images. -http://www.pivotaltracker.com/story/show/1510571 - -### Prevented display of funding amounts less than 0 in templates. -Over-funded projects could result in the round filter displaying very confusing amounts such -as "€-0". -http://www.pivotaltracker.com/story/show/1493650 - -### Pledged sum in Org activities wrong with certain data -The calculation for how much a certain organisation has pledged totally was wrong when there -are mutliple projects to which the same amount has been pledged. -http://www.pivotaltracker.com/story/show/1460695 - -### Saving userprofile may lock out user from admin -When a UserProfile is saved the staff status is set to false if neither org admin or org -project editor is true. This could lead to the possible lock out even if you are superuser. -http://www.pivotaltracker.com/story/show/1469655 - -### In Akvo at a glance change Partners link to Project Partners -Direct link to the right page. -http://www.pivotaltracker.com/story/show/1573608 - -### The breadcrum entry "home" at the blog pointed to "#" -The home link is pointing at "http://www.akvo.org/blog/", and not "#" -http://www.pivotaltracker.com/story/show/822234 - -### Learn about Akvo link broken on sign-in page -The 'Learn about' how Akvo works link was broken on the sign-in page: -http://www.akvo.org/rsr/signin/?next=/rsr/projects/ -http://www.pivotaltracker.com/story/show/1514408 - -### Proj.update/access denied page didn't give you a way back to the project page -Now get's linked to the current project page. -http://www.pivotaltracker.com/story/show/1229436 - -### Cancelled projects had the wrong donation text -Cancelled projects still would say that you could fund them. -http://www.pivotaltracker.com/story/show/1528542 - -### Cancel update on a project sends you back to top level RSR page -Cancel update on a project would send you back to top level RSR page instead of back to the -project detail page. https://bugs.launchpad.net/akvo.rsr/+bug/315228 -http://www.pivotaltracker.com/story/show/1229429 - -### Sign in routine should not send you back to the completed registration page -Signing in from the completed registration page will send you to the front page. (lp: -315146) -http://www.pivotaltracker.com/story/show/1229422 - -### Set height and width to every image when using sorl -If a photo can't be loaded it should still occupy the same space. This is not true for logos -and other non photo sized images. -http://www.pivotaltracker.com/story/show/1467668 - - ---- - - -Akvo RSR v 0.9.12 release notes ------------------------------- -12 October 2009, (Code name: Basalt) tbp - - -New features ------------- -### Addition of comprehensive help text in Akvo RSR admin -The add/modify project and organisation form in the Akvo RSR admin packs in a lot of information. Many of the fields are required and must be entered correctly. To make this form more usable, we added detailed and clear plain-English help text to guide partners through what is required of them. - -### Updated JQuery to 1.3.2 -We now use the JQuery framework 1.3.2. - -### New small widget for Plus customers -A new "minimal" small widget has been created. With only project title, picture and location information. If you are using the Akvo.org services you have to have a Plus account (have an contract with Akvo Foundation) to get access to this new widget. - -### Listing of projects in other currencies -One can now list projects in other currencies than Euros. To be able to do this one needs to do the following: - -1. For other currencies than Euro and US Dollar, you need to modify CURRENCY_CHOICES in models.py. -2. Create a new PayPal gateway. This can only be done by Superusers in the system. The new admin form for this is called "Paypal gateways". -3. In the admin form "Project PayPal gateway configurations" you can select which donation gateway a selected project should use. This functionallity is only available to the Superuser of the system. - -We have special code on the donation pages which displays different information based on which currency you have selected. This needs to be abstracted and entered into some admin forms for easier configuration. To change this you currently have to modify the donation templates. - -The currency display ripples through the whole system including displaying multiple currencies in organisation listings, as well as the "Akvo at a glance" portlets, the "Organisation activities" portlet on the organisation page and the Sponsor portlet on the new Sponsor portal page. We updated how currencies are being displayed as well, for better readability. This work still needs another pass as we didn't have time to do it everywhere yet. - -Read more about the [Akvo RSR support for multiple currencies](http://www.akvo.org/labs/index.php?title=Akvo_RSR_support_for_multiple_currencies). - -### Added column in the admin view "Project PayPal gateway configurations" to display settings -This PayPal account a particular projects donations are linked to is important to know, without having to go into every project to see it. This is the one way money gets transferred through your system from donors to PayPal accounts, so you need to be able to see what they are set as. - -### Adding prototype sponsor features -In 0.9.7 we added a new type of partner, a sponsor partner. We are testing some new features for the sponsor partner type with this release. We are expecting these features to be fleshed out in one form or another with subsequent releases. These features are only applicable to one specific sponsor for now: - -* Sponsor portal page, a page which is different from the organisation page, but has branding and a project list related to the sponsor -* Sponsor branding on the organisation page which has a link to the sponsor portal page -* Sponsor branding on donation pages which has a link ot the sponsor portal page -* Home page Sponsor box, which has a link to the Sponsor portal page and links to articles in the blog - -The new sponsor functionality is possible to enable or disable in the settings.py file, as well as identifying with organisation number is the sponsor partner which the features will be linked to. This will be updated in the next few releases and should be considered experimental. - -### Added a link to updater's organisation in updates -In an update on the projects page you can now see which organisation the account which performed the update belongs to. The name of the organisation is displayed as the short name and has a link to the organisation page. - -Bug fixes ------------- -### "Hover" text (img title) not appearing over Focus area graphics on Organisation listing page -[Launchpad bug reference 319407](https://bugs.launchpad.net/akvo.rsr/+bug/319407) -[Pivotal story](http://www.pivotaltracker.com/story/show/1229439) - -### Partners' listings breadcrumb trail doesn't lead back to Organisation Listing -[Launchpad bug reference 304679](https://bugs.launchpad.net/akvo.rsr/+bug/304679) -[Pivotal story](http://www.pivotaltracker.com/story/show/1289389) - -### Sponsor attribution use wrong words in Widget, 2+ display -[Pivotal story](http://www.pivotaltracker.com/story/show/1321398) - -### Donation template should not allow donations if a project is fully funded -One could manually go to the donation URL. The user will now be redirected to the project page. -[Pivotal story](http://www.pivotaltracker.com/story/show/1322025) - -### Image on donation page is not "sorled" -The project current image is not run through thumbnailing with sorl on the donation page, it is just a scaled original. -[Pivotal story](http://www.pivotaltracker.com/story/show/1453502) - -### Change text 'On hold' to 'Need funding' in Akvo at a Glance and Organisation detail page -'On hold' is misleading and should be changed to 'Need funding'. We had no projects on hold and there isn't even a status called on hold (anymore). Se Need funding was a better description. -[Pivotal story](http://www.pivotaltracker.com/story/show/1453017) - -### Clicking Cancel in donation templates should immediately void an invoice -When the user clicks on "Cancel", a new URL is called which triggers a view function which voids the invoice and redirects the user to the project's detail page, thus freeing up that sum of money so it can be donated again. -[Pivotal story](http://www.pivotaltracker.com/story/show/1226213) - -### Purpose of 'Back' button in PayPal checkout template is not clear and produces strange results -Workaround for now is to make 'Back' do the same as 'Cancel'. -[Pivotal story](http://www.pivotaltracker.com/story/show/1458080) - -### Funding partner logo too large on funding detail page -In the funding detail page the logo for the funding organisation does not seem to get scaled down. Logos now passed through sorl-thumbnail and scaled to no more than 140x140. -[Pivotal story](http://www.pivotaltracker.com/story/show/823749) - ---- - - -Akvo RSR v 0.9.11 release notes ------------------------------- -14 September 2009, (Code name: Jupiter) PB - -New features ------------- -### Decimalisation of financial data -All financial data in Akvo RSR is now stored in decimal format. Previously it was stored in integer (whole number) format. This transition was necessary to allow for accurate calculation and output of financial data in the system. - -### Reconciliation of PayPal donations -All individual donations made to projects in Akvo RSR are subject to processing fees applied by PayPal. Although Akvo RSR has always stored these fees, we were not able to apply them to our own financial data until the system was decimalised. We are now able to store the final amounts received from PayPal with cent accuracy. - -### PayPal gateway selection and multi-currency support -Currently all individual donations are sent to the Akvo PayPal account. As from this release, it is possible for a partner to request that Akvo staff override this behaviour on a project-by-project basis and define a new "gateway" (PayPal store) to direct payments to. Note: this is only done in exceptional cases at this point. PayPal gateways also contain locale and currency information meaning that we will be able to handle donations to a particular project in an alternative currency in the future. - -### Various enhancements to the PayPal donation engine -Several smaller enhancements have been made to the Akvo RSR PayPal engine: - -* The find_stale_invoices.py cron script now logs detailed information for each invoice operated on -* The PayPal-specific settings in settings.py have been simplified -* The view code which handles the donation process has been simplified - -Detailed technical information about these new features and enhancements can be found on [Akvo Labs](http://www.akvo.org/labs/index.php/Akvo_PayPal_Under_the_Hood) - -Bugs ----- -In one particular template, the message "Fully funded" did not appear when a project had reached its funding target. This has been fixed. - -When a user attempted to donate a negative integer amount (for example "-10") to a project, the error message produced was misleading, asking her to donate an amount "greater then or equal to 0". Since it is not possible to donate 0 to a project, this message now asks the user to donate an amount "greater than or equal to 1". - ---- - - -Akvo RSR v 0.9.10 release notes ------------------------------- -1 September 2009, (Code name: Avalanche) GvH - -This is a small release featuring new widgets - -New features ------------- -### Co-branded widgets -The widget gallery has been considerably expanded with designs promoting the various partners for the projects and having new formats for use both horizontally and vertically on the host page. - ---- - -Akvo RSR v 0.9.9 release notes ------------------------------- -7 July 2009, (Code name: Torch) tbp - -New features ------------- -### New style to organisation activity box/portlet -When viewing an organisation page in Akvo RSR, a portlet to the right of the page displays how many projects the organisation is involved in, which partners it works with, etc. The presentation of this has been updated to correspond with presentation changes made in 0.9.7 to the "Akvo at a glance" portlet. - -### Akvo PayPal integration documentation -We have some initial [documentation for the Akvo PayPal integration](http://www.akvo.org/labs/index.php/Akvo_PayPal_integration_overview) - -Bugs ----- -It is now no longer possible to donate to a cancelled project. The project remains visible in Akvo, but the donation box is no longer displayed. -Internal reference: http://www.pivotaltracker.com/story/show/745352 - -Sponsor partners no longer have the "state" attribute displayed in the partner portlet on a project page. The sponsor partner information displayed there now matches that of other partner types. -Internal reference: http://www.pivotaltracker.com/story/show/782930 - ---- - -Akvo RSR v 0.9.8 release notes ------------------------------- -25 June 2009, (Code name: Utah) pb - -New features ------------- -### PayPal Enhancements -A number of improvements have been made to the PayPal donation subsystem of RSR. - -### More states for PayPal invoices -In previous releases, a PayPal invoice could be in one of two states: complete or incomplete. In this release, an invoice can be in one of four states: pending, void, complete or stale. This allows for more granular control over invoices and results in more accurate funding totals in the system. - -### Cron script to mark stale PayPal invoices -Stale invoices are identified and marked as such by a new script which can be run manually or from the system cron daemon (recommended). This script is designed to find invoices in the system which have been pending for longer than a given, configurable period of time, allowing them to be easily identified and operated on in the admin interface. For more information about this script, see http://akvo.org/labs/index.php/PayPal_Overview#Invoice_Management - -### User interface to void PayPal invoices -Batches of invoices can now be selected and operated on. This feature was designed to allow for easy manual voiding of batches of invoices which have been automatically marked as stale or that are pending and never likely to be completed. It will not allow invoices to be voided if they are either complete or already void. If the administrator attempts the latter, she will receive a warning message and a reason for each invoice in turn and no further action will be taken. - -### Display of funding of projects -Funding calculations displayed in the Akvo Marketplace donation box now only take completed invoices into account. Pending invoices are also included in the calculation when a user is about to make a donation to avoid conflicting messages if a project is close to being fully funded. - - -Bugs ----- -Donations did not show immediately when a PayPal donation was being made. This bug was a result of the changes which were made to the donation calculations in 0.9.7. -Internal reference: http://www.pivotaltracker.com/story/show/785964 - ---- - -Akvo RSR v 0.9.7 release notes ------------------------------- -10 June 2009, (Code name: Omaha) eaw - -Required software changes -------------------------- -**New required software: django-10766** -We have upgraded the version of Django which we use to rev. 10766. Our project budget code makes use of some admin features fixed in this Django version. - -New features ------------- -### New narrower "Project widget with donation" -A new widget with the same information as the previous tall "Project widget with donation" has been added. The new widget is narrower (172 pixels) wide, compared to its sister (202 pixels). Both widgets take up a maximum of 840 pixels vertically. Each may actually take up less, depending on the content of the project being displayed. - -Both widgets are freely available for anyone to use. - -### Individual funder contribution displayed -The total amount of contributions from individual funders' (donors via Paypal) contribution is now listed under the funders portlet on the project page and on the funding details page. - -### Updated Akvo at a glance -The "Akvo at a glance" portlet on the Akvo home page and the projects listing page has been updated. Its simplified layout now shows correctly how many projects have been completed and how many people have water and sanitation as a result. Akvo at a glance now also includes the individual donations in the way it calculates funding for a project. The code has been restructured to make it easier to extend later. Bugs fixed: Launchpad #279243. - -### Favicon -A favicon.ico has been added to all Akvo RSR pages. - -### Project budgets -The project budget terminology has been updated to more accurately match its use. Previously this was called "Funding breakdown," but it really is designed to be a project budget. - -The way the budget data is stored and manipulated has changed as well. Before we had a Django Funding model (i.e. database table); the model has been renamed BudgetItem. The date information (i.e. Date request posted, Date complete) has moved to the Project model; the money information is now stored in the BudgetItem model, and consists of one or more BudgetItem objects (records) instead of multiple columns. - -### Sponsor partner type -A new type of partner is now available. Sponsor partners, if one exists for a particular project, appear at the bottom of the partner portlet. This indicates functionality currently in the pipeline. More soon. - -### Featured projects -The projects featured on the projects listing page and on the Akvo.org home page now only show projects which need money. For the Akvo.org listing, this is only done if there are a minimum of 8 projects with outstanding funding requests. - -Bugs ----- -### Error message style sheet -404 and 500 http errors did not have style sheets; now they do. - -### Funding table alignment -The funding table at the organisation page had a alignment bug making the sums pushed down a couple of pixels. This is now fixed. - -### Project updates widget is too large for the iframe -A new smart_truncate Django filter is used to increase control over text lengths in the widgets. Since text length is a general problem with widgets, we updated all widgets to use the new filter. Small changes have also been made around the Akvo reference number for better Internet Explorer compatibility. Filter by Adam & bobince (http://stackoverflow.com/questions/250357/smart-truncate-in-python). - -### Akvo at a glance -The updates to Akvo at a glance (described above) fix Launchpad bug #279243. - - -Miscellaneous -------------- -### Donation page simplified -The donation page had a "Sign in" link for people with an Akvo RSR account. This has been removed, as it proved confusing; the 10 seconds saved by users with Akvo RSR accounts was not worth the confusion it caused. -Akvo RSR v 0.9.6 release notes ------------------------------- - -v0.9.6, 27 April 2009, (Code name: Sword) tbp - -**New required software: django-10553** -We have upgraded the version of Django which we use to rev. 10553. There are some features in Django which has changed and will break Akvo RSR if you don't update to this version. - -New features ------------- -### New user roles -Two new user roles have been introduced: organisation project editor and organisation administrator - -An organisation administrator can do the following: - -* Create new projects -* Edit projects -* Edit the organisation page -* Activate new users attached to the organisation -* Promote new users to be project editor or organisation administrator -* Add countries to the country list - -The organisation administrator get an email each time a new user signs up for an Akvo RSR account and selects the organisation administrator's organisation. In this email there is a clickable link directly to the user profile for the new user, where the user can be activated. - -An organisation editor can do the following: - -* Edit projects -* Add countries to the country list - -Documentation about how to use the new features can be found in the Akvo Labs Wiki: [Akvo HOWTOs](http://www.akvo.org/labs/index.php/Akvo_HOWTOs) - -Miscellaneous -------------- -### New home page layout -We have added a new box on the home page: Learn about Akvo. - -### Updated Dutch translation -The Dutch translation has been updated with some changes to the use of language. - -### Release notes -We are now coding the release notes in [markdown](http://daringfireball.net/projects/markdown/), to make it easier to convert to an HTML page, as well as read in the raw text format. - ---- - -Akvo RSR v 0.9.5 release notes ------------------------------- -v0.9.5, 20 April 2009, (Code name: Juno) tbp - -**New required software: sorl-thumbnail.** -For the image handling integration you now need the following software:[sorl-thumbnail](http://code.google.com/p/sorl-thumbnail/) - -New features ------------- -### Akvo RSR image upload improvements -When uploading images to the Akvo RSR system there are now a number of improvements to how the system handle images. - -1. Images are scaled to the appropriate size the first time they are viewed. This is done via the sorl-thumbnail toolkit. -2. Images are now renamed according to the use in the system. The naming is based on ModelName_instance.pk_FieldName_YYYY-MM-DD_HH.MM.SS.ext. Example: a map image uploaded to project no 17 gets the name Project_17_map_2009-04-17_12.13.14.jpg. -3. Images are stored in the subdirectory related to the project and the update. /var/www/akvo/db/project/NN/update/MM - -### Akvo RSR admin link -A link to the administration login can now be found on the footer of the page "Admin". (Note, that if you are on the non-RSR pages of the Akvo.org site, the Admin link leads to the Drupal system admin pages.) - -Bugs ----- -Fixed two bugs where the maxlength attribute was missing on the input field for `photo_credit` and `photo_caption`. - -Limitations ------------ -See comments about limitations in the PayPal integration under release notes for 0.9.3. - ----- - -Akvo RSR v 0.9.4 release notes ------------------------------- -v0.9.4, 15 March 2009, tbp - -New features ------------- -Added Dutch and German translations of Akvo RSR user interface for Widgets and Paypal donations. (Thanks Anke and Malte!) - -Bugs ----- -Fixed a bug where featured projects were not shown when looking at a project list from a specific organisation. - ----- - -Akvo RSR v 0.9.3 release notes ------------------------------- -v0.9.3, 12 March 2009, tbp - -**New required software: django-paypal.** -For the PayPal integration you now need the following software:[django-paypal](http://github.com/johnboxall/django-paypal/) - -New features ------------- -### Akvo RSR Widgets user interface -There is now a user interface to select and customize widgets. The tool can be found under Page tools on each project page. The widgets can be placed on any web site to promote a particular project or highlight progress. - -### Akvo RSR delegated project and user administration beta -We have started creating the ability for project owners to edit their own project descriptions and manage their own users. The tools are fairly basic so far, but it is a start. - -### Akvo Direct PayPal integration, using django-paypal -Support added for making donations to projects via PayPal Standard. Instances of a new PayPalInvoice class are created which capture details of the payment and track it all the way through to PayPal and back again. Invoices are "completed" and the end user is sent a confirmation email on receipt of a confirmation callback from PayPal. - -Behaviour of PayPal donations can be defined by several environment variables in settings.py, making it straightforward to select currency, PayPal command flow, specify custom PayPal buttons and switch between sandbox settings for testing and production settings. - -Limitations in PayPal integration ----------------------------------- -There are a couple of limitations with the PayPal integration at this point. - -### Donation committments -When performing a donation we committ a portion of the funding the project needs, to ensure that the project isn't overfunded. We currently have no routines to take down "stale" donations, i.e. donations which were never completed. This is a priority set of routines which will be created as soon as possible. - -### PayPal charges -Project funding is currently done as integers. This will have to change, as when donations come in from PayPal a certain percentage of the donation has been deducted from the donation. This very seldom is a whole number. We don't deduct this at this point from the project, which means that the project will always be short of some funds if donations have been made to it. This is a fairly large thing to fix, so due to deadlines we have punted this for a later release. Each transaction that is completed has a record of how much PayPal charged, so we can fix the accounting later. - - -Infrastructure --------------- -The way funding of a project was calculated has been changed. We have included the donations into the funding. - -Bugs ----- -Fixed a bug in the project-list widget. When you sorted on anything else than project name it was impossible to resort on project name. - ----- - -Akvo RSR v 0.9.2 release notes ------------------------------- -v0.9.2, 13 February 2009, tbp - -New feature ------------ -### Akvo RSR Widgets -Beta-release of the Akvo RSR Widget backend. This allows you to post iFrame based widgets of projects and project listings. A user interface should be added to the next release. - ----- - -Akvo RSR v 0.9.1 release notes ------------------------------- -v0.9.1, 6 February 2009, bw - -New features ------------- -### Django framework upgrade. -This version of Akvo RSR uses the latest Django framework, version 1.0.x. The new form-handling library, django.forms, was designed with extensibility and customization in mind, and will permit us to more quickly and easily develop RSR's administration user interface. To read more about Django 1.0.x please see: -http://docs.djangoproject.com/en/dev/releases/1.0/ - -Parts of RSR have been rewritten to accomodate the frameworks upgrade. RSR should not look or behave any differently than it did in 0.90. If you experience anything new, please let us know so we can address problems! - -### Internationalization -Dutch translation files have been added. A big thanks to our Dutch translator, Anke van Lenteren, for helping us as we work out our translation process. - -### Miscellaneous -The wording of some text and error messages has been changed in the interest of greater clarity (and proper English). There are also some minor tweaks to style sheets to fix display glitches and layout irregularities across browsers. - ----- - -Akvo RSR v 0.9 release notes ----------------------------- -v0.9, 8 January 2009, tbp - -New features ------------- -### First public release -This is the first public release of Akvo RSR. - -### Internationalization for the user interface. -We have tagged all the user interface text, so that the Django translation engine can pick up the text strings and produce a translation file. While the interface is translated, some emails from the system remain in English; these will be fixed in a later release. We have tested the implementation with one initial language, German. You can participate and help translate the Akvo RSR user interface to your language by downloading the translation files from: https://translations.launchpad.net/akvo.rsr - -### Licensing -Inserted the GNU AGPL license in the distribution and tagged all the files with license information. - -### Akvo at a glance portlet -Field partners, Support partners and Funding partners are now linked to a listing showing only those partners (the feature existed before, but there were no links to it). - -### Project updates -Projects with no updates now have an RSS icon and a link (previously you had to wait for the first update for the icon and link to show up). So you can subscribe with an RSS reader to projects which have not been updated yet. - -Bugs ----- -We have changed how funders contributions are displayed in the Organisation activities portlet. Now only the funders proportion of a project is displayed (Bug 269400). - -Highlights of bugs fixed ------------------------- - -296702 Remove MDG count terminology Medium Fix Released -274658 Photos in Project Update have no default placement, so do not show up. Medium Fix Released -269400 Portlet: "Organisation activities" shows easy to miss-understand Funding pledged Medium Fix Released -269402 Organisation description box do not use line breaks. Medium Fix Released -274099 Partner types (example: funding partner) should be link to the URL which lists them Low Fix Released -279243 Actual number in Akvo at a glance portlet gives ugly linebreak Wishlist Fix Released -292932 Describe in user interface that user names are case-sensitive. Wishlist Fix Released - -A detailed list (including in process development bugs) can be found at: http://snurl.com/9lqvk - - -====END OF RELEASE NOTES==== diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 5b81e87898..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,8 +0,0 @@ -We have moved our documentation to the Wiki section of this repository. - -You can go to https://github.com/akvo/akvo-rsr/wiki - -Or you can hit this big red button! - - -[ ![Big Red Button](https://raw.githubusercontent.com/wiki/akvo/akvo-rsr/images/bigredbutton.jpg "Big Red Button") ](https://github.com/akvo/akvo-rsr/wiki "RSR Github Wiki") \ No newline at end of file diff --git a/scripts/devhelpers/setup_etc_hosts.sh b/scripts/devhelpers/setup_etc_hosts.sh index 61edfe3eae..67be07456e 100755 --- a/scripts/devhelpers/setup_etc_hosts.sh +++ b/scripts/devhelpers/setup_etc_hosts.sh @@ -1,3 +1,3 @@ #!/bin/bash -echo "Hello. This script will edit /etc/hosts and therefore requires your administrator password." +echo "This script will edit /etc/hosts and therefore requires your administrator password." sudo bash -c 'echo "192.168.50.101 rsr.localdev.akvo.org # localdev_rsr" >> /etc/hosts' diff --git a/setup/dev/dev_env_setup_for_osx.markdown b/setup/dev/dev_env_setup_for_osx.markdown deleted file mode 100644 index 5fcdeafec6..0000000000 --- a/setup/dev/dev_env_setup_for_osx.markdown +++ /dev/null @@ -1 +0,0 @@ -See the [Akvo RSR developer guide](https://github.com/akvo/akvo-rsr/wiki/Akvo-RSR-developer-guide)