argoproj / argoproj/argo-workflows

Add descriptions for steps that can show up in ui

Open
#2,871 7 comments 24 reactions 0 assignees View on GitHub
area/spec area/ui
Dominant language
Go
Stars
17k
Forks
3.7k
Avg merge
1d 20h
Merged PRs (30d)
138

Description

# 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.

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named. Start by locating the workflow template schema for templates.steps and the UI view shown when a step is selected; define how a human-readable description is stored and displayed, and verify that the selected step shows it in the summary.

Written by the indexing model from the issue text.

Assessment

Domain
backend, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.