From 12636cdc8ee31e897b3e0ce09c964c8fabfbb216 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Wed, 27 Aug 2025 15:27:04 +0200 Subject: [PATCH 1/4] remove hard-coded changelog content link to github releases instead --- docs/development/changelog.rst | 157 ++------------------------------- 1 file changed, 7 insertions(+), 150 deletions(-) diff --git a/docs/development/changelog.rst b/docs/development/changelog.rst index 9128f0a..f6c450e 100644 --- a/docs/development/changelog.rst +++ b/docs/development/changelog.rst @@ -2,155 +2,12 @@ Changelog ********* -Overview -======== +Changes to FAIR Data Point repositories are tracked via GitHub releases: -Here we summarize the key features and changes for each FAIR Data Point release. -For details including bugfixes and minor changes, see :ref:`detailed-changelog`. +- `Documentation changelog `_ +- `Back-end/API changelog `_ +- `Client changelog `_ -1.16 ------- - -- Application title and subtitle in config and settings -- Possibility to configure ping endpoints in config file -- SHACL preview for metadata schemas -- (Index) Cleanup of harvested records before next harvesting -- Add support for sh:order, sh:description, sh:minLength and sh:maxLength, sh:in, sh:group, dash:DateTimePickerEditor, dash:EnumSelectEditor -- Add groups and order to entity metadata -- Add form preview to resource definition and metadata schema -- Add autocomplete widget -- Add settings for autocomplete -- Add extra class statement for fields with class -- Rename search param from q to query -- Remove hardcoded metadata timestamps -- Fix search filters with too many values -- Fix nested NodeShapes in form previews -- Fix value validation for multiple values - -1.15 ------- - -- Extended search (filters, simple and complex query) -- Add saved search queries -- Several dependencies updated - -1.14.0 ------- - -- Security audit via GitHub Actions (Snyk and CodeQL) -- Introduced metadata schemas (as replacement of shapes) including versioning and importing -- Updated RDF4J to 4.0 -- Several dependencies updated - -1.13.0 ------- - -- Added restriction to URL prefixes of Resource Definitions -- Upgraded Java JDK from 16 to 17, updated SpringDoc OpenAPI UI and several other dependencies -- Compliance with FDP-O ontology (fdp-o:FAIRDataPoint) -- Added form preview to shape edit - -1.12.0 ------- - -- Settings (metrics and ping) can be adjusted directly from UI -- Default values can be specified using ``sh:defaultValue`` -- ``**/expanded`` endpoint marked as deprecated (may be removed in the following version) -- Fixed bugs related to resource definition (same child relations, multiple parents) -- Fixed computing cache on DB migration and reset to defaults and ordering or resource definitions - -1.11.0 ------- - -- All metadata have ``dct:conformsTo`` with profile based on resource definition -- Resolving labels for RDF resources -- Registration of standard namespaces in RDF output -- Resource definitions are now related directly to shapes -- Fixed metadata with empty keywords and pagination - -1.10.0 ------- - -- Reset to factory defaults (users, metadata, resource definitions) -- Improved UX for browsing child metadata -- Allow to change internal shapes (and delete dataset and distribution) -- Several dependencies updated (including Java 16) - -1.9.0 ------ - -- Publishing and sharing SHACL shapes between FDPs -- Metadata children pagination -- Generating OpenAPI based on resource definitions -- Several dependencies updates including Spring Boot 2.4.5 - -1.8.0 ------ - -- Added Admin UI to FDP Index with possibility to trigger metadata retrieval, change settings, or delete entry -- Several bug fixes and dependencies updated (including Java 15) - -1.7.0 ------ - -- Including FDP Index functionality into FAIR Data Point with harvesting metadata -- Metadata search including RDF types -- Possibility to change profile and password for current user - -1.6.0 ------ - -- API keys for making integrations with FDP easier -- State "draft" for created metadata - -1.5.0 ------ - -- Support for editable resource definitions -- Possibility to specify custom storage in OpenRefine using frontend - -1.4.0 ------ - -- Ping service for *call home* functionality -- Suggesting prefixes for namespaces - -1.3.0 ------ - -- Introduced `DASH `_ and dynamic SHACL shapes -- Audit log in OpenRefine extension to keep track of actions performed - -1.2.0 ------ - -- Option to customize metamodel (metadata layers) -- Possibility to delete and create metadata entities - -1.1.0 ------ - -- New monitoring and configuration for client application -- Several further improvements in terms of technical debt -- Enhanced connecting to FDP from OpenRefine extension and update to OpenRefine 3.3 - -1.0.0 ------ - -- User management, enhanced security, and ACL -- Huge refactoring and upgrades of previously accumulated features and technical debt -- Separate project for `FAIR Data Point Client `_ (frontend application using FDP API) -- New `OpenRefine Metadata Extension `_ as a replacement for the deprecated FAIRifier - - -.. _detailed-changelog: - -Detailed changelog -================== - -Each of components developed has its own Changelog based on `Keep a Changelog `_, and our projects adhere to `Semantic Versioning `_. -It is recommended to use matching versions of all components. - -- `FAIR Data Point Changelog `_ -- `FAIR Data Point Client Changelog `_ -- `OpenRefine Metadata Extensions Changelog `_ +All FAIR Data Point projects adhere to `Semantic Versioning `_, using the ``MAJOR.MINOR.PATCH`` format. +It is recommended to use matching ``MAJOR.MINOR`` versions of ``FAIRDataPoint`` and ``FAIRDataPoint-client``. +The ``PATCH`` versions do not need to match. From 5ac36cf27ac640ec4cce4f22222386f9c20b8c17 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Wed, 27 Aug 2025 15:34:27 +0200 Subject: [PATCH 2/4] explain the need for pull requests in contributing.rst --- docs/development/contributing.rst | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/development/contributing.rst b/docs/development/contributing.rst index 4c81b97..439bf51 100644 --- a/docs/development/contributing.rst +++ b/docs/development/contributing.rst @@ -1,11 +1,15 @@ -************ -Contributing -************ +*********************** +Contribution guidelines +*********************** -Development -=========== - -Our projects are open source and you can contribute via GitHub (fork and pull request): +The FAIR Data Point repositories are open source and you can contribute via GitHub: - https://github.com/FAIRDataTeam/FAIRDataPoint - https://github.com/FAIRDataTeam/FAIRDataPoint-client +- https://github.com/FAIRDataTeam/FAIRDataPoint-Docs + +To contribute, fork the relevant repository, create a new branch, make your changes, and `open a pull request `_. + +Developers with write access don't need to fork, but they do need to use a branch and pull-request workflow. + +All changes must be made via pull requests in order to facilitate consistent auto-generated changelogs via `GitHub releases `_. From 2f8d2173cce9301a93ebdcaf88abf6465579e70e Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Wed, 27 Aug 2025 16:02:27 +0200 Subject: [PATCH 3/4] move semantic versioning note from changelog.rst to components.rst --- docs/about/components.rst | 4 ++++ docs/development/changelog.rst | 4 ---- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/about/components.rst b/docs/about/components.rst index 9722e95..c64227b 100644 --- a/docs/about/components.rst +++ b/docs/about/components.rst @@ -10,6 +10,10 @@ The software stack for a typical FAIR Data Point deployment consists of five com :alt: Structure Overview :align: center +.. IMPORTANT:: + All FAIR Data Point components adhere to `Semantic Versioning `_, using the ``MAJOR.MINOR.PATCH`` format. + It is recommended to use matching ``MAJOR.MINOR`` versions of the ``FAIRDataPoint`` and ``FAIRDataPoint-client`` components. + The ``PATCH`` versions do not need to match. FAIRDataPoint ============= diff --git a/docs/development/changelog.rst b/docs/development/changelog.rst index f6c450e..47fcf2b 100644 --- a/docs/development/changelog.rst +++ b/docs/development/changelog.rst @@ -7,7 +7,3 @@ Changes to FAIR Data Point repositories are tracked via GitHub releases: - `Documentation changelog `_ - `Back-end/API changelog `_ - `Client changelog `_ - -All FAIR Data Point projects adhere to `Semantic Versioning `_, using the ``MAJOR.MINOR.PATCH`` format. -It is recommended to use matching ``MAJOR.MINOR`` versions of ``FAIRDataPoint`` and ``FAIRDataPoint-client``. -The ``PATCH`` versions do not need to match. From 6cb97089d41c62600f63a0c13fa6cd35cd968818 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Wed, 27 Aug 2025 16:02:58 +0200 Subject: [PATCH 4/4] add link to old changelog --- docs/development/changelog.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/development/changelog.rst b/docs/development/changelog.rst index 47fcf2b..1116f36 100644 --- a/docs/development/changelog.rst +++ b/docs/development/changelog.rst @@ -2,8 +2,10 @@ Changelog ********* -Changes to FAIR Data Point repositories are tracked via GitHub releases: +As of v1.17, changes to FAIR Data Point repositories are tracked via GitHub releases: - `Documentation changelog `_ - `Back-end/API changelog `_ - `Client changelog `_ + +For v1.16 and older, refer to the `v1.16 changelog `_.