From 5ee458c8b802b1f051e3fdd0435749b483ef3927 Mon Sep 17 00:00:00 2001 From: fnecas Date: Wed, 24 Jan 2024 14:26:54 +0100 Subject: [PATCH 1/3] feat: add Docker-hub documentation --- .github/workflows/mapstore.yml | 10 +++++++ DOCKER_HUB.md | 52 ++++++++++++++++++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 DOCKER_HUB.md diff --git a/.github/workflows/mapstore.yml b/.github/workflows/mapstore.yml index d144f39fd..161e8deb2 100644 --- a/.github/workflows/mapstore.yml +++ b/.github/workflows/mapstore.yml @@ -115,3 +115,13 @@ jobs: if: contains(github.ref, 'refs/tags/') && github.repository == 'georchestra/mapstore2-georchestra' && github.event_name == 'push' run: | docker push georchestra/mapstore:${{ steps.version.outputs.VERSION }} + + - name: "Update Docker Hub Description" + if: github.ref == 'refs/heads/master' && github.repository == 'georchestra/mapstore2-georchestra' && 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/mapstore + readme-filepath: ./DOCKER_HUB.md + short-description: 'Mapstore module for geOrchestra SDI' diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md new file mode 100644 index 000000000..96f4e2763 --- /dev/null +++ b/DOCKER_HUB.md @@ -0,0 +1,52 @@ +# Quick reference + +- **Maintained by**: + [georchestra.org](https://www.georchestra.org/) + +- **Where to get help**: + the [Georchestra Github repo](https://github.com/georchestra/georchestra), [Matrix chat](https://matrix.to/#/#georchestra:libera.chat), Stack Overflow + +# Featured tags + +- `latest`, `2022.02.02-geOrchestra` + +# Quick reference + +- **Where to file issues**: + [https://github.com/georchestra/georchestra/issues](https://github.com/georchestra/georchestra/issues) + [https://github.com/geosolutions-it/MapStore2/issues](https://github.com/geosolutions-it/MapStore2/issues) + +- **Supported architectures**: + [`amd64`](https://hub.docker.com/r/amd64/docker/) + +- **Source of this description**: + [docs repo's directory](https://github.com/georchestra/mapstore2-georchestra/blob/master/DOCKER_HUB.md) + +# What is `georchestra/mapstore` + +**Mapstore** is a module for geOrchestra which offers +- an highly modular Open Source WebGIS framework to create, manage and securely share maps and mashups. + + + +# How to use this image + +As for every other geOrchestra webapp, its configuration resides in the data directory ([datadir](https://github.com/georchestra/datadir)), typically something like /etc/georchestra, where it expects to find a mapstore sub-directory. + +It is recommended to use the official docker composition: https://github.com/georchestra/docker. + +For this specific component, see the section `mapstore` in the [`georchestra/docker/docker-compose.yml`](https://github.com/georchestra/docker/blob/master/docker-compose.yml) file. + +## Where is it built + +This image is build using Dockerfile in `georchestra/georchestra-mapstore` repo. + +# 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 87a4c6e23c1d48c63317012393e364ad9bf98bd5 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Thu, 25 Jan 2024 16:54:24 +0100 Subject: [PATCH 2/3] Update matrix to kiwi --- DOCKER_HUB.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index 96f4e2763..c2565c719 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), [Matrix chat](https://matrix.to/#/#georchestra:libera.chat), 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 From 7aeb03e5411904e11c8fba8f497b9cb9f8e0d772 Mon Sep 17 00:00:00 2001 From: f-necas <39771412+f-necas@users.noreply.github.com> Date: Thu, 8 Feb 2024 10:54:54 +0100 Subject: [PATCH 3/3] docs: update with recommendations --- .github/workflows/mapstore.yml | 2 +- DOCKER_HUB.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/mapstore.yml b/.github/workflows/mapstore.yml index 161e8deb2..9b8b7d00c 100644 --- a/.github/workflows/mapstore.yml +++ b/.github/workflows/mapstore.yml @@ -124,4 +124,4 @@ jobs: password: ${{ secrets.DOCKER_HUB_PASSWORD }} repository: georchestra/mapstore readme-filepath: ./DOCKER_HUB.md - short-description: 'Mapstore module for geOrchestra SDI' + short-description: 'Mapstore module for the geOrchestra SDI' diff --git a/DOCKER_HUB.md b/DOCKER_HUB.md index c2565c719..808314a7a 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 @@ -39,7 +39,7 @@ For this specific component, see the section `mapstore` in the [`georchestra/doc ## Where is it built -This image is build using Dockerfile in `georchestra/georchestra-mapstore` repo. +This image is built using Dockerfile in `georchestra/georchestra-mapstore` repo. # License @@ -49,4 +49,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.