datahubio / datahub-v2-pm

Project management (issues only)
8 stars 2 forks source link

Meta data in a `flow.yaml` #100

Closed AcckiyGerman closed 6 years ago

AcckiyGerman commented 6 years ago

As a user I want to describe my data with minimal efforts.

Acceptance criteria

Analysis

When user automates a dataset he should create .datahub/flow.yaml file, which has a meta section:

meta:
  dataset: gdp
  findability: public

but also user should create a .datahub/datapackage.json file and put some metadata there as well, otherwise description will not appear on the datahub page after processing.

{
  "name": "gdp",
  "title": "Country, Regional and ...",
  "description": "Country, regional and ...",
  "readme": "Country, regional and ...",
  "license": "PDDL-1.0",

This doubling is obviously redundant and confusing.

Before we used .datahub/datapackage.json to define the resource schema, but now it could be done in the flow.yaml file, or auto-inferred from the remote source: https://github.com/datahq/datahub-client/issues/10

zelima commented 6 years ago

WONTIFX it's just a small effort from user's perspective and quite big refactors.