docs: add docker hub-documentation

.github/workflows/docker-build.yml

@@ -28,3 +28,13 @@ jobs:
         if: github.repository == 'georchestra/sdi-consistence-check'
         run: |
           make docker-push
+
+      - name: "Update Docker Hub Description"
+      if: github.ref == 'refs/heads/master' && github.repository == 'georchestra/sdi-consistence-check' && github.actor != 'dependabot[bot]' && github.event_name != 'pull_request'
+      uses: peter-evans/dockerhub-description@v3
+      with:
+        username: ${{ secrets.DOCKER_HUB_USERNAME }}
+        password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+        repository: georchestra/sdi-consistence-check
+        readme-filepath: ./DOCKER_HUB.md
+        short-description: 'SDI consistence check module for geOrchestra SDI'

DOCKER_HUB.md

@@ -0,0 +1,46 @@
+# Quick reference
+
+-    **Maintained by**:  
+      [georchestra.org](https://www.georchestra.org/)
+
+-    **Where to get help**:  
+     the [Georchestra Github repo](https://github.com/georchestra/georchestra), [IRC chat](https://kiwiirc.com/nextclient/irc.libera.chat/georchestra), Stack Overflow
+
+# Featured tags
+
+- `latest`, `23.0.x`
+
+# Quick reference
+
+-	**Where to file issues**:  
+     [https://github.com/georchestra/georchestra/issues](https://github.com/georchestra/georchestra/issues)
+
+-	**Supported architectures**:   
+     [`amd64`](https://hub.docker.com/r/amd64/docker/)
+
+-	**Source of this description**:  
+     [docs repo's directory](https://github.com/georchestra/sdi-consistence-check/blob/master/DOCKER_HUB.md)
+
+# What is `georchestra/sdi-consistence-check`
+
+**Sdi-consistence-check** is a module for geOrchestra which aims to check the relevance between data (published into a GeoServer) and metadata (in GeoNetwork), and possibly fix the detected inconsistencies when possible (missing metadata, missing URL information, ...), following different scenarios.
+
+# How to use this image
+
+It is recommended to use the official docker composition: https://github.com/georchestra/docker.
+
+For this specific component, see the README in [docs repo's directory](https://github.com/georchestra/sdi-consistence-check/blob/master/README.md)
+
+## Where is it built
+
+This image is build using the Dockerfile in the repo https://github.com/georchestra/sdi-consistence-check/.
+
+# License
+
+View [license information](https://www.georchestra.org/software.html) for the software contained in this image.
+
+As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).
+
+[//]: # (Some additional license information which was able to be auto-detected might be found in [the `repo-info` repository's georchestra/ directory]().)
+
+As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.