Manage Data Documentation¶
Missing data documentation is one of the most frustrating issues when exploring new dataset. With d6tpipe you can easily include data documentation and make the data consumers happy.
The databolt GUI allows you to create and publish dataset documentation including the documents listed below. Log in to GUI, select a pipe and then documentation. You can access the GUI at http://pipe.databolt.tech/gui/
README.md file which will automatically be displayed when the dataset is pulled for the first time.
LICENSE.md file which will automatically be displayed when the dataset is pulled for the first time.
Data vendors can use tearsheet templates to succinctly describe their datasets, see https://github.com/siia-fisd/altdata-council/blob/master/documentation/tearsheet.md
Example tearsheet created in GUI http://pipe.databolt.tech/gui/docs/038531533749f46fb938db524da7cd96/