docs: adds documentation

.github/workflows/CI.yml

@@ -18,4 +18,14 @@ jobs:
         docker push georchestra/ssh_data
       env:
           DOCKER_USERNAME: ${{ secrets.DOCKER_HUB_USERNAME }}
-          DOCKER_PASSWORD: ${{ secrets.DOCKER_HUB_PASSWORD }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_HUB_PASSWORD }}
+
+    - name: "Update Docker Hub Description for SSH Data"
+      if: github.ref == 'refs/heads/master' && github.repository == 'georchestra/sshdata' && 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/ssh_data
+        readme-filepath: ./DOCKER_HUB.md
+        short-description: 'SSH data module for the geOrchestra SDI'

DOCKER_HUB.md

@@ -0,0 +1,44 @@
+# 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/sshdata/blob/master/DOCKER_HUB.md)
+
+# What is `georchestra/ssh_data`
+
+**Ssh_data** is a small utility to access data volumes within the docker composition.
+
+# How to use this image
+
+It is recommended to use the official docker composition: https://github.com/georchestra/docker.
+
+## Where is it built
+
+This image is built using Dockerfile within [`sshdata`](https://github.com/georchestra/sshdata) repository.
+
+# 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 docker image, it is the user's responsibility to ensure that usages of this image comply with any relevant licenses for all software contained within.