Change logs

Version 2.0.0 (2024)

New features

• As evidenced by the issues and merge requests, (#1 (opens in a new tab), #69 (opens in a new tab), #88 (opens in a new tab), #91 (opens in a new tab), #97 (opens in a new tab), !17 (opens in a new tab), !19 (opens in a new tab), !39 (opens in a new tab), !41 (opens in a new tab)), the Live F-UJI Assessment feature has been successfully incorporated into the Assess my Data (opens in a new tab) page.

• As evidenced by the issue and merge request, (#18 (opens in a new tab), !5 (opens in a new tab)), the tooltip and popover feature have been successfully incorporated into the Welcome page.

• As evidenced by the issue and merge request, (#19 (opens in a new tab), !9 (opens in a new tab)), the addition of an animated indicator, in the form of a spinning icon, has been successfully implemented on all pages. This indicator is designed to appear while the page is undergoing an update.

• As evidenced by the issues and merge request, (#25 (opens in a new tab), #38 (opens in a new tab), !30 (opens in a new tab)), the filters have been made more prominent, and this addition has been successfully implemented.

• As evidenced by the issue and merge request, (#33 (opens in a new tab), !30 (opens in a new tab)), the responsiveness of the dashboard on smaller devices has been enhanced.

• As evidenced by the issues and merge requests, (#68 (opens in a new tab), #27 (opens in a new tab), !15 (opens in a new tab), !17 (opens in a new tab), !18 (opens in a new tab), !22 (opens in a new tab) ), the page dedicated to the assessment of data has undergone a significant redesign and restructuring, incorporating new processes and the addition of new charts and components. This redesign has proven to be a successful endeavour.

• As evidenced by the issue and merge requests, (#72 (opens in a new tab), !20 (opens in a new tab), !22 (opens in a new tab), !34 (opens in a new tab), !51 (opens in a new tab)), the pre-commit framework (opens in a new tab) has been successfully integrated into the code base of the dashboard, thereby enhancing the overall quality of the code.

• As evidenced by the issue and merge requests, (#78 (opens in a new tab), !24 (opens in a new tab), !27 (opens in a new tab)), the most recent date and time at which the dashboard information was updated has been successfully incorporated into the dashboard.

• As evidenced by the issue and merge request, (#82 (opens in a new tab), !26 (opens in a new tab)), the F-UJI metrics version 0.5 has been successfully integrated into the dashboard, with implementation occurring across all charts and pages.

• As evidenced by the issue and merge request, (#85 (opens in a new tab), !51 (opens in a new tab)), the integration of the GitLab CI Pipeline into the dashboard has been completed successfully.

• As evidenced by the issue and merge request, (#97 (opens in a new tab), !41 (opens in a new tab)), a centralised, high-performance, regularly updated and dependable F-UJI Server at DESY is now employed for real-time F-UJI assessment in the dashboard.

• As evidenced by the issue and merge request, (#107 (opens in a new tab), !59 (opens in a new tab)), a CHANGELOG.md file is also added to the repository to show the changes from one version to the next.

• As evidenced by the issue and merge request, (#110 (opens in a new tab), !63 (opens in a new tab)), a real End to End (e2e) testing implemented with the integration of automatic GitLab CI/CD Pipeline.

• As evidenced by the issues and merge requests, (#111 (opens in a new tab), #112 (opens in a new tab), !64 (opens in a new tab), !65 (opens in a new tab), !67 (opens in a new tab) ), modern open software and web development best practices applied, such as REUSE (opens in a new tab) and Open Source Security Foundation (OpenSSF) (opens in a new tab) best practices.

• As evidenced by the issue and merge requests, (#121 (opens in a new tab), !74 (opens in a new tab), !75 (opens in a new tab)), improvement made in CI/CD pipeline.

Features update

• As evidenced by the issue and merge requests, (#2 (opens in a new tab), !3 (opens in a new tab), !42 (opens in a new tab)), the docker Compose file and the overall deployment of the dashboard have been enhanced.

• As evidenced by the issue and merge request, (#4 (opens in a new tab), !31 (opens in a new tab)), In the chart depicting the "Welcome" page (opens in a new tab), the addition of dotted lines between the data points of the current year (N) and the preceding two years (N-1 and N-2) was successfully completed.

• As evidenced by the issue and merge request, (#86 (opens in a new tab), !32 (opens in a new tab)), the modifications to the dashboard layout and details have been implemented successfully.

Incompatible changes and deprecations

• As evidenced by the issues and merge requests, (#16 (opens in a new tab), #60 (opens in a new tab), #63 (opens in a new tab), #65 (opens in a new tab), !1 (opens in a new tab), !2 (opens in a new tab), !6 (opens in a new tab), !7 (opens in a new tab), !48 (opens in a new tab)), the population script has been successfully updated. However, the responsibility for this has ultimately been transferred from the dashboard part to the toolbox part of the HMC FAIR Data Dashboard. Consequently, the latter has been removed in this version.

• As evidenced by the issue and merge requests, (#100 (opens in a new tab), !49 (opens in a new tab), !53 (opens in a new tab)), the readme and metadata files for version 2 have been successfully updated, as well as the restructuring of the code files and directories.

• The alteration of the database schema has been completed successfully, rendering the previous version obsolete in this context. Further details can be found on the Data Model and Storage page.

• As evidenced by the issue and merge request, (#114 (opens in a new tab), !66 (opens in a new tab)), all Helmholtz fonts (Halvar) removed from the public repository. (If you want to use these fonts, please take care of the licence issue and buy them!)

Bug fixes and minor changes

• As evidenced by the issue and merge request, (#64 (opens in a new tab), !10 (opens in a new tab)), the counting mechanism for the number of publications has been updated successfully.

• As evidenced by the issue and merge request, (#69 (opens in a new tab), !46 (opens in a new tab)), prior to the database query process for the live assessment, the entered Digital Object Identifier (DOI) is now enforced to be in lower case.

• As evidenced by the issue and merge request, (#94 (opens in a new tab), !37 (opens in a new tab)), the About (opens in a new tab) page has undergone minor textual updates.

Documentation part

Documentation for version 2 (opens in a new tab): a new framework, designated Nextra (opens in a new tab), has been successfully selected, implemented, and a comprehensive descriptive documentation has been produced for versions 2 and above.

• As evidenced by the issue and merge request, (#4 (opens in a new tab), !9 (opens in a new tab)), the recently developed documentation repository (opens in a new tab) provides an illustrative overview of the dashboard components and pages.

Version 1.0.0 (22.02.2023)

The Helmholtz Metadata Collaboration (HMC) has officially launched the HMC dashboard on open and FAIR data in Helmholtz. The dashboard allows users to monitor and interactively analyze statistics on open and FAIR data produced by researchers in the Helmholtz Association. It can be used to analyze in which repositories Helmholtz researchers make their data publicly available, to monitor progression over time and to understand what one can do to improve the FAIRness of data.

Features

• The HMC Fair Data Dashboard has been developed with the initial, functionalities that are fit for purpose.