From 91a884a14767f68e0c3d316fe9f2bf7885edafa8 Mon Sep 17 00:00:00 2001 From: Daniel McCoy Stephenson Date: Fri, 15 Mar 2024 10:34:10 -0600 Subject: [PATCH] Changed title in `compatibility.md` to 'Submodule Compatibility Guide' --- README.md | 2 +- docs/compatibility.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3e33e417c..a736d537c 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,7 @@ The following guide contains information about the data flow diagrams for the OD - Additionally `git` commands may fail for similar reasons, you can fix this by running `export GIT_SSL_NO_VERIFY=1`. - Windows users may find more information on installing and using Docker [here](https://github.com/usdot-jpo-ode/jpo-ode/wiki/Docker-management). - Users interested in Kafka may find more guidance and configuration options [here](docker/kafka/README.md). -- A compatibility guide containing recommended suitable versions of submodules for each main module version can be found [here](docs/compatibility.md). +- A compatibility guide containing recommendations for suitable versions of submodules for each main module version can be found [here](docs/compatibility.md). **Configuration:** diff --git a/docs/compatibility.md b/docs/compatibility.md index f2bc555b8..30dfcdc3b 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,4 +1,4 @@ -# Compatibility Matrix (Recommended Versions) +# Submodule Compatibility Guide This table serves as a guide, suggesting which versions of individual submodules are best suited to accompany each version of the main module. It helps users ensure compatibility and smooth integration by recommending specific submodule versions for their chosen main module version. | [ODE (this project)](https://github.com/usdot-jpo-ode/jpo-ode/releases) | [ACM](https://github.com/usdot-jpo-ode/asn1_codec/releases) | [PPM](https://github.com/usdot-jpo-ode/jpo-cvdp/releases) | [SEC](https://github.com/usdot-jpo-ode/jpo-security-svcs/releases) | [SDWD](https://github.com/usdot-jpo-ode/jpo-sdw-depositor/releases) | [S3D](https://github.com/usdot-jpo-ode/jpo-s3-deposit/releases) | [GJConverter](https://github.com/usdot-jpo-ode/jpo-geojsonconverter/releases) | [CMonitor](https://github.com/usdot-jpo-ode/jpo-conflictmonitor/releases) | [CVisualizer](https://github.com/usdot-jpo-ode/jpo-conflictvisualizer/releases) | [CVManager](https://github.com/usdot-jpo-ode/jpo-cvmanager/releases) |