DRY changelog

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 <https://semver.org>`_, 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
 =============

docs/development/changelog.rst

@@ -2,155 +2,10 @@
 Changelog
 *********
 
-Overview
-========
+As of v1.17, 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 <https://github.com/FAIRDataTeam/FAIRDataPoint-Docs/releases>`_
+- `Back-end/API changelog <https://github.com/FAIRDataTeam/FAIRDataPoint/releases>`_
+- `Client changelog <https://github.com/FAIRDataTeam/FAIRDataPoint-client/releases>`_
 
-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 <https://datashapes.org/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 <https://github.com/FAIRDataTeam/FAIRDataPoint-client>`_ (frontend application  using FDP API)
-- New `OpenRefine Metadata Extension <https://github.com/FAIRDataTeam/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 <https://keepachangelog.com/en/1.0.0/>`_, and our projects adhere to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
-It is recommended to use matching versions of all components.
-
-- `FAIR Data Point Changelog <https://github.com/FAIRDataTeam/FAIRDataPoint/blob/develop/CHANGELOG.md>`_
-- `FAIR Data Point Client Changelog <https://github.com/FAIRDataTeam/FAIRDataPoint-client/blob/develop/CHANGELOG.md>`_
-- `OpenRefine Metadata Extensions Changelog <https://github.com/FAIRDataTeam/OpenRefine-metadata-extension/blob/develop/CHANGELOG.md>`_
+For v1.16 and older, refer to the `v1.16 changelog <https://github.com/FAIRDataTeam/FAIRDataPoint-Docs/blob/03627e40621501ad3be50f69d2b4e326636bc53f/docs/development/changelog.rst>`_.

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 <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork>`_.
+
+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 <https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository>`_.