Skip to content

Commit

Permalink
docs: update with recommendations
Browse files Browse the repository at this point in the history
  • Loading branch information
f-necas authored Feb 8, 2024
1 parent 59ecf55 commit b7a9a76
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ jobs:
username: ${{ secrets.DOCKER_HUB_USERNAME }}
password: ${{ secrets.DOCKER_HUB_PASSWORD }}
repository: georchestra/gn-cloud-ogc-api-records-service
readme-filepath: ./DOCKER_HUB.md
short-description: 'OGC API Records module for geOrchestra SDI'
readme-filepath: ./DOCKER_HUB_ogc.md
short-description: 'OGC API Records module for the geOrchestra SDI'

- name: "Update Docker Hub Description for GN cloud Searching"
if: github.ref == 'refs/heads/geor-main' && github.repository == 'georchestra/geonetwork-microservices' && github.actor != 'dependabot[bot]' && github.event_name != 'pull_request'
Expand All @@ -79,5 +79,5 @@ jobs:
username: ${{ secrets.DOCKER_HUB_USERNAME }}
password: ${{ secrets.DOCKER_HUB_PASSWORD }}
repository: georchestra/gn-cloud-searching
readme-filepath: ./DOCKER_HUB.md
short-description: 'GN cloud searching module for geOrchestra SDI'
readme-filepath: ./DOCKER_HUB_searching.md
short-description: 'GN cloud searching module for the geOrchestra SDI'
6 changes: 3 additions & 3 deletions DOCKER_HUB_ogc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -38,7 +38,7 @@ For this specific component, see the section `ogc-api-records` in the [`georches

## Where is it built

This image is build using the Dockerfile : `Dockerfile-ogc-api-records` in the repo https://github.com/georchestra/geonetwork-microservices/.
This image is built using the Dockerfile : `Dockerfile-ogc-api-records` in the repo https://github.com/georchestra/geonetwork-microservices/.

# License

Expand All @@ -48,4 +48,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.
7 changes: 3 additions & 4 deletions DOCKER_HUB_searching.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -37,7 +37,7 @@ It is recommended to use the official docker composition: https://github.com/geo

## Where is it built

This image is build using the Dockerfile : `Dockerfile-searching` in the repo https://github.com/georchestra/geonetwork-microservices/.
This image is built using the Dockerfile : `Dockerfile-searching` in the repo https://github.com/georchestra/geonetwork-microservices/.

# License

Expand All @@ -46,5 +46,4 @@ View [license information](https://www.georchestra.org/software.html) for the so
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.
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.

0 comments on commit b7a9a76

Please sign in to comment.