Executable Research Compendium specification and guides
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
custom_theme/img
docs
templates/geo
.gitignore
.markdownlint.json
.site_build.sh
.site_deploy.sh
.travis.yml
CONTRIBUTING.md
LICENSE
Makefile
README.md
mkdocs.yml

README.md

erc-spec

Executable Research Compendium (ERC) specification and guides

Project description: https://o2r.info

Read online: https://o2r.info/erc-spec

Guidelines

See CONTRIBUTING.md

Build

This specification is written in Markdown, rendered with MkDocs and deployed automatically using Travis CI.

Build Status

Use mkdocs to render it locally.

# pip install mkdocs mkdocs-cinder pymdown-extensions
mkdocs serve

Automated Builds

Our combination of the .travis.yml and .deploy.sh will run the mkdocs command on every direct commit or merge on the master branch and deploy the rendered HTML documents to the gh-pages branch in this repository.

Travis authenticates its push to the gh-pages branch using a personal access token of the user @o2r-user, who has write access to this repository. The access token is encrypted in the .travis.yml using Travis CLI:

travis encrypt GH_TOKEN=<token here>

The variable GH_TOKEN is used in the deploy script. The token generated on the GitHub website should not be stored anywhere, simply generate a new one if needed.

This has some security risks, as described here. To mitigate these risks, the option "Build pull requests" on the Travis configuration page for this repo must be disabled so malicious changes to the Travis configuration file will not be build before maintainer inspection.

License

The o2r Executable Research Compendium specification is licensed under Creative Commons CC0 1.0 Universal License, see file LICENSE. To the extent possible under law, the people who associated CC0 with this work have waived all copyright and related or neighboring rights to this work. This work is published from: Germany.