docs: Add example of a containers step standard output captured in result parameter.
skhurana333 opened this issue · comments
Add one example workflow yaml for showing how the stdout of a container is captured in the result parameter
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
There is an example of this already: https://argo-workflows.readthedocs.io/en/latest/walk-through/scripts-and-results/
Did that not suffice?
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
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.
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
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.
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