openaddresses / openaddresses-ops

Issues-only repo for discussion of operational considerations for OA
6 stars 5 forks source link

Rename "attribution name" #18

Open nvkelso opened 7 years ago

nvkelso commented 7 years ago

In sources like ch/basel-stadt.json:

We state that the source needs attribution, and provide the recommended credit text with a confusingly named property called "attribution name":

        "attribution": true,
        "attribution name": "Geodaten Kanton Basel-Stadt",

This config was originally added in https://github.com/openaddresses/openaddresses-ops/issues/7.

I propose we renamed "attribution name" to something like "attribution-text" to remove the space and make it clearer that the this is the text the source requires (not just the proper name of the source). Because the recommended text is sometimes crazy long, doesn't fit in constrained layouts it's probably also useful to specify the source name in a clean way with something like source-name.

        "attribution": true,
        "attribution-text": "Geodaten Kanton Basel-Stadt",
        "source-name": "Kanton Basel-Stadt",

Referencing http://www.geo.bs.ch/geodaten/nutzungsbedingungen.html where they indicate the required CC-BY attribution text is Geodaten Kanton Basel-Stadt.

Sources with the older "attribution name" syntax should be upgraded either with this issue or with a followup issue in openaddresses/openaddresses.

There are also cases where attribution (required) might be legally false, but we'd still fill in "attribution-text" &/or "source-name" as a curtesy.

nvkelso commented 7 years ago

/cc @migurski

migurski commented 7 years ago

I like this proposal.