Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 revise package guide to "local-first" #1109

Merged
merged 6 commits into from
Mar 10, 2025

Conversation

lwjohnst86
Copy link
Member

Description

To match our "local-first" approach.

Closes #1086

This PR needs an in-depth review.

Checklist

  • Updated documentation
  • Ran just run-all

@lwjohnst86 lwjohnst86 requested a review from a team as a code owner March 6, 2025 11:38
Copy link
Member

@signekb signekb left a comment

Choose a reason for hiding this comment

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

Nice. I have some suggestions and questions 😁


With that in mind, let's make our first data package! A data package
always needs a `datapackage.json` file. This file contains a set of
properties, or metadata, about the data package and, eventually, about
Copy link
Member

Choose a reason for hiding this comment

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

With the first mention of properties here, we could include a link to the glossary/definition.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yea, I want to make that glossary repo and than go through all our repos and link to the glossary. But that's later since we don't have that set up yet.

Copy link
Member

Choose a reason for hiding this comment

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

For now, you could add a link to the glossary we currently have?

lwjohnst86 and others added 3 commits March 6, 2025 18:24
updated_package_properties = sp.edit_package_properties(
path=package_path,
sp.edit_package_properties(
path=sp.path_properties(path=package_path),
Copy link
Member Author

Choose a reason for hiding this comment

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

I realized this doesn't build now because it depends on #1114

@lwjohnst86 lwjohnst86 requested a review from signekb March 6, 2025 17:50
@lwjohnst86 lwjohnst86 merged commit bf4a6ed into main Mar 10, 2025
1 check passed
@lwjohnst86 lwjohnst86 deleted the docs/update-package-guide branch March 10, 2025 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Revise package guide to use "local-first" approach
2 participants