Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.2.0] – 2025-10-24

Added

  • Added sphinxcontrib-mermaid to enable rendering of Mermaid diagrams in Sphinx documentation.

  • Added Puppeteer configuration file to run Chromium in no-sandbox mode, enabling Mermaid diagram rendering for PDF builds.

Changed

  • Updated the “Handling Sensitive Data” section in the version management recommendations. The wording was expanded for clarity and now includes direct links to:

    • Legal Affairs Staff Unit

    • External Data Protection Officer

    • IT Security Officer (Dr. Ulrich Schwarz)

  • Updated Markdown linting rules: disabled MD013 (line length) completely

  • Updated CRC1261 storage and backup documentation for clarity and consistency:

    • Reorganized “Data Handling Guidelines” with clear sections for central storage, data organization, responsibilities, ELN, sensitive data, and code management.

    • Added flowchart for storage selection based on data type, size, and sharing.

[1.1.1] – 2025-05-16

Changed

  • Accessibility Enhancements: Improved visual contrast across key UI elements to meet accessibility guidelines and ensure better readability for all users.

Fixed

  • Mount Directory Paths: Updated documentation to reflect correct directory names for mounting storage systems.

[1.1.0] – 2024-06-11

Changed

  • Storage Renaming: The tape storage system has undergone a name change to “Research Data Storage”.

  • Deprecation of Project Network Drive: The usage of the project network drive is now deprecated. It is recommended to utilize the research data storage instead. The research data storage also offers backup functionalities for research data. Furthermore it support snapshots for self-recovery.

[1.0.5] – 2024-01-31

Changed

  • Emphasized the necessity of a CIM user identifier to request access to eLabFTW.

  • Encourages the use of git-annex or DataLad for effective management of large files, as opposed to relying on git-lfs.

Removed

  • Removed the section related to ELN Chemotion. Chemotion is currently not a service of the computing centre.

[1.0.4] – 2023-12-07

Changed

  • Updated link to the Data Management Plan, which is now stored in the CRC GitLab group.

[1.0.3] - 2023-10-19

Added

  • Semantic Versioning notes to version management recommendations.

  • Basic information on backups.

Changed

  • The operation status of eLabFTW service has been changed from pilot to production.

[1.0.2] - 2023-09-29

Added

  • Basic information on metadata.

  • Basic information on Data Management Plans.

[1.0.1] - 2023-04-21

Added

  • How-to-cite section to README file of git project template.

  • Citation file for git project template.

Changed

  • The login to eLabFTW has been changed from email only to email or user ID.

[1.0.0] - 2023-04-03

Added

  • Recommendation that users organise their project-specific repositories within a project subgroup of the CRC group in GitLab.

Changed

  • The central instance of Kiel University is to be used exclusively for the electronic laboratory notebook eLabFTW.

[0.0.1] - 2023-01-30

Added

  • Initial user documentation