diff --git a/.spelling b/.spelling index d0109eae1517..0940166f68d0 100644 --- a/.spelling +++ b/.spelling @@ -217,6 +217,7 @@ v3.3 v3.3. v3.4 v3.4. +v3.4.4 validator versioning webHDFS diff --git a/docs/assets/workflow-title-and-description.png b/docs/assets/workflow-title-and-description.png new file mode 100644 index 000000000000..799c2a1e7e61 Binary files /dev/null and b/docs/assets/workflow-title-and-description.png differ diff --git a/docs/title-and-description.md b/docs/title-and-description.md new file mode 100644 index 000000000000..eb88798b74fc --- /dev/null +++ b/docs/title-and-description.md @@ -0,0 +1,18 @@ +# Title and Description + +> v3.4.4 and after + +You can add the `workflows.argoproj.io/title` and `workflows.argoproj.io/description` annotations to a Workflow to display in the workflow lists: + +```yaml +apiVersion: argoproj.io/v1alpha1 +kind: Workflow +metadata: + name: my-wf + annotations: + workflows.argoproj.io/title: 'Build and test' # defaults to `metadata.name` if not specified + workflows.argoproj.io/description: 'SuperDuperProject PR #6529: Implement frobbing (aff39ee)' +``` + +The above manifest will render as a row like the below image: +![Title and Description Example](assets/workflow-title-and-description.png) diff --git a/mkdocs.yml b/mkdocs.yml index 5287fce59dfe..ef4676aac893 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -123,6 +123,7 @@ nav: - artifact-visualization.md - widgets.md - intermediate-inputs.md + - title-and-description.md - Debugging Tools: - workflow-events.md - debug-pause.md