[Docs] add an example for global config (#4341)

* add an example for global config * fix tests
GoogleContainerTools · Jun 18, 2020 · d32eec1 · d32eec1
1 parent 98af44c
commit d32eec1
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/docs/content/en/docs/design/global-config.md b/docs/content/en/docs/design/global-config.md
@@ -21,3 +21,6 @@ For example, to treat any context as local by default:
 ```bash
 skaffold config set --global local-cluster true
 ```
+This will create a global configuration file at `~/.skaffold/config` with `local-cluster` set to `true`.
+
+{{% readfile file="samples/config/globalConfig.yaml" %}}
diff --git a/docs/content/en/samples/config/globalConfig.yaml b/docs/content/en/samples/config/globalConfig.yaml
@@ -0,0 +1,3 @@
+global:
+  local-cluster: true
+kubeContexts: []
diff --git a/pkg/skaffold/schema/samples_test.go b/pkg/skaffold/schema/samples_test.go
@@ -36,7 +36,7 @@ const (
 )
 
 var (
-	ignoredSamples = []string{"structureTest.yaml", "build.sh"}
+	ignoredSamples = []string{"structureTest.yaml", "build.sh", "globalConfig.yaml"}
 )
 
 // Test that every example can be parsed and produces a valid