Skip to content

Commit

Permalink
Version 1.1.5, Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Bayr committed Jul 8, 2024
1 parent b869984 commit 625f692
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 48 deletions.
9 changes: 5 additions & 4 deletions .github/workflows/edge-sddi-urban.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,10 @@ jobs:
with:
images: |
${{ env.REGISTRY }}/it-at-m/ckan-${{ matrix.context }}
flavor: latest=true
tags: |
type=edge,branch=sddi-urban-2.9.9,suffix=-2.9.9-dev
type=raw,value=udp-katalog-1.1.5-dev
type=edge,branch=sddi-urban-2.9.9,suffix=-2.9.9
type=raw,value=udp-katalog-1.1.5
labels: |
maintainer=it@m, Landeshauptstadt Muenchen (LHM)
org.opencontainers.image.vendor=it@m, Landeshauptstadt Muenchen (LHM)
Expand All @@ -64,8 +65,8 @@ jobs:
images: |
${{ env.REGISTRY }}/it-at-m/ckan-${{ matrix.context }}
tags: |
type=edge,branch=sddi-urban-2.9.9,suffix=-2.9.9-debug-dev
type=raw,value=udp-katalog-1.1.5-debug-dev
type=edge,branch=sddi-urban-2.9.9,suffix=-2.9.9-debug
type=raw,value=udp-katalog-1.1.5-debug
labels: |
maintainer=it@m, Landeshauptstadt Muenchen (LHM)
org.opencontainers.image.vendor=it@m, Landeshauptstadt Muenchen (LHM)
Expand Down
55 changes: 15 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ See [packages](https://github.com/orgs/tum-gis/packages?repo_name=ckan-docker) f
- [`sddi-base`](#sddi-base)
- [`sddi`](#sddi)
- [`sddi-social`](#sddi-social)
- [`sddi-urban`](#sddi-urban)
- [:1234: Image versioning](#1234-image-versioning)
- [Development image versions](#development-image-versions)
- [CKAN and CKAN extension versions](#ckan-and-ckan-extension-versions)
Expand All @@ -73,7 +72,6 @@ exists in this repository, where the image can be pulled.
docker pull ghcr.io/tum-gis/ckan-sddi-base
docker pull ghcr.io/tum-gis/ckan-sddi
docker pull ghcr.io/tum-gis/ckan-sddi-social
docker pull ghcr.io/tum-gis/ckan-sddi-urban

```

Expand Down Expand Up @@ -106,20 +104,6 @@ for moderation of social media content.
ghcr.io/tum-gis/ckan-sddi-social
```

### `sddi-urban`

`sddi-base` + some CKAN extensions for extended data and resource preview and description options,
extended import-/ export, harvesting, and security support. Some extensions from `sddi-base`
are installed but deactivated. These could be easily reactivated by including them into the
plugin list in ckan configuration.
This image also includes a slightly different set of preinstalled SDDI groups and topics as
well as the option of custom theming and a custom metadata schema, inspired by the requirements
of Landeshauptstadt München (LHM).

```text
ghcr.io/tum-gis/ckan-sddi-urban
```

## :1234: Image versioning

The images in this repo are versioned and tagged according to the
Expand All @@ -132,7 +116,6 @@ All available tags are listed in the packages of each image:
- [`sddi-base`](https://github.com/tum-gis/ckan-docker/pkgs/container/ckan-sddi-base)
- [`sddi`](https://github.com/tum-gis/ckan-docker/pkgs/container/ckan-sddi)
- [`sddi-social`](https://github.com/tum-gis/ckan-docker/pkgs/container/ckan-sddi-social)
- [`sddi-urban`](https://github.com/tum-gis/ckan-docker/pkgs/container/ckan-sddi-urban)

### Development image versions

Expand Down Expand Up @@ -194,29 +177,21 @@ are alway pinned to a stable release number or commit hash.
> **Note:** Version pinning is only applied for release versions. The `edge`
> image may depend on upstream branches instead.
| Extension | Version | `sddi-base` | `sddi` | `sddi-social` | `sddi-urban` | Description |
|---|---|:---:|:---:|:---:|:---:|---|
| [`scheming`](https://github.com/MarijaKnezevic/ckanext-scheming), [`scheming (sddi-urban)`](https://github.com/gislab-augsburg/ckanext-scheming) | `f98daec`, `a7fdd9c`| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Configure and share CKAN dataset metadata forms. |
| [`hierarchy`](https://github.com/ckan/ckanext-hierarchy) | `v1.2.0` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Allows to organize organizations and groups in a hierarchy tree (nested groups/orgs). |
| [`grouphierarchysddi`](https://github.com/tum-gis/ckanext-grouphierarchy-sddi) | `1.1.3` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | Extends `hierarchy` with pre-defined groups and topics of the SDDI concept. |
| [`relation`](https://github.com/tum-gis/ckanext-relation-sddi) | `1.0.3` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | Enables to create and visualize different types of relations (*realated_to*, *depends_on*, *part_of*) between catalog entries. |
| [`spatial`](https://github.com/MarijaKnezevic/ckanext-spatial) | `c2118b9` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Provides the ability to search for datasets according to a given spatial extent. |
| [`datesearch`](https://github.com/MarijaKnezevic/ckanext-datesearch) | `1.0.2` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | Provides the ability to search for datasets according to a given time frame. The search includes all datasets, in which the time of validity overlaps in at least one second with the search time frame. |
| [`repeating`](https://github.com/MarijaKnezevic/ckanext-repeating) | `1.0.0` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | This extension provides a way to store repeating fields in CKAN datasets, resources, organizations and groups. |
| [`composite`](https://github.com/EnviDat/ckanext-composite) | `1e6d7bb` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | The extension allows to store structured dataset metadata, single or multiple fields. Only one level of subfields is possible. The subfields can be basic text, date type or dropboxes. |
| [`restricted`](https://github.com/MarijaKnezevic/ckanext-restricted) | `1.0.0` | | :heavy_check_mark: | :heavy_check_mark: | | CKAN extension to restrict the accessibility to the resources of a dataset. This way the package metadata is accesible but not the data itself (resource). The resource access restriction level can be individualy defined for every package. |
| [`dcat`](https://github.com/ckan/ckanext-dcat) | `v1.4.0` | | :heavy_check_mark: | :heavy_check_mark: | | Allow CKAN to expose and consume metadata from other catalogs using RDF documents serialized using DCAT. |
| [`geoview`](https://github.com/ckan/ckanext-geoview) | `v0.0.20` | | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | This extension contains view plugins to display geospatial files and services in CKAN. |
| [`disqus`](https://github.com/ckan/ckanext-disqus) | | | | :heavy_check_mark: | | The Disqus extension allows site visitors to comment on individual packages using an AJAX-based commenting system. The downsides of this plugin are that comments are not stored locally and user information is not shared between CKAN and the commenting system. |
| [`password_policy`](https://github.com/keitaroinc/ckanext-password-policy) | `5618dc9`|:heavy_check_mark: |:heavy_check_mark:| :heavy_check_mark: | :heavy_check_mark: | CKAN extension that adds password policy for all the users. |
| [`resourcedictionary`](https://github.com/keitaroinc/ckanext-resourcedictionary) | `v1.0.0` | | | | :heavy_check_mark: | Extends the default CKAN Data Dictionary functionality by adding possibility to create data dictionary before actual data is uploaded to datastore. |
| [`xloader`](https://github.com/ckan/ckanext-xloader) | `1.0.1` | | | | :heavy_check_mark: | Provides a faster and more robust way to load data into CKAN's DataStore. |
| [`lhm`](https://github.com/MandanaMoshref/ckanext-lhm) | `d258e1f` | | | | :heavy_check_mark: | Adds options for a custom metadata schema, custom theming and an adapted set of groups and topics, provided by Landeshauptstadt München (LHM). |
| [`harvest`](https://github.com/ckan/ckanext-harvest) | `v1.5.6` | | | | :heavy_check_mark: | Provides a framework and management tools for automatic harvesting of other metatdata catalogs. |
| [`glab`](https://github.com/gislab-augsburg/ckanext-glab/tree/gdpr) | `0612d22` | | | | :heavy_check_mark: | Adds extended security and GDPR features. |
| [`iso`](https://github.com/gislab-augsburg/ckanext-iso) | `c4c28a8` | | | | :heavy_check_mark: | Adapts csw harvester from ckanext-spatial to requirements for harvesting LHM Geoportal. |
| [`keycloak`](https://github.com/keitaroinc/ckanext-keycloak) | `v2.1` | | | | :heavy_check_mark: | Enables Single Sign-On with keycloak |

| Extension | Version | `sddi-base` | `sddi` | `sddi-social` | Description |
|---|---|:---:|:---:|:---:|---|
| [`scheming`](https://github.com/MarijaKnezevic/ckanext-scheming) | `f98daec` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Configure and share CKAN dataset metadata forms. |
| [`hierarchy`](https://github.com/ckan/ckanext-hierarchy) | `v1.2.0` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Allows to organize organizations and groups in a hierarchy tree (nested groups/orgs). |
| [`grouphierarchysddi`](https://github.com/tum-gis/ckanext-grouphierarchy-sddi) | `1.1.4` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Extends `hierarchy` with pre-defined groups and topics of the SDDI concept. |
| [`relation`](https://github.com/tum-gis/ckanext-relation-sddi) | `1.0.3` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Enables to create and visualize different types of relations (*realated_to*, *depends_on*, *part_of*) between catalog entries. |
| [`spatial`](https://github.com/MarijaKnezevic/ckanext-spatial) | `c2118b9` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Provides the ability to search for datasets according to a given spatial extent. |
| [`datesearch`](https://github.com/MarijaKnezevic/ckanext-datesearch) | `1.0.2` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | Provides the ability to search for datasets according to a given time frame. The search includes all datasets, in which the time of validity overlaps in at least one second with the search time frame. |
| [`repeating`](https://github.com/MarijaKnezevic/ckanext-repeating) | `1.0.0` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | This extension provides a way to store repeating fields in CKAN datasets, resources, organizations and groups. |
| [`composite`](https://github.com/EnviDat/ckanext-composite) | `1e6d7bb` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | The extension allows to store structured dataset metadata, single or multiple fields. Only one level of subfields is possible. The subfields can be basic text, date type or dropboxes. |
| [`restricted`](https://github.com/MarijaKnezevic/ckanext-restricted) | `1.0.0` | | :heavy_check_mark: | :heavy_check_mark: | CKAN extension to restrict the accessibility to the resources of a dataset. This way the package metadata is accesible but not the data itself (resource). The resource access restriction level can be individualy defined for every package. |
| [`dcat`](https://github.com/ckan/ckanext-dcat) | `v1.4.0` | | :heavy_check_mark: | :heavy_check_mark: | Allow CKAN to expose and consume metadata from other catalogs using RDF documents serialized using DCAT. |
| [`geoview`](https://github.com/ckan/ckanext-geoview) | `v0.0.20` | | :heavy_check_mark: | :heavy_check_mark: | This extension contains view plugins to display geospatial files and services in CKAN. |
| [`disqus`](https://github.com/ckan/ckanext-disqus) | | | | :heavy_check_mark: | The Disqus extension allows site visitors to comment on individual packages using an AJAX-based commenting system. The downsides of this plugin are that comments are not stored locally and user information is not shared between CKAN and the commenting system. |
| [`password_policy`](https://github.com/keitaroinc/ckanext-password-policy) | `5618dc9`|:heavy_check_mark: |:heavy_check_mark:| :heavy_check_mark: | CKAN extension that adds password policy for all the users. |

## :rocket: Usage

Expand Down
8 changes: 4 additions & 4 deletions sddi-urban/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">SDDI CKAN Docker, additional image sddi-urban</h1>

This directory provides an additional [CKAN](https://github.com/ckan) Docker images for the
This directory provides an additional [CKAN](https://github.com/ckan) Docker image for the
[`sddi-ckan-k8s`](https://github.com/tum-gis/sddi-ckan-k8s) Helm chart.
The images contain CKAN itself compiled with a set of CKAN extension to add functionality required for
the SDDI concept and beyond that.
Expand All @@ -18,7 +18,8 @@ the SDDI concept and beyond that.

## :inbox_tray: Image flavor overview

The CKAN-SDDI Docker images are released in three flavors, that are described below.
The CKAN-SDDI Docker images are originally released in different flavors, that are described in the
[Readme](https://github.com/tum-gis/sddi-ckan-k8s). With `sddi-base`, another flavor is added.
For each flavor a one [package](https://github.com/orgs/tum-gis/packages?repo_name=ckan-docker)
exists in this repository, where the image can be pulled.

Expand All @@ -34,7 +35,7 @@ extended import-/ export, harvesting, and security support. Some extensions from
are installed but deactivated. These could be easily reactivated by including them into the
plugin list in ckan configuration.
This image also includes a slightly different set of preinstalled SDDI groups and topics as
well as the option of custom theming and a custom metadata schema, inspired by the requirements
well as the option of custom theming and custom metadata schemas, inspired by the requirements
of Landeshauptstadt München (LHM).

```text
Expand Down Expand Up @@ -90,7 +91,6 @@ are alway pinned to a stable release number or commit hash.
| [`harvest`](https://github.com/ckan/ckanext-harvest) | `v1.5.6` | | | | :heavy_check_mark: | Provides a framework and management tools for automatic harvesting of other metatdata catalogs. |
| [`glab`](https://github.com/gislab-augsburg/ckanext-glab/tree/gdpr) | `0612d22` | | | | :heavy_check_mark: | Adds extended security and GDPR features. |
| [`iso`](https://github.com/gislab-augsburg/ckanext-iso) | `c4c28a8` | | | | :heavy_check_mark: | Adapts csw harvester from ckanext-spatial to requirements for harvesting LHM Geoportal. |
| [`keycloak`](https://github.com/keitaroinc/ckanext-keycloak) | `v2.1` | | | | :heavy_check_mark: | Enables Single Sign-On with keycloak |


## :rocket: Usage
Expand Down

0 comments on commit 625f692

Please sign in to comment.