From f47cc43573eeb741fab1ce880646dd61033998cb Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Fri, 10 Jul 2026 16:13:54 +0200 Subject: [PATCH 1/3] =?UTF-8?q?feat:=20=E2=9C=A8=20add=20Welcome=20page?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _quarto.yml | 8 ------ index.qmd | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 83 insertions(+), 8 deletions(-) diff --git a/_quarto.yml b/_quarto.yml index 546c001..254ae9d 100644 --- a/_quarto.yml +++ b/_quarto.yml @@ -16,14 +16,6 @@ book: favicon: "_extensions/seedcase-project/seedcase-theme/logos/seedcase/icon.svg" search: type: textbox - body-header: | - ::: {.callout-note appearance="default"} - This guide mostly follows the [diátaxis](https://diataxis.fr/how-to-guides/) - "how-to guide" style, though not strictly. It is also a living and - constantly evolving guide that is updated as we learn and refine how we work - and develop data packages. We intend to continually update and release it, - so we don't intend that it will ever be in a state of "done". - ::: chapters: - index.qmd - part: "Overview" diff --git a/index.qmd b/index.qmd index b721b10..b298d13 100644 --- a/index.qmd +++ b/index.qmd @@ -1 +1,84 @@ # Welcome! {.unnumbered} + +::: {.content-visible when-format="html"} +{{< include /includes/_badges.qmd >}} +::: + +::: callout-caution +These documents are very much a work in progress and very much incomplete. We +work on it slowly and when we can. +::: + +There are little to no resources available online on how to develop data as a +package similar to developing software as a package, e.g. [R +packages](https://r-pkgs.org/), [Python +packages](https://packaging.python.org/), or [Rust +packages](https://doc.rust-lang.org/cargo/). There are many resources on how to +build data warehouses or data lakes/lakehouses, along with many enterprise-level +tools and platforms to build them. However, these are often overengineered and +excessively complicated for the needs within science and research. This guide is +an attempt at providing a practical how-to guide on treating data with a +"product" mindset. We walk through how to build up data following practices from +the software package development cycle so that the final "data product" (or +"data package") is findable, accessible, interoperable, and reusable +([FAIR](https://www.go-fair.org/fair-principles/)) and +[tidy](https://doi.org/10.18637/jss.v059.i10). + +::: {.callout-note appearance="default"} +This guide mostly follows the [diátaxis](https://diataxis.fr/how-to-guides/) +"how-to guide" style, though not strictly. It is a living and constantly +evolving guide that is regularly updated as we learn and refine how we work and +develop data packages. We intend to continually update and releasing it with +every update to Zenodo and as GitHub releases. We don't expect this guide to +ever be considered "done". +::: + +## Who you are as the reader + +We've written these documents considering a few people in mind who we think will +read the documents: + +- **New contributors/team members**: This is our primary audience for this + guide. If you are new to working with us on the Seedcase Project, these + documents are designed with you in mind. +- **Research software/data engineers**: If you work in another organization or + group, we write these documents to share our practices with you. You can use + this either as a guide or as a reference to help you build your own data + packages and learn how we work. + +## Contributing + +Check out our [contributing document](CONTRIBUTING.md) for information on how to +contribute to the project. + +::: content-hidden + +### Contributors + +{{< include /includes/_contributors.qmd >}} +::: + +## Changes + +Check out our [changelog](CHANGELOG.md) for information on what has changed in +each version of the guide. Previous versions can be found in the +[releases](https://github.com/seedcase-project/data-pkg-guide/releases) page of +the GitHub repository. + +::: content-hidden + + +The PDF version of the guide is also available in the releases page, as well as +the Zenodo archive. +::: + +## How the website is made + +The website and PDF (download link on the top of the website's sidebar) are +created using [Quarto](https://quarto.org) to write the material and create the +book format. [GitHub](https://github.com/) hosts the [Git](https://git-scm.com/) +repository of the material, while [GitHub +Actions](https://github.com/features/actions) builds and releases the book with +every change. [Netlify](https://www.netlify.com/) hosts the website and manages +the domain. The source material is on the +[`{{< meta gh.repo >}}`]({{< meta links.github >}}) GitHub repository. From ca73223fe794648cc8d24866aa9c9758f78dbed6 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Fri, 10 Jul 2026 16:14:53 +0200 Subject: [PATCH 2/3] =?UTF-8?q?style:=20=F0=9F=8E=A8=20reformat=20Markdown?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.qmd | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/404.qmd b/404.qmd index 87ccc8c..f759668 100644 --- a/404.qmd +++ b/404.qmd @@ -6,6 +6,7 @@ Let's get you back to greener grounds. 👉 Go to [homepage](/index.qmd). -![](/_extensions/seedcase-project/seedcase-theme/images/404.svg){fig-alt="An illustration of the number 404 surrounded by trees and mountains"} +![](/_extensions/seedcase-project/seedcase-theme/images/404.svg){fig-alt="An +illustration of the number 404 surrounded by trees and mountains"} ## Illustration by [Storyset](https://storyset.com/online) {.appendix} From ad50ccc4d780ed7dd6d5cb3989aaba3fa3c0e379 Mon Sep 17 00:00:00 2001 From: "Luke W. Johnston" Date: Mon, 13 Jul 2026 11:12:45 +0200 Subject: [PATCH 3/3] refactor: :pencil2: edits from review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com> --- index.qmd | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/index.qmd b/index.qmd index b298d13..49bb6b8 100644 --- a/index.qmd +++ b/index.qmd @@ -18,9 +18,9 @@ build data warehouses or data lakes/lakehouses, along with many enterprise-level tools and platforms to build them. However, these are often overengineered and excessively complicated for the needs within science and research. This guide is an attempt at providing a practical how-to guide on treating data with a -"product" mindset. We walk through how to build up data following practices from -the software package development cycle so that the final "data product" (or -"data package") is findable, accessible, interoperable, and reusable +"package" mindset. We walk through how to build up data following practices from +the software package development cycle so that the final "data package" (or +"data product") is findable, accessible, interoperable, and reusable ([FAIR](https://www.go-fair.org/fair-principles/)) and [tidy](https://doi.org/10.18637/jss.v059.i10). @@ -28,15 +28,14 @@ the software package development cycle so that the final "data product" (or This guide mostly follows the [diátaxis](https://diataxis.fr/how-to-guides/) "how-to guide" style, though not strictly. It is a living and constantly evolving guide that is regularly updated as we learn and refine how we work and -develop data packages. We intend to continually update and releasing it with +develop data packages. We intend to continually update and release it with every update to Zenodo and as GitHub releases. We don't expect this guide to ever be considered "done". ::: -## Who you are as the reader +## Who you are -We've written these documents considering a few people in mind who we think will -read the documents: +We've written these documents with a few types of people in mind: - **New contributors/team members**: This is our primary audience for this guide. If you are new to working with us on the Seedcase Project, these @@ -49,7 +48,7 @@ read the documents: ## Contributing Check out our [contributing document](CONTRIBUTING.md) for information on how to -contribute to the project. +contribute to this guide. ::: content-hidden @@ -68,7 +67,7 @@ the GitHub repository. ::: content-hidden -The PDF version of the guide is also available in the releases page, as well as +The PDF version of the guide is available in the releases page, as well as the Zenodo archive. ::: @@ -80,5 +79,5 @@ book format. [GitHub](https://github.com/) hosts the [Git](https://git-scm.com/) repository of the material, while [GitHub Actions](https://github.com/features/actions) builds and releases the book with every change. [Netlify](https://www.netlify.com/) hosts the website and manages -the domain. The source material is on the +the domain. The source material is in the [`{{< meta gh.repo >}}`]({{< meta links.github >}}) GitHub repository.