qbicsoftware/research-data-management

Documentation about the life science research data management at QBiC

Research Data Management

This repo provides the documentation for the research data management processes at the Quantitative Biology Center , University of Tübingen .

Latest documentation

qbicsoftware.github.io/research-data-management

Local Development

The documentation is written in pure Markdown, rendered and deployed with MkDocs and Material for MkDocs. Both can be installed with the Python tool pip:

pip install mkdocs mkdocs-material

If you want to see the live preview, run:

mkdocs serve

In the default configuration, you can see a live preview following the URL displayed in the console log, e.g. http://127.0.0.1:8000:

mkdocs serve                                   
INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  Documentation built in 0.24 seconds
INFO    -  [08:41:47] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO    -  [08:41:47] Serving on http://127.0.0.1:8000/

Documentation

The documentation source files themselves are located in this repository's ./docs folder. You can use simple Markdown syntax for providing more content.

Deployment

The deployment of the live side is implemented with Github actions, once a commit is done to the main branch.

The live site of the build documentation can be then found on https://qbicsoftware.github.io/research-data-management.

License

Any repository code and configuration is licensed under the MIT-license.

The creative work of the documentation found in the ./docs directory of this repository is licensed under CC-BY 4.0 .

Attribution to QBiC, University of Tübingen