{"action":"created","issue":{"url":"https://api.github.com/repos/18F/open-data-maker/issues/44","labels_url":"https://api.github.com/repos/18F/open-data-maker/issues/44/labels{/name}","comments_url":"https://api.github.com/repos/18F/open-data-maker/issues/44/comments","events_url":"https://api.github.com/repos/18F/open-data-maker/issues/44/events","html_url":"https://github.com/18F/open-data-maker/issues/44","id":94492524,"number":44,"title":"As a developer or data analyst, I should be able to read some text about what all this data is, so I can decide what I want to do with it ","user":{"login":"ultrasaurus","id":41906,"avatar_url":"https://avatars.githubusercontent.com/u/41906?v=3","gravatar_id":"","url":"https://api.github.com/users/ultrasaurus","html_url":"https://github.com/ultrasaurus","followers_url":"https://api.github.com/users/ultrasaurus/followers","following_url":"https://api.github.com/users/ultrasaurus/following{/other_user}","gists_url":"https://api.github.com/users/ultrasaurus/gists{/gist_id}","starred_url":"https://api.github.com/users/ultrasaurus/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ultrasaurus/subscriptions","organizations_url":"https://api.github.com/users/ultrasaurus/orgs","repos_url":"https://api.github.com/users/ultrasaurus/repos","events_url":"https://api.github.com/users/ultrasaurus/events{/privacy}","received_events_url":"https://api.github.com/users/ultrasaurus/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/18F/open-data-maker/labels/help%20wanted","name":"help wanted","color":"159818"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-07-11T17:19:09Z","updated_at":"2015-07-14T23:45:53Z","closed_at":null,"body":"We are typically dealing with large datasets, sometimes from different sources, where data analysts and developers need to understand where the data comes from and exactly what it is, which doesn't all fit in a field name.\r\n\r\nThis story is for the \"Data Details\" area in the image below.\r\n\r\n![image](https://cloud.githubusercontent.com/assets/41906/8634657/26527ca0-27b6-11e5-9384-1877d8591571.png)\r\n\r\nThe text would be specified in data.yaml.  We also need descriptive text for each category.\r\n\r\n```\r\ncategories:\r\n  descriptive:\r\n    name: Descriptive information\r\n    description:  States and other US territories from Library of Congress standard declarations.\r\n    fields: [state, region_id]\r\n  demographic:\r\n    name: Descriptive information\r\n    description: Census data generated by surveys of US population.\r\n    fields: [population]\r\n  geographic:\r\n    name: Descriptive information\r\n    description: This is some identifying characteristics for the region sourced from Deptartment of Interior standard classification. \r\n    fields: [location, geo_category]\r\n```\r\n\r\nOur thinking is that there would be an API that returns the data.yaml as json, then the page would show this dynamically (since typically, this information is displayed on other sites that consume the data)"},"comment":{"url":"https://api.github.com/repos/18F/open-data-maker/issues/comments/121430067","html_url":"https://github.com/18F/open-data-maker/issues/44#issuecomment-121430067","issue_url":"https://api.github.com/repos/18F/open-data-maker/issues/44","id":121430067,"user":{"login":"shawnbot","id":113896,"avatar_url":"https://avatars.githubusercontent.com/u/113896?v=3","gravatar_id":"","url":"https://api.github.com/users/shawnbot","html_url":"https://github.com/shawnbot","followers_url":"https://api.github.com/users/shawnbot/followers","following_url":"https://api.github.com/users/shawnbot/following{/other_user}","gists_url":"https://api.github.com/users/shawnbot/gists{/gist_id}","starred_url":"https://api.github.com/users/shawnbot/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shawnbot/subscriptions","organizations_url":"https://api.github.com/users/shawnbot/orgs","repos_url":"https://api.github.com/users/shawnbot/repos","events_url":"https://api.github.com/users/shawnbot/events{/privacy}","received_events_url":"https://api.github.com/users/shawnbot/received_events","type":"User","site_admin":false},"created_at":"2015-07-14T23:45:53Z","updated_at":"2015-07-14T23:45:53Z","body":"Also, it would probably be good to list all of the fields even if they don't have a description. We could even prompt the owner(s) of the site to provide a description in the \"placeholder\" text:\r\n\r\n| Field        | Name      | Description                                                                |\r\n|--------------|-----------|----------------------------------------------------------------------------|\r\n| `location`   | Location  | The geographic center of each city.                                        |\r\n| `population` | *unnamed* | *This column lacks a description. Please provide one in your `data.yaml`.* |"}}