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 container step standard output as parameter. Fixes #12961 #12963

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

skhurana333
Copy link

@skhurana333 skhurana333 commented Apr 22, 2024

Fixes #12961

Motivation

The documentation does not has example of showing stdout of a step as output parameter.

Modifications

An example has been added.

Verification

Ran the example, its working fine and produced expected result.

Screenshot 2024-04-22 at 5 25 26 PM

@skhurana333 skhurana333 changed the title fix(doc) : Add example of standard output of a step as output parameter. Fixes #12961 docs: Add example of standard output of a step as output parameter. Fixes #12961 Apr 22, 2024
…er (argoproj#12961)

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

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

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

The documentation does not has example of showing stdout of a step as output parameter.

This is not correct, there is an example on an adjacent page: https://argo-workflows.readthedocs.io/en/latest/walk-through/scripts-and-results/.

As such this seems redundant, and in its current state, explains less than the existing example. It also re-introduces result without a description.

@skhurana333
Copy link
Author

The documentation does not has example of showing stdout of a step as output parameter.

This is not correct, there is an example on an adjacent page: https://argo-workflows.readthedocs.io/en/latest/walk-through/scripts-and-results/.

As such this seems redundant, and in its current state, explains less than the existing example. It also re-introduces result without a description.

  1. The existing example from the link refers when a step is using the script, using source tag. And the stdout of the script is stored in result output parameter.
  2. The example provided as part of this pull request
    a). does not use source tag.
    b) its an example of
    below statement
    "Containers
    Container steps and tasks also have their standard output captured in the result parameter."

at https://argo-workflows.readthedocs.io/en/latest/walk-through/output-parameters/

c) results is already mentioned in same url above

@agilgur5 agilgur5 changed the title docs: Add example of standard output of a step as output parameter. Fixes #12961 docs: Add example of container step standard output as parameter. Fixes #12961 Apr 22, 2024
@agilgur5
Copy link
Member

agilgur5 commented Apr 22, 2024

That rationale makes more sense -- you didn't mention the container portion in your descriptions or titles initially. I've modified the title to make that clear.

Otherwise, see my comment in the issue, we may want to move the entire "result" section out of this page and into the other page (including your example).

@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Apr 22, 2024
@agilgur5 agilgur5 self-assigned this Apr 22, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Add example of a containers step standard output captured in result parameter.
2 participants