https://github.com/qbicsoftware/research-data-management
Documentation about the life science research data management at QBiC
https://github.com/qbicsoftware/research-data-management
data data-management data-stewardship documentation hacktoberfest life-science management metadata rdm reasearch-data-management
Last synced: 4 months ago
JSON representation
Documentation about the life science research data management at QBiC
- Host: GitHub
- URL: https://github.com/qbicsoftware/research-data-management
- Owner: qbicsoftware
- License: mit
- Created: 2024-03-04T09:47:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-09-16T16:08:42.000Z (9 months ago)
- Last Synced: 2025-09-16T18:16:56.421Z (9 months ago)
- Topics: data, data-management, data-stewardship, documentation, hacktoberfest, life-science, management, metadata, rdm, reasearch-data-management
- Homepage: https://qbicsoftware.github.io/research-data-management/latest
- Size: 23.9 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Research Data Management
This repo provides the documentation for the research data management processes at the [Quantitative Biology Center](https://ror.org/00v34f693) [
](https://ror.org/00v34f693), [University of Tübingen](https://ror.org/03a1kwz48) [](https://ror.org/00v34f693).
[](https://squidfunk.github.io/mkdocs-material/)
> #### Latest documentation
>
> [qbicsoftware.github.io/research-data-management](https://qbicsoftware.github.io/research-data-management)
>
## Local Development
The documentation is written in pure Markdown, rendered and deployed with [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/), versioning is realised with [mike](https://github.com/jimporter/mike). All can be installed with the Python tool [pip](https://pypi.org/project/pip/):
```bash
pip install mkdocs mkdocs-material mike
```
If you want to see the live preview, run:
```bash
mkdocs serve
```
If you want to see the live preview with versioning activated, run:
```bash
mike deploy --update-aliases latest
mike 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:
```bash
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](https://www.markdownguide.org/) 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](https://mit-license.org/).
The **creative work** of the documentation found in the `./docs` directory of this repository is licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/) 
.
Attribution to *QBiC, University of Tübingen*