Idea by @mpopov: Automatically generate a README in the output directory based on info in the configuration yaml. Maybe the reportupdater config could have a README option if the user wants to override the default.
Description
Description
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Declined | None | T193167 reportupdater TLC | |||
| Declined | None | T163134 Reportupdater writes a README in the output folder |
Event Timeline
Comment Actions
I'd also recommend adding a "description" field that each report can have. Our config YAMLs have those (e.g. https://github.com/wikimedia/wikimedia-discovery-golden/blob/master/modules/metrics/external_traffic/config.yaml) and it's super useful for generating https://datasets.wikimedia.org/aggregate-datasets/discovery/README.md:
Discovery Datasets
These files are generated by Discovery's Golden data retrieval codebase that executes daily and uses Reportupdater infrastructure. These datasets provide the metrics that are used by Discovery's Dashboards
Last updated on 17 April 2017
external_traffic/
- referer_data.tsv: Pageviews broken down by referrer class (e.g. internal vs external) and search engine
- referer_nonbot_data.tsv: User-made pageviews broken down by referrer class (e.g. internal vs external) and search engine
…