This document outlines the roadmap for the Freshness project.
Q4
...
2018
1. Dev Team: CKAN API change to allow rapid touching of datasets
Since it was proposed that freshness directly alter the HDX CKAN instance data, it needs a way to touch resources. Currently touching resources using resource_patch is very slow. A new method of fixing of resource_patch is needed. Jira Legacy server System JIRA serverId efab48d4-6578-3042-917a-8174481cd056 key HDX-5579
2.
...
Look at datasets for which an overdue email has been sent and which ones have a subsequent update and compare with period prior to the time emails were sent. This will give us a rough estimate of the impact of the overdue emails. See Number of Dataset Updates before and after introduction of Overdue email.
...
CJ, Dev Team: Establish Mixpanel measures for freshness
Create events and funnel created in MixPanel for tracking use of freshness workflow.
...
3. Design, Dev Team: Expose per-dataset freshness info and tools to users via interface
Design The design and implement implementation of an indication of freshness in the HDX interface (and api). Key decisions:
- Terminology. We have to be careful what we mean by fresh or up to date. Do we refer simply to the data being the latest available or does it matter if the data is the latest available but from a long time ago. Currently we say that something that never updates is always fresh but would fresh also mean recent to users?
...
has been done but further improvements could be made.
- Freshness in the API
- Sorting and/or filtering by freshness?
- Add a "Make Fresh" button for data contributors? If we do this, we may want to implement as an api call so that contributors could click a link in the overdue email to have the same effect.
- Related to this is this old Jira about making revision_last_updated visible in the UI
.Jira Legacy server JIRA (humanitarian.atlassian.net) serverId efab48d4-6578-3042-917a-8174481cd056 key HDX-4894
5. Data Partnerships Team: Define freshness workflow for handling delinquent datasets and ones with broken urls
What is the policy for dealing with delinquent datasets? What tools are needed to support DP team's work, such as:
- a freshness dashboard listing delinquent datasets and tracking contacts
- an overall freshness metric(s) so we can monitor freshness as an OKR (% fresh, % overdue, % delinquent)
- creating issues directly in Zoho
6. Mike: Implement emailer for broken urls
Construct SQL queries and write Python code for emailer of broken urls.
...
4. Serban/Mike: Implement back up of freshness database
The freshness database needs to be backed up to another server in case of failure.
T1
...
2019
5. Test and adjust freshness process
See Test and Adjust Freshness Process
6. Expose high level freshness metrics to HDX users
Consider exposing:
- Overall HDX Freshness. "HDX is 73% fresh today"
- Per-org Freshness. We could show an overall metric for an org to all users or just to org members.
...