docs: Add links to Python examples to description annotations (#6202)

Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
argoproj · Jun 24, 2021 · 6167aaa · 6167aaa
1 parent 4fd38fa
commit 6167aaa
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/examples/coinflip.yaml b/examples/coinflip.yaml
@@ -7,6 +7,10 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: coinflip-
+  annotations:
+    workflows.argoproj.io/description: |
+      This is an example of coin flip defined as a sequence of conditional steps.
+      You can also run it in Python: https://couler-proj.github.io/couler/examples/#coin-flip
 spec:
   entrypoint: coinflip
   templates:

diff --git a/examples/dag-coinflip.yaml b/examples/dag-coinflip.yaml
@@ -2,6 +2,10 @@ apiVersion: argoproj.io/v1alpha1
 kind: Workflow
 metadata:
   generateName: dag-diamond-coinflip-
+  annotations:
+    workflows.argoproj.io/description: |
+      This is an example of coin flip defined as a DAG.
+      You can also run it in Python: https://couler-proj.github.io/couler/examples/#dag
 spec:
   entrypoint: diamond
   templates:

diff --git a/examples/hello-world.yaml b/examples/hello-world.yaml
@@ -4,6 +4,10 @@ metadata:
   generateName: hello-world-
   labels:
     workflows.argoproj.io/archive-strategy: "false"
+  annotations:
+    workflows.argoproj.io/description: |
+      This is a simple hello world example.
+      You can also run it in Python: https://couler-proj.github.io/couler/examples/#hello-world
 spec:
   entrypoint: whalesay
   templates: