benbalter / feedback

Ask @benbalter anything!
6 stars 3 forks source link

how to deal with metadata and how to style a portal #3

Closed bartvde closed 10 years ago

bartvde commented 10 years ago

I really like the approach for local government data such as https://github.com/benbalter/dc-maps.

It does a great job at visualising and providing the data, but how can people find out about the metadata of the dataset, such as the point of contact, update frequency etc.

I thought about putting an html file next to the dataset with the metadata, but maybe there are better ways to do this that I am missing.

Also, is there a way to style the standard github page into a more broad style a local government might be using on their website already? Or is it just a matter of embedding as e.g. an iframe?

Also, would be great to have some docs on how to query / filter the data if this is possible.

cc @dutchspring

benbalter commented 10 years ago

Great questions.

I thought about putting an html file next to the dataset with the metadata, but maybe there are better ways to do this that I am missing.

The best way to do that would be to add a markdown file along side the data, which will be automatically rendered into HTML. You can see the example on the DC Maps repo, https://github.com/benbalter/dc-maps/blob/master/README.md, and some more infromation on markdown at https://help.github.com/articles/github-flavored-markdown.

Also, is there a way to style the standard github page into a more broad style a local government might be using on their website already? Or is it just a matter of embedding as e.g. an iframe?

You can embed maps elsewhere, and fully style it. You can also you GitHub pages to host a custom HTML site and embed the map there.

Also, would be great to have some docs on how to query / filter the data if this is possible.

That's not possible right now through GitHub.com, although you could use the GitHub API to grab the geoJSON since it's an open format, and filter it client side through something like Leaflet.