docs: add missing title & description page

- this is a partial backport of 7a23cb0, specifically only the docs for _existing_ features - this is a useful feature that was previously undocumented Signed-off-by: Anton Gilgur <[email protected]> (cherry picked from commit a34d989)
argoproj · Sep 21, 2024 · 4a521a5 · 4a521a5
1 parent 464965c
commit 4a521a5
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git 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
diff --git a/docs/title-and-description.md 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
@@ -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
-Original file line number
+Diff line change
@@ Expand Up / @@ -217,6 +217,7 @@ v3.3 @@
     v3.3.
     v3.4
     v3.4.
+    v3.4.4
     validator
     versioning
     webHDFS
@@ Expand Down @@