search

argoproj / argo-workflows

Workflow Engine for Kubernetes
https://argo-workflows.readthedocs.io/
Apache License 2.0
15.06k stars 3.2k forks source link

Add descriptions for steps that can show up in ui #2871

Open HumairAK opened 4 years ago

HumairAK commented 4 years ago

Summary

Add step description field that can add human readable descriptions about the step.

Motivation

We make the ui available for others on our teams to view, but they do not necessarily have the full technical understanding of what the workflow is doing. It would be great if instead we could offer them a description of a step when they click on it to get a summary of what the step is doing.

Proposal

Not sure, but I'd imagine the end result would be an additional field within templates.steps when designing a workflow.

alexec commented 4 years ago

This sounds useful, and there is "display name" for a step. Have you set that?

HumairAK commented 4 years ago

Is that separate from the name field within a step? I.e. the name you see in the ui on workflow square icon? Those get truncated after exceeding a certain number of characters. I was thinking more along the lines of a way to click the specific step then be able to see a more detailed description in a form of a sentence or paragraph - if that makes sense.

alexec commented 4 years ago

Sounds good too. Would you like to raise a PR?

alexec commented 4 years ago

I would recommend you make your workflows and template compatibly with the template catalog by using the annotations:

apiVersion: argoproj.io/v1alpha1
kind: WorkflowTemplate
metadata:
  annotations:
    workflows.argoproj.io/description: This is a basic catalog example that simply
      prints "hello argo!".
    workflows.argoproj.io/maintainer: '@alexec'
    workflows.argoproj.io/tags: example
    workflows.argoproj.io/version: '>= 2.9.0'
  name: hello-world
crenshaw-dev commented 4 years ago

Is/will the description be exposed in the UI? (For internal templates that don't get added to the Catalog.)

alexec commented 4 years ago

You can view these values via the YAML viewer. They not really considered 1st-class.

changhc commented 3 years ago

Hi @alexec, do you mean that it's not recommended to add descriptions to steps? I'm considering working on this issue and have done some basic explorations, but if you don't think we should implement this, maybe we can close this issue.