docs: Adds cookbook #7301
docs: Adds cookbook #7301
Conversation
Signed-off-by: Vikram Vaswani <[email protected]>
| @@ -567,6 +567,11 @@ module.exports = { | |||
| } | |||
| ] | |||
| }, | |||
| // { | |||
There was a problem hiding this comment.
I recommend we keep this hidden until we have more content in the cookbook. See top-level comment for how to view it for testing.
There was a problem hiding this comment.
Do you want to merge this PR and we can contribute sections in separate PRs and then uncomment this in a follow up PR after?
cc @levlaz
There was a problem hiding this comment.
Do you want to merge this PR and we can contribute sections in separate PRs and then uncomment this in a follow up PR after? cc @levlaz
Yes, exactly
Signed-off-by: Vikram Vaswani <[email protected]>
Signed-off-by: Vikram Vaswani <[email protected]>
Signed-off-by: Vikram Vaswani <[email protected]>
There was a problem hiding this comment.
LGTM! OK to merge as soon as all checks pass.
If you want to +1 existing issues @vikram-dagger, it will help convey how many times we are hitting known issues, e.g.:
| </TabItem> | ||
| </Tabs> | ||
|
|
||
| Example usage: |
There was a problem hiding this comment.
This is a change from the previous cookbook. WDYT of it?
There was a problem hiding this comment.
I don't think it's necessary, but I'm not strongly against it either. It may not make sense for certain examples (which is fine) and may lead us to try to show cli-oriented examples in cookbook (which is avoidable)
There was a problem hiding this comment.
I kind of like it, but I think we should think about adding two parts here.
- Example SDK usage (maybe even show how to use in other SDKs)
- Example CLI usage (or make it clear that is what is happening)
I think this is especially important because there are some things that are different between CLI and SDK. For example, in go, optional args are not actually optional if you are using them via the SDK.
Risk here is that it is possible this becomes too verbose.
There was a problem hiding this comment.
AFAIK we are de-emphasizing the SDK use case, so IMHO we should not show that part for the moment.
There was a problem hiding this comment.
I vote ship it and we can start the migration and make a decision as we go
* docs: Adds cookbook Signed-off-by: Vikram Vaswani <[email protected]> * Lint fixes Signed-off-by: Vikram Vaswani <[email protected]> * Lint fix Signed-off-by: Vikram Vaswani <[email protected]> * Updated headings Signed-off-by: Vikram Vaswani <[email protected]> --------- Signed-off-by: Vikram Vaswani <[email protected]>
This commit adds a cookbook with sample code for common use cases. It only contains a few examples right now, to set up the initial structure, formatting etc. For the same reason, the navbar entry is hidden until we have more content.
Preview URL: https://deploy-preview-7301--devel-docs-dagger-io.netlify.app/manuals/developer/cookbook
Preview URL for local testing: /manuals/developer/cookbook