From d700855a1cd591f5dfe2cf28200681feb671ac5f Mon Sep 17 00:00:00 2001
From: fnecas <florian.necas@camptocamp.com>
Date: Thu, 8 Feb 2024 09:55:40 +0100
Subject: [PATCH] docs: adds documentation

---
 .github/workflows/CI.yml | 12 ++++++++++-
 DOCKER_HUB.md            | 44 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+), 1 deletion(-)
 create mode 100644 DOCKER_HUB.md

diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
index 6b22bbb..468131e 100644
--- a/.github/workflows/CI.yml
+++ b/.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 }}
\ No newline at end of file
+          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'
\ No newline at end of file
diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md
new file mode 100644
index 0000000..79a5bcb
--- /dev/null
+++ b/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]&#40;&#41;.)
+
+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.
\ No newline at end of file