avalanche-io/c4docs

The C4 Interface

c4docs's Issues

Create yaml test case (manually)

Add Hoedown as git dependancy

Add base58 c4id with check digit.

Write test for md symbol table to yaml

Link Hoedown to c4 parser

C4 DSL - Tests

This will depend on successful self compilation.

Add md to yaml preparser to c4 parser

golang c4 based C4 id creation and tests.

Clean up BDD dependancies.

python - Asset ID script

Create command line C4 parser

Json examples

Service API example

Yaml examples

Finish travis CI integration.

Remove Qt dependancies

At this point it's silly to have Qt dependancies, so we're remove for now and add back later if we need to bring back a GUI.

ruby - Asset ID script

Test ticket from Code Climate

Document Workflow Examples

Show examples of the C4 DSL in specific scenarios: production, facility, SaaS provider, studio

MHL / C4 usecase example

MHL (meda hash list) is a data integrity document format that improves data reliability for production.

The C4 language supersedes the MHL document format, and the framework prescribes more 'network enabled' communications to provide data integrity verification.

However, in the case of purely offline file transmission it may make sense to provide a C4 file that provides asset IDs and metadata for the offline volume.

It also probably makes sense to provide a MHL to C4 file translator as an example of legacy metadata support.

c - Asset ID library and example

Media Aware Storage Service

Below is a first draft idea for how the proposed asset registry service could be implemented with other tools to provide a unified "media pool" with ingestion for multiple production applications.

Through adaptation or incorporation of code from MHL (http://mediahashlist.org/) develop an ingest process in which:

-Media files are hashed with MHL on the client
-Files are uploaded to an object storage repository
-Files are entered in registry with URI to storage service
-Files are verified against MHL
-MHL are stored by MHL service
-MHL service registers asset hash to registry with URI to MHL service
-Media file headers are parsed by Media info service
-Parsed data is stored as extended attributes attached to the object URI in a Media info service database
-Media info service registers asset hash to registry with URI to MHL service
-Client APIs authenticate through federated identity system
-Client queries registry by ID (returns URIs) or URI (returns IDs)

This would allow applications and users with access to query files or media specific metadata (TC match, Camera Type, etc...) to bypass the need for individual application to index large storage repositories

Below is a simple diagram. Just offering this up for discussion/consideration

Binary distribution

C4 DSL lexer

bash - Asset ID script

Create test case hoedown parses a c4.md file

Write test for c4.md to md symbol table