From 6f0de3f33b32fb9ee6d6a7db7def10783a9ed8cd Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Wed, 7 Feb 2024 15:07:55 +0100 Subject: [PATCH 1/2] docs: add docker hub-documentation --- .github/workflows/docker-build.yml | 10 +++++++ DOCKER_HUB.md | 46 ++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 DOCKER_HUB.md diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml index 2b2fc3b..f2b9fc5 100644 --- a/.github/workflows/docker-build.yml +++ b/.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' \ No newline at end of file diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md new file mode 100644 index 0000000..96aa3ab --- /dev/null +++ b/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. From c751202ea999f6f3e44374a10d98b21f88a0e0c1 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Wed, 7 Feb 2024 16:13:36 +0100 Subject: [PATCH 2/2] taking account of recommandation --- .github/workflows/docker-build.yml | 2 +- DOCKER_HUB.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docker-build.yml b/.github/workflows/docker-build.yml index f2b9fc5..6e749db 100644 --- a/.github/workflows/docker-build.yml +++ b/.github/workflows/docker-build.yml @@ -37,4 +37,4 @@ jobs: password: ${{ secrets.DOCKER_HUB_PASSWORD }} repository: georchestra/sdi-consistence-check readme-filepath: ./DOCKER_HUB.md - short-description: 'SDI consistence check module for geOrchestra SDI' \ No newline at end of file + short-description: 'SDI consistence check module for the geOrchestra SDI' \ No newline at end of file diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index 96aa3ab..7b1d328 100644 --- a/DOCKER_HUB.md +++ b/DOCKER_HUB.md @@ -4,7 +4,7 @@ [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 + the [geOrchestra Github repo](https://github.com/georchestra/georchestra), [IRC chat](https://kiwiirc.com/nextclient/irc.libera.chat/georchestra), Stack Overflow # Featured tags @@ -33,7 +33,7 @@ For this specific component, see the README in [docs repo's directory](https://g ## Where is it built -This image is build using the Dockerfile in the repo https://github.com/georchestra/sdi-consistence-check/. +This image is built using the Dockerfile in the repo https://github.com/georchestra/sdi-consistence-check/. # License @@ -43,4 +43,4 @@ As with all Docker images, these likely also contain other software which may be [//]: # (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. +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.