Giter Site home page Giter Site logo

Comments (7)

skhurana333 avatar skhurana333 commented on June 2, 2024 1

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

from argo-workflows.

agilgur5 avatar agilgur5 commented on June 2, 2024 1

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.

from argo-workflows.

Joibel avatar Joibel commented on June 2, 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

from argo-workflows.

agilgur5 avatar agilgur5 commented on June 2, 2024

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

Did that not suffice?

from argo-workflows.

skhurana333 avatar skhurana333 commented on June 2, 2024

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

from argo-workflows.

agilgur5 avatar agilgur5 commented on June 2, 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.

from argo-workflows.

skhurana333 avatar skhurana333 commented on June 2, 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

from argo-workflows.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.