docs: 📝 Elaborate on what is needed to create a data package and its package-level metadata #1592
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding additional sections and trying to explain more clearly what each step does
Draws more attention to it without interupting the flow
I'm unsure if we should use the `important` callout everywhere or try to use `note` more, so that not everything is marked as `important`
Setting `output: asis` makes quarto try to render the printed text as markdown. I think this makes it much easier to see what is important in the script and looks less intimidating than a raw print outupt.
This will later be moved to another page in the guide
…te test I'm not sure if there was additional utility in the metadata in the separate file, but I think it mages sense to test with the same metadata in the guide to make sure that it works
And remind people never to edit this file manually
Breaking these up into two sections makes it less overwhelming at first glance.
See 68e2610 for details
Just to make it clearer what I change in the following commits
To point out some of the things more explicitly to the reader.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This is an attempt to elaborate and clarify what is needed to get started with creating a data package and manage its package-level metadata. There are more motivation behind the individual changes in the commit descriptions. It's a larger PR, but since the changes are related for these two doc pages, I thought it made sense to keep it as one instead of splitting it up.
Closes #1573 closes #1575 closes #1576 closes #1115
Needs an in-depth review.
Checklist
just run-all