Skip to content

Commit 6d30235

Browse files
committed
move semantic versioning note from changelog.rst to components.rst
1 parent 7667e25 commit 6d30235

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

docs/about/components.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ FDP client is distributed in Docker image ``fairdata/fairdatapoint-client``.
4242
It provides the user interface for humans.
4343
It works as a reverse proxy in front of the FAIR Data Point which decides whether the request is for machine-readable data and passes it to the FAIRDataPoint or from a web browser in which case it serves the interface for humans.
4444

45+
.. IMPORTANT::
46+
All FAIR Data Point components adhere to `Semantic Versioning <https://semver.org>`_, using the ``MAJOR.MINOR.PATCH`` format.
47+
It is recommended to use matching ``MAJOR.MINOR`` versions of the ``FAIRDataPoint`` and ``FAIRDataPoint-client`` components.
48+
The ``PATCH`` versions do not need to match.
49+
4550

4651
Reverse Proxy
4752
=============

docs/development/changelog.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,3 @@ Changes to FAIR Data Point repositories are tracked via GitHub releases:
77
- `Documentation changelog <https://github.com/FAIRDataTeam/FAIRDataPoint-Docs/releases>`_
88
- `Back-end/API changelog <https://github.com/FAIRDataTeam/FAIRDataPoint/releases>`_
99
- `Client changelog <https://github.com/FAIRDataTeam/FAIRDataPoint-client/releases>`_
10-
11-
All FAIR Data Point projects adhere to `Semantic Versioning <https://semver.org>`_, using the ``MAJOR.MINOR.PATCH`` format.
12-
It is recommended to use matching ``MAJOR.MINOR`` versions of ``FAIRDataPoint`` and ``FAIRDataPoint-client``.
13-
The ``PATCH`` versions do not need to match.

0 commit comments

Comments
 (0)