fix examples to appropriate type (#4974)

* fix examples to appropriate type * Use json.Stringify to output things in array
GoogleContainerTools · Oct 30, 2020 · cd2a38f · Amirnateghi1 · Nov 14, 2020 · cd2a38f
1 parent dcdf77c
commit cd2a38f
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/docs/content/en/docs/references/yaml/main.js b/docs/content/en/docs/references/yaml/main.js
@@ -136,7 +136,7 @@ function* template(definitions, parentDefinition, ref, ident, parent) {
         yield html`
           <tr>
             <td>
-              <span class="key" style="margin-left: ${ident * 20}px">- <span class="${valueClass}">${v}</span></span>
+              <span class="key" style="margin-left: ${ident * 20}px">- <span class="${valueClass}">${JSON.stringify(v)}</span></span>
             </td>
             <td class="comment">#&nbsp;</td>
           </tr>

diff --git a/docs/content/en/schemas/v2beta9.json b/docs/content/en/schemas/v2beta9.json
@@ -1659,7 +1659,7 @@
           "x-intellij-html-description": "environment variables passed to the kaniko pod. It also accepts environment variables via the go template syntax.",
           "default": "[]",
           "examples": [
-            "{{name: \"key1\", value: \"value1\"}, {name: \"key2\", value: \"value2\"}, {name: \"key3\", value: \"'{{.ENV_VARIABLE}}'\"}\"}"
+            "[{\"name\": \"key1\", \"value\": \"value1\"}, {\"name\": \"key2\", \"value\": \"value2\"}, {\"name\": \"key3\", \"value\": \"'{{.ENV_VARIABLE}}'\"}]"
           ]
         },
         "force": {

diff --git a/pkg/skaffold/schema/latest/config.go b/pkg/skaffold/schema/latest/config.go
@@ -1068,7 +1068,7 @@ type KanikoArtifact struct {
 
 	// Env are environment variables passed to the kaniko pod.
 	// It also accepts environment variables via the go template syntax.
-	// For example: `{{name: "key1", value: "value1"}, {name: "key2", value: "value2"}, {name: "key3", value: "'{{.ENV_VARIABLE}}'"}"}`.
+	// For example: `[{"name": "key1", "value": "value1"}, {"name": "key2", "value": "value2"}, {"name": "key3", "value": "'{{.ENV_VARIABLE}}'"}]`.
 	Env []v1.EnvVar `yaml:"env,omitempty"`
 
 	// Cache configures Kaniko caching. If a cache is specified, Kaniko will