numass-framework/site/content/docs/shards/how_to_read.md

789 B

content_type title chapter label version date published
doc_shard How to read this documentation howto how_to_read 1.1 02.09.2015 true

An important feature of DataForge framework is ability to work with meta-data. This documentation is automatically generated by grain script from markdown and html pieces. Such pieces are called shards. The shard consists of data in one of supported formats and meta-data header. The ordering of shards is automatically inferred from meta-data by the script.

The meta-data of each shards includes version of this precise shard last update date, it's label for reference and ordering information.