CESSDA Metadata Validator Documentation

This repository contains the documentation for the CESSDA Metadata Validator (CMV).

Technical Implementation

The documentation is written in markdown files and compiled to html using Jekyll with the CESSDA theme based on the Just the docs theme.

To get started locally, make sure to have Ruby installed, then run

gem install jekyll bundler
bundle install
bundle exec jekyll serve --config _config.yml,_devsettings.yml

Development

The documentation is written using Markdown files with Jekyll headers. Coding follows the Google Style Guide for Markdown, including ATX style headers and a maximal line lengths of 140 characters.

Style Guide compliance is checked with markdownlint by running

bundle exec rake lint

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

See Semantic Versioning for guidance.

Changes

You can find the list of changes made in each release in the CHANGELOG file.

License

See the LICENSE file.

Citing

See the CITATION file.