#Dagger Quick Start - Looking for feedback
1 messages · Page 1 of 1 (latest)
@mental cargo The quick start guide follows some of the feedback that you provided a couple weeks ago. Would love your thoughts on this new structure.
I'm running through the quickstart using Go. In the "Install the Dagger SDK" section it says to
"In the ci directory, create a new Go module and install the Dagger Go SDK using the commands below:"
But the commands are run from the parent directory in the subsequent sections and they fail because there's no go.mod in the parent.
ci/main.go:8:2: no required module provides package dagger.io/dagger: go.mod file not found in current directory or any parent directory; see 'go help modules'
Am I doing something silly?
Immediately point from me: I didn't even realise node/python were options, the headings for those tabs are too 'text' and not enough 'link'
appreciate the feedback <3. cc @balmy olive
This is a really good update to the docs though, this certainly would have helped me when I started experimenting with Dagger.
The pages after "Publish the application" don't seem to belong in the quickstart section, these are more scenario-based examples - someone looking to use Dagger to build a dockerfile who sees the quickstart is building and exporting a react app might not follow the guide and get to the information they need. It looks like the nav bar is set-up to allow for new headings so I'd put them under a different heading than 'Quickstart'
@rugged fulcrum is the In the ci directory part supposed to be there on this page? https://devel.docs.dagger.io/628381/quickstart-sdk/
Solely because I've spent a good bit of time on this for my own experiments replicating parts of a Gitlab yml pipeline in Dagger, a guide on 'Working with Secrets & Environment Variables' is going to help a lot of curious people. Every company's CICD pipeline uses environment variables and secrets one way or another, whether it's accounts, environments, feature testing, passwords, credentials, tokens, whatever.
@autumn zealotyes https://github.com/dagger/dagger/pull/4500
https://github.com/dagger/dagger/issues/4501 created an issue to track that new guide. Thanks for the feedback @mental cargo !
Feedback: I'd like to see some of the grouping concepts built into the quickstart guide too. If not right now, when that stuff (Pipeline(name)) is fully integrated with the SDKs.
@rugged fulcrum @autumn zealot I've added clearer instructions about how to run the pipeline on each page, also a note regarding npm test as you suggested in the same PR
@mental cargo thank you very much for the feedback. Your observation regarding the last 3 steps is correct. Those steps (which are indeed scenario-based examples) build on the pipeline created in the previous steps, so it's a bit difficult to have them as independent sections. Did you have a specific idea in mind for the headings you describe?
An alternative might be to have additional guides for some of those scenarios eg. the Dockerfile build one...
Nothing in particular no, but I'd have thought stating they use the quickstart pipeline as a base and linking to it would suffice. By that stage I imagine users won't need the quickstart, they need need to see e.g. how to use a private git service, or how to safely move secrets etc.
There's no need to move stuff around yet though, see how others feel about it - I might just be picking at something with no meaningful change necessary!
The idea of adding those final 3 steps to the quickstart was to introduce slightly more complex yet common tasks, to give users a flavor of the other capabilities available in Dagger. Yes, will wait to get more feedback as you suggest. Thanks!