Skip to content

Commit

Permalink
docs(ko): Shorter example values in config schema (#6837)
Browse files Browse the repository at this point in the history
Shorten the example values in the config schema. This fixes the issue
on the `skaffold.yaml` reference page of the website, where long
example values push the description to a very narrow space on the page.

Tracking: #6041
  • Loading branch information
halvards authored Nov 11, 2021
1 parent bfdd798 commit b676799
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/content/en/schemas/v2beta26.json
Original file line number Diff line number Diff line change
Expand Up @@ -2520,7 +2520,7 @@
"x-intellij-html-description": "environment variables, in the <code>key=value</code> form, passed to the build. These environment variables are only used at build time. They are <em>not</em> set in the resulting container image.",
"default": "[]",
"examples": [
"[\"GOPRIVATE=source.developers.google.com\", \"GOCACHE=/workspace/.gocache\"]"
"[\"GOPRIVATE=git.example.com\", \"GOCACHE=/workspace/.gocache\"]"
]
},
"flags": {
Expand Down Expand Up @@ -2549,7 +2549,7 @@
"x-intellij-html-description": "key-value string pairs to add to the image config.",
"default": "{}",
"examples": [
"{\"org.opencontainers.image.source\":\"https://github.com/GoogleContainerTools/skaffold\"}"
"{\"foo\":\"bar\"}"
]
},
"ldflags": {
Expand Down
4 changes: 2 additions & 2 deletions pkg/skaffold/schema/latest/v1/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -1358,15 +1358,15 @@ type KoArtifact struct {
// Env are environment variables, in the `key=value` form, passed to the build.
// These environment variables are only used at build time.
// They are _not_ set in the resulting container image.
// For example: `["GOPRIVATE=source.developers.google.com", "GOCACHE=/workspace/.gocache"]`.
// For example: `["GOPRIVATE=git.example.com", "GOCACHE=/workspace/.gocache"]`.
Env []string `yaml:"env,omitempty"`

// Flags are additional build flags passed to `go build`.
// For example: `["-trimpath", "-v"]`.
Flags []string `yaml:"flags,omitempty"`

// Labels are key-value string pairs to add to the image config.
// For example: `{"org.opencontainers.image.source":"https://github.com/GoogleContainerTools/skaffold"}`.
// For example: `{"foo":"bar"}`.
Labels map[string]string `yaml:"labels,omitempty"`

// Ldflags are linker flags passed to the builder.
Expand Down

0 comments on commit b676799

Please sign in to comment.