Fix yaml comment in pod template examples (flyteorg#5024)

* Replace character to denote a comment in podtemplate examples Signed-off-by: Eduardo Apolinario <[email protected]> * Update the other example Signed-off-by: Eduardo Apolinario <[email protected]> --------- Signed-off-by: Eduardo Apolinario <[email protected]> Signed-off-by: Eduardo Apolinario <[email protected]> Co-authored-by: Eduardo Apolinario <[email protected]>
yubofredwang · Mar 26, 2024 · 19f86ab · 19f86ab
1 parent 4999297
commit 19f86ab
Showing 1 changed file with 9 additions and 9 deletions.
diff --git a/docs/deployment/configuration/general.rst b/docs/deployment/configuration/general.rst
@@ -241,19 +241,19 @@ The resultant Pod using the above default PodTemplate and K8s Plugin configurati
       name: example-pod
       namespace: flytesnacks-development
       labels:
-        - foo // maintained initial value
-        - bar // value appended by k8s plugin configuration
+        - foo # maintained initial value
+        - bar # value appended by k8s plugin configuration
       annotations:
-        - foo: overridden-value // value overridden by k8s plugin configuration
-        - bar: initial-value // maintained initial value
-        - baz: non-overridden-value // value added by k8s plugin configuration
+        - foo: overridden-value # value overridden by k8s plugin configuration
+        - bar: initial-value # maintained initial value
+        - baz: non-overridden-value # value added by k8s plugin configuration
     spec:
       containers:
         - name: ax9kd5xb4p8r45bpdv7v-n0-0
           image: ghcr.io/flyteorg/flytecookbook:core-bfee7e549ad749bfb55922e130f4330a0ebc25b0
           terminationMessagePath: "/dev/foo"
-          // remaining container configuration omitted
-      hostNetwork: true // overridden by the k8s plugin configuration
+          # remaining container configuration omitted
+      hostNetwork: true # overridden by the k8s plugin configuration
 
 The last step in constructing a Pod is to apply any task-specific configuration.
 These options follow the same rules as merging the default PodTemplate and K8s
@@ -343,7 +343,7 @@ The resultant Pod is as follows:
           image: a.b.c/image:v1
           command: cmd
           args: []
-          // remaining container configuration omitted
+          # remaining container configuration omitted
 
 Notice how options follow the same merging rules, i.e. lists append and maps override.
 
@@ -450,4 +450,4 @@ The resultant pod for that task is as follows:
           image: a.b.c/image:v1
           command: cmd
           args: []
-          // remaining container configuration omitted
+          # remaining container configuration omitted