From 8f89a4278f6abe4da0e438c09192c784abec08a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Tue, 23 Sep 2025 10:23:31 +0200 Subject: [PATCH 1/8] docs: :sparkles: add landing page --- index.qmd | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 85 insertions(+), 1 deletion(-) diff --git a/index.qmd b/index.qmd index 2769a9f..d6014d5 100644 --- a/index.qmd +++ b/index.qmd @@ -1,3 +1,87 @@ --- -title: "Welcome!" +toc: false +page-layout: custom --- + +::::: landing-page-block +:::: hero-text +::: text-center +![](_extensions/seedcase-project/seedcase-theme/logos/check-datapackage-logo.svg){fig-alt="Check datapackage logo." +width="150px"} + +![](_extensions/seedcase-project/seedcase-theme/logos/check-datapackage-font.svg){fig-alt="Check datapackage font." +height="50px"} + +## Ensure the correctness and compliance of your Data Package + +[Overview](/docs/index.qmd){.btn .about-link} [Explore +guide](/docs/guide/index.qmd){.btn .about-link} +::: +:::: +::::: + +:::: landing-page-block +::: {#hero-heading} +{{< include /docs/includes/_badges.qmd >}} +::: +:::: + +::::: hero-banner +:::: landing-page-block +::: hero-text +`check-datapackage` is a Python package that checks your data package's +metadata against the [Data Package standard](https://datapackage.org/), +helping you ensure that your metadata is both correct and compliant. + +## Key features :sparkles: + +- Checks the + [descriptor(s)](https://datapackage.org/standard/glossary/#descriptor) + in your `datapackage.json` against the Data Package standard. +- Enables you to configure which components of the descriptor(s) that + should or should not be checked. +- Supports user-defined, custom checks. +- Provides clear and user-friendly messages that point directly to + where issues occur in the descriptor(s). +- Supports a strict mode that enforces full compliance with the + standard, including all recommended fields. + +:warning: Note that `check-datapackage` only checks the descriptor(s) +against the Data Package standard---it does not check the data itself +against its descriptor(s). +::: +:::: +::::: + +::::: landing-page-block +:::: hero-text +## About the Seedcase Project + +`check-datapackage` is part of the [**Seedcase +Project**](https://seedcase-project.org), which helps research projects +manage and process data in line with the +[FAIR](https://www.go-fair.org/fair-principles/) principles. + +This package works as a standalone tool but is also integrated in +[Seedcase Sprout](https://sprout.seedcase-project.org), a Python package +that provides a framework for growing structured, organised, and FAIR +data. + +::: text-center +[Check out Sprout](https://sprout.seedcase-project.org/){.btn +.about-link} +::: +:::: +::::: + +::::: hero-banner +:::: landing-page-block +::: hero-text +## Want to contribute? + +We would love your feedback or contributions! Head over to our [GitHub +repository](https://github.com/seedcase-project/check-datapackage) to +share your ideas or contribute code. Your input makes us better! +::: +:::: +::::: From 4a1cd4f47a9dec7510c76b4189a620b2fda4947b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Tue, 23 Sep 2025 13:04:13 +0200 Subject: [PATCH 2/8] docs: :pencil2: capitalise Data Package Co-authored-by: Luke W. Johnston --- index.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.qmd b/index.qmd index d6014d5..92276ea 100644 --- a/index.qmd +++ b/index.qmd @@ -29,7 +29,7 @@ guide](/docs/guide/index.qmd){.btn .about-link} ::::: hero-banner :::: landing-page-block ::: hero-text -`check-datapackage` is a Python package that checks your data package's +`check-datapackage` is a Python package that checks your Data Package's metadata against the [Data Package standard](https://datapackage.org/), helping you ensure that your metadata is both correct and compliant. From 80bb641d811fc007188cc8c8419cfbb2d304c403 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Tue, 23 Sep 2025 15:35:37 +0200 Subject: [PATCH 3/8] docs: :pencil2: descriptor(s) -> descriptor --- index.qmd | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/index.qmd b/index.qmd index 92276ea..43bdd49 100644 --- a/index.qmd +++ b/index.qmd @@ -36,19 +36,19 @@ helping you ensure that your metadata is both correct and compliant. ## Key features :sparkles: - Checks the - [descriptor(s)](https://datapackage.org/standard/glossary/#descriptor) + [descriptor](https://datapackage.org/standard/glossary/#descriptor) in your `datapackage.json` against the Data Package standard. -- Enables you to configure which components of the descriptor(s) that +- Enables you to configure which components of the descriptor that should or should not be checked. - Supports user-defined, custom checks. - Provides clear and user-friendly messages that point directly to - where issues occur in the descriptor(s). + where issues occur in the descriptor. - Supports a strict mode that enforces full compliance with the standard, including all recommended fields. -:warning: Note that `check-datapackage` only checks the descriptor(s) +:warning: Note that `check-datapackage` only checks the descriptor against the Data Package standard---it does not check the data itself -against its descriptor(s). +against its descriptor. ::: :::: ::::: From 0aed7d4da7b2407ac4894c2480c6d03353e74c6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Tue, 23 Sep 2025 15:38:02 +0200 Subject: [PATCH 4/8] docs: :memo: add feature of turning off specific checks --- index.qmd | 1 + 1 file changed, 1 insertion(+) diff --git a/index.qmd b/index.qmd index 43bdd49..8c5c8a6 100644 --- a/index.qmd +++ b/index.qmd @@ -40,6 +40,7 @@ helping you ensure that your metadata is both correct and compliant. in your `datapackage.json` against the Data Package standard. - Enables you to configure which components of the descriptor that should or should not be checked. +- Enables you to turn off specific checks defined in the standard. - Supports user-defined, custom checks. - Provides clear and user-friendly messages that point directly to where issues occur in the descriptor. From 23e887e2129d41cf288b559ce90b16933dc057a1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Tue, 23 Sep 2025 15:52:52 +0200 Subject: [PATCH 5/8] docs: :pencil2: our -> the --- index.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.qmd b/index.qmd index 8c5c8a6..00b833d 100644 --- a/index.qmd +++ b/index.qmd @@ -80,7 +80,7 @@ data. ::: hero-text ## Want to contribute? -We would love your feedback or contributions! Head over to our [GitHub +We would love your feedback or contributions! Head over to the [GitHub repository](https://github.com/seedcase-project/check-datapackage) to share your ideas or contribute code. Your input makes us better! ::: From ae5a2df17274effb2ec9b75dedc802d988c8748f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Wed, 24 Sep 2025 13:11:24 +0200 Subject: [PATCH 6/8] docs: :pencil2: Remove "that" Suggestion by @martonvago Co-authored-by: martonvago <57952344+martonvago@users.noreply.github.com> --- index.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.qmd b/index.qmd index 00b833d..c9cbe96 100644 --- a/index.qmd +++ b/index.qmd @@ -38,7 +38,7 @@ helping you ensure that your metadata is both correct and compliant. - Checks the [descriptor](https://datapackage.org/standard/glossary/#descriptor) in your `datapackage.json` against the Data Package standard. -- Enables you to configure which components of the descriptor that +- Enables you to configure which components of the descriptor should or should not be checked. - Enables you to turn off specific checks defined in the standard. - Supports user-defined, custom checks. From bac676e8060bef18cc9e386447fc12a0472dff12 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Mon, 29 Sep 2025 15:47:44 +0200 Subject: [PATCH 7/8] docs: :pencil2: remove "correct" Apply suggestion from @lwjohnst86 Co-authored-by: Luke W. Johnston --- index.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.qmd b/index.qmd index c9cbe96..33e45ee 100644 --- a/index.qmd +++ b/index.qmd @@ -31,7 +31,7 @@ guide](/docs/guide/index.qmd){.btn .about-link} ::: hero-text `check-datapackage` is a Python package that checks your Data Package's metadata against the [Data Package standard](https://datapackage.org/), -helping you ensure that your metadata is both correct and compliant. +helping you ensure that your metadata is compliant. ## Key features :sparkles: From 0e8ee0a7597905912de8904e47007f84af09f646 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Signe=20Kirk=20Br=C3=B8db=C3=A6k?= Date: Mon, 29 Sep 2025 15:48:18 +0200 Subject: [PATCH 8/8] docs: :pencil2: "recommended fields" -> "recommendations" Apply suggestion from @signekb --- index.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.qmd b/index.qmd index 33e45ee..f4e2aad 100644 --- a/index.qmd +++ b/index.qmd @@ -45,7 +45,7 @@ helping you ensure that your metadata is compliant. - Provides clear and user-friendly messages that point directly to where issues occur in the descriptor. - Supports a strict mode that enforces full compliance with the - standard, including all recommended fields. + standard, including all recommendations. :warning: Note that `check-datapackage` only checks the descriptor against the Data Package standard---it does not check the data itself