Architecture and overarching documentation for o2r microservices
Switch branches/tags
Nothing to show
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
.deploy.sh
.gitignore
.markdownlint.json
.travis.yml
CONTRIBUTING.md
LICENSE
Makefile
README.md
arc42-template-EN.md
mkdocs.yml

README.md

Opening Reproducible Research System Architecture

Project website: https://o2r.info

Read architecture description online: https://o2r.info/architecture

The project

Opening Reproducible Research (o2r) is a DFG-funded research project by Institute for Geoinformatics (ifgi) and University and Regional Library (ULB), University of Münster, Germany. Building on recent advances in mainstream IT, o2r envisions a new architecture for storing, executing and interacting with the original analysis environment alongside the corresponding research data and manuscript. This architecture evolves around so called Executable Research Compendia (ERC) as the container for both research, review, and archival.

Guidelines

See CONTRIBUTING.md

Build

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

Build Status

Use mkdocs to render it locally.

# pip install mkdocs mkdocs-cinder
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 and is specific to this repository.

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.

Diagrams

The diagrams are created with yEd. All source files (.graphml) are stored in /docs/img. The PNG renderings are exported from yEd with transparent background, a margin of 5, and a scaling factor of 1.0.

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.