Configuration¶

We rely on user-defined metadata to pass information to SharingHub. The metadata are always handled the same way, regardless of the project's category, although some of them are more suited for specific categories. We will not detail every feature available, for a more in-depth insight of the metadata configuration refer to our Reference.

Syntax¶

The metadata of a project are defined in its README.md file. Markdown allows a syntax for metadata, as YAML:

README.md

---
foo: bar
---

# Title

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi neque neque,
malesuada vel sodales eu, pharetra sit amet nibh. Integer in nunc ante.
Morbi commodo metus est, id aliquet odio cursus id. Ut non sagittis metus.

By using a --- delimited section at the start of your README.md, you can write metadata that will not be rendered in the project description on SharingHub. The informations here will be parsed and used to process the STAC Item of the project.

Warning

We always require a README.md file, with the uppercase file name, and in CommonMark (Markdown) format.

Usage¶

Overview¶

Name	Default value	Configuration
Title	Name of the GitLab project.	Metadata `title`.
Description	The project description is the README content for the project view, but for the project card in the list we prioritize the GitLab project description (General Settings).	-
Preview	-	Metadata `preview` or in the "README.md" as a link named "Preview".
License	-	Metadata `license` or the license detected by GitLab.
Temporal Extent	For the temporal extent the start is the datetime of the project creation, and the end is the project last activity datetime	Metadata `extent.temporal`.
Spatial Extent	-	Metadata `extent.spatial`.
Providers	The "host" provider is linked to the GitLab project URL, and the "producer" provider is the GitLab top-level namespace of the project.	Metadata `providers`.
Links	The default links are STAC recommended links, `self`, `parent`, `root`, `collection`, and a link to the project bug tracker as well as the license if one is found.	Metadata `links` and `related`. Note: values will be added and not replace defaults.
Assets	Inherit global configuration for the project's category.	Metadata `assets`.
Extensions	Inherit global configuration.	Metadata `extensions`.

Example¶

A small example to better understand the structure:

Metadata example

title: My Project
preview: https://avatars.githubusercontent.com/u/6223127
license: MIT

extent:
  temporal: ["2023-11-01T12:00:00.0", "2024-01-01T12:00:00.0"]
  spatial: [-66.5902, 17.9823, -66.6407, 18.0299]

providers:
  - name: CS Group
    roles: ["producer"]
    url: https://www.csgroup.eu
  - name: GitLab CS
    roles: ["host"]
    url: https://gitlab.example.com

related:
  ai-model: https://gitlab.example.com/<ai-model-project-repository>

assets:
  - "*.py"