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: Add example of a containers step standard output captured in result parameter. #12961

Open
skhurana333 opened this issue Apr 22, 2024 · 7 comments · May be fixed by #12963
Open

docs: Add example of a containers step standard output captured in result parameter. #12961

skhurana333 opened this issue Apr 22, 2024 · 7 comments · May be fixed by #12963
Labels
area/docs Incorrect, missing, or mistakes in docs type/feature Feature request

Comments

@skhurana333
Copy link

skhurana333 commented Apr 22, 2024

Add one example workflow yaml for showing how the stdout of a container is captured in the result parameter

@skhurana333 skhurana333 added the type/feature Feature request label Apr 22, 2024
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
…er (argoproj#12961)

Signed-off-by: Sandeep Khurana <skhurana333@gmail.com>
@Joibel
Copy link
Member

Joibel commented Apr 22, 2024

Hi. I think you're trying to create a pull request. See this documentation for how.
https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

I'm aware of your slack message, so if you're stuck reach out there and Tim (who already replied) or I can help

skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
…er (argoproj#12961)

Signed-off-by: Sandeep Khurana <skhurana333@gmail.com>
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
…put parameter

Signed-off-by: Sandeep Khurana <skhurana333@gmail.com>
skhurana333 pushed a commit to skhurana333/argo-workflows that referenced this issue Apr 22, 2024
…er (argoproj#12961)

Signed-off-by: Sandeep Khurana <skhurana333@gmail.com>
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Apr 22, 2024
@agilgur5
Copy link
Member

There is an example of this already: https://argo-workflows.readthedocs.io/en/latest/walk-through/scripts-and-results/

Did that not suffice?

@agilgur5 agilgur5 added the problem/more information needed Not enough information has been provide to diagnose this issue. label Apr 22, 2024
@skhurana333
Copy link
Author

this example is for step using script. What I am adding is, if step is not using script but outputting a standard output eg using echo

@agilgur5
Copy link
Member

agilgur5 commented Apr 22, 2024

script is basically just short-hand for a variant that uses a container.

Your titles and descriptions also don't mention needing to use container vs. script, they only mention using result, for which there is a page for already.

If we were to add something like that, it would be better to add to the existing "Scripts and Results" page with an explainer that script is effectively short-hand.

@skhurana333 skhurana333 changed the title docs: Add example of using outputs.result for output param from a step. docs: Add example of using outputs.result for standard output of containers step. Apr 22, 2024
@skhurana333 skhurana333 changed the title docs: Add example of using outputs.result for standard output of containers step. docs: Add example of a containers step standard output captured in result parameter. Apr 22, 2024
@skhurana333
Copy link
Author

ok. Maybe its my lack of understanding.

Page - https://argo-workflows.readthedocs.io/en/latest/walk-through/output-parameters/ has section "result output parameter". It has 2 sub sections
a) script
b) Containers

I am trying to add example under container sub-section. I changed title and description.

I think, even if script is short-hand which uses a container, but since there are two separate pages
"https://argo-workflows.readthedocs.io/en/latest/walk-through/scripts-and-results/" and
"https://argo-workflows.readthedocs.io/en/latest/walk-through/output-parameters/",

this example may help users who are reading "container" section under "result output parameter on second page.

If it does not add much to the doc then please feel free to discard, this issue can be closed as not planned. thx

@agilgur5
Copy link
Member

Ah I see what you mean, since "Scripts and Results" introduces result but does not really explain it... it's explained in the next page in "Output Parameters". Thanks for elaborating.

I can see why that would be confusing... we might actually want to move that section from "Output Parameters" and into "Scripts and Results" instead, and then your example can go there. Let me think about how to organize that better.

@agilgur5 agilgur5 removed the problem/more information needed Not enough information has been provide to diagnose this issue. label Apr 22, 2024
@skhurana333
Copy link
Author

skhurana333 commented Apr 23, 2024

we might actually want to move that section from "Output Parameters" and into "Scripts and Results" instead, and then your example can go there

Please let me know if you want me to make these or any other changes as well. thx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs type/feature Feature request
Projects
None yet
3 participants