Pipeline input description

[gaoning777]

Displaying the descriptions of the input parameters by the pipeline authors such that pipeline users get a better understanding of them

[Ark-kun]

This issue has two parts:

1. The language to specify the descriptions in a pipeline defined using Python.
2. The way to pass this information to the UI. For this part I propose passing the Component metadata and interface specs inside Argo template annotation. See Add component metadata to the generated Argo YAML for consumption by the UI #452

[gaoning777]

@Ark-kun Is the input description already in the pipeline metadata section?

[Ark-kun]

This issue tracks the UX part of the feature.

[Ark-kun]

Is the input description already in the pipeline metadata section?

Yes.

[Ark-kun]

We need to think of a way to specify the descriptions in a pipeline defined using Python.
Maybe docstring parsing can work.

[Ark-kun]

The core issue is that we need to invent a way for pipeline authors to specify input descriptions.

Maybe we can use some docstring parser.

[Bobgy]

@Ark-kun It's not very clear to me how much is left preparing data to UI

[Ark-kun]

@Ark-kun It's not very clear to me how much is left preparing data to UI

I guess we need to design the syntax first. The Frontend is already getting the descriptions (in annotation), but they're always missing/empty.

[Bobgy]

Thanks, so there's some dsl-compiler work left to define how description is included in annotation. Is my understanding correct? I will fill in the UI part after it's ready.

[gaoning777]

/unassign @gaoning777

[Ark-kun]

I think the issue and #2621 are kind of related.

That PR is more actionable, since the way to specify the pipeline parameter types already exists (and the information is available to FE).

I think we probably need more user signal.

I agree.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically closed because it has not had recent activity. Please comment "/reopen" to reopen it.

[Bobgy]

/frozen
this seems very useful

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically closed because it has not had recent activity. Please comment "/reopen" to reopen it.

[Bobgy]

/reopen
/lifecycle frozen

[google-oss-robot]

@Bobgy: Reopened this issue.

In response to this:

/reopen
/lifecycle frozen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[rimolive]

Closing this issue. No activity for more than a year.

/close

[google-oss-prow]

@rimolive: Closing this issue.

In response to this:

Closing this issue. No activity for more than a year.

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.