forked from NPM/numass-framework
17 lines
789 B
Markdown
17 lines
789 B
Markdown
|
---
|
||
|
|
content_type: "doc_shard"
|
||
|
|
title: "How to read this documentation"
|
||
|
|
chapter: "howto"
|
||
|
|
label: "how_to_read"
|
||
|
|
version: 1.1
|
||
|
|
date: 02.09.2015
|
||
|
|
published: true
|
||
|
|
---
|
||
|
|
An important feature of DataForge framework is ability to work with [meta-data](#meta).
|
||
|
|
This documentation is automatically generated by [grain](http://sysgears.com/grain/)
|
||
|
|
script from [markdown](https://en.wikipedia.org/wiki/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](https://bitbucket.org/Altavir/dataforge-grain).
|
||
|
|
|
||
|
|
The meta-data of each shards includes version of this precise shard last update date,
|
||
|
|
it's label for reference and ordering information.
|