Skip to content

docs: Provide more examples on client: commands and platform#2668

Merged
jpadams merged 1 commit into
dagger:mainfrom
helderco:issue-1890
Jun 21, 2022
Merged

docs: Provide more examples on client: commands and platform#2668
jpadams merged 1 commit into
dagger:mainfrom
helderco:issue-1890

Conversation

@helderco
Copy link
Copy Markdown
Contributor

@helderco helderco commented Jun 17, 2022

Resolves #1890

👀 Preview

Signed-off-by: Helder Correia

Signed-off-by: Helder Correia <174525+helderco@users.noreply.github.com>
@helderco helderco requested a review from a team as a code owner June 17, 2022 15:52
@helderco helderco requested review from dolanor and shykes June 17, 2022 15:52
@TomChv TomChv added the area/documentation Improvements or additions to documentation label Jun 18, 2022
@jpadams
Copy link
Copy Markdown
Contributor

jpadams commented Jun 18, 2022

@helderco Love these improvements.
The only thing I'd add regarding output fields is that they have to be generated fields (or whatever best term is) instead of concrete fields, right?

Some users might be confused that they didn't get output for out1 below:

dagger.#Plan & {
    actions: {
        build: {
            out1: "hello"
            _nop: core.#Nop & {input: "helloNop"}
            out2: _nop.output
        }
    }
}
$ dagger do build
[✔] actions.build                                                           0.0s
Field  Value
out2   "helloNop"

@helderco
Copy link
Copy Markdown
Contributor Author

Yes, but non-output fields are private in these examples, so I don't see the confusion.

Copy link
Copy Markdown
Contributor

@samalba samalba left a comment

Choose a reason for hiding this comment

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

Agreed with Helder, LGTM.

@jpadams
Copy link
Copy Markdown
Contributor

jpadams commented Jun 21, 2022

Yes, but non-output fields are private in these examples, so I don't see the confusion.

I have no issues with your examples :) If folks follow them, they will do well. 👍

I mean that I don't think there is anywhere in the docs where it is stated that the output fields must be generated fields. We should say that somewhere. Why not here? :)

I can follow with a PR. I thought that since you'd been looking at these docs you might have best opinion on where to put that statement.

@jpadams jpadams merged commit aa0c649 into dagger:main Jun 21, 2022
@helderco
Copy link
Copy Markdown
Contributor Author

I think the proper place for that is in https://docs.dagger.io/1228/handling-outputs

@helderco helderco deleted the issue-1890 branch July 1, 2022 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

client doc: reference on how to use stdin/stdout

4 participants