Skip to content

feat: ✨ add Layout chapter for structure of package#9

Open
lwjohnst86 wants to merge 23 commits into
mainfrom
feat/add-layout-of-package-chapter
Open

feat: ✨ add Layout chapter for structure of package#9
lwjohnst86 wants to merge 23 commits into
mainfrom
feat/add-layout-of-package-chapter

Conversation

@lwjohnst86

Copy link
Copy Markdown
Member

Description

This lists all the files and folders within a data package, as a high-level overview of a data package but also of the book itself.

The PR is a bit on the long side, but I thought it was ok because it isn't high priority to review and merge in.

Needs a thorough review.

Checklist

  • Ran just run-all

dependabot Bot and others added 17 commits July 10, 2026 16:26
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

@signekb signekb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice overview 🌟 When reading, I thought that I might as well give some suggestions:

Comment thread .config/cog.toml
Comment thread docs/config.qmd

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this should also have been a separate PR

Comment thread .zenodo.json
Comment on lines 9 to 10

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same with these changes. Could have been in a separate PR.

Comment thread docs/layout.qmd
Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd Outdated
@github-project-automation github-project-automation Bot moved this from In Review to In Progress in Product development Jul 14, 2026

@signekb signekb left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice overview 🌟 When reading, I thought that I might as well give some suggestions:

@joelostblom joelostblom left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just some minor comments

Comment thread docs/layout.qmd
While the specific programming language doesn't *strictly* matter, we [recommend
using
Python](https://decisions.seedcase-project.org/why-python-for-data-engineering/)
for developing data packages. For this book, we'll use Python in the guide,

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be helpful to include a short motivation as to why?

Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd
├── CHANGELOG.md
├── <root-config-files>
└── <build-files>
```

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For pretty display of file trees, could we reuse the same code from soil that we used in flower and sprout?

Comment thread docs/layout.qmd Outdated
Comment on lines +90 to +94
`datapackage.json` file for the [Data Package](https://datapackage.org). While
`datapackage.json` shares the name with "data package", they are not the same
thing. The Data Package Standard (or specification) is a structured format to
storing metadata about data, but is not involved in how the data package itself
is built and developed. This file is covered in more detail in @sec-metadata.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think it would be beneficial to give our more general data package another name that is less similar to the existing Data Package standard? "Package" is maybe the nicest name, and we could make a technical point around the use of title case or not, but it will likely still be confusing to try to distinguish the two, even more so in speech. Calling it "data package" also makes it sound like we're closer to the datapackage.json standard than e.g. data-dict.yaml or anything else that would be developed in this space. This is currently true but more as a historical artifact and if we intentionally want to distance ourselves from that standard, we might benefit from a different name.

A different name would of course include more work to change wording elsewhere compared sticking to our current mixed use of "Data Package" and "data package" in the docs which doesn't stand out as obviously when used interchangeable even if they technically are different things. I'm not saying that we need or even should do this, I'm just bringing it up for discussion since the seedcase project has evolved to be less tightly couple to the Data Package standard the it was initially and I'm wondering if there would be benefits to the name reflecting that. It depends on how important you think the distinction is from the already existing Data Package standard. Some possible suggestions, none feel perfect:

Data project
Data bundle
Data product
Data artifact
Data repository
Data collection
Data capsule
Data pod
Data module
Data distribution

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although I actually really like the name "data package" bc it feels very clear in terms of what it is, you do have a point. Maybe open an issue for this discussion?
I think that "data pod" is pretty cute 🌱 🌷 despite it not being as clear as "data package".

Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd
├── requests/ # Optional
├── docs/
├── <metadata-format>.<extension>
├── pyproject.toml

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Above we said that the use of python is recommended, ie not required. However, here we say that pyproject.toml is required. Changing one of them would make it more clear what we expect, and it is probably the sentence above since we talk about several other python files later.

Comment thread docs/layout.qmd Outdated
Comment thread docs/layout.qmd Outdated
in software projects.

- The `README.md` file, as it name suggests, is the first file any person should
read when checking out the project.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Include a sentence about what it contains like for the other bullets?

Comment thread docs/layout.qmd Outdated
lwjohnst86 and others added 2 commits July 16, 2026 15:02
Co-authored-by: Joel Ostblom <joelostblom@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

3 participants