From b0f1f66d9a6b7fdcc51f7552e9e585ad5fd377c5 Mon Sep 17 00:00:00 2001 From: Frank Farzan Date: Tue, 10 Dec 2019 12:27:02 -0800 Subject: [PATCH] Document the default value --- cmd/config/docs/api-conventions/config-io.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/cmd/config/docs/api-conventions/config-io.md b/cmd/config/docs/api-conventions/config-io.md index 07c4b2f51..27efdd0ec 100644 --- a/cmd/config/docs/api-conventions/config-io.md +++ b/cmd/config/docs/api-conventions/config-io.md @@ -34,14 +34,19 @@ This annotation **SHOULD** be set when reading Resources from files. When writing multiple Resources to the same file, the Resource **SHOULD** be written in the relative order matching the index. +When this annotation is not specified, it implies a value of `0`. + Example: ```yaml metadata: annotations: - config.kubernetes.io/index: 0 + config.kubernetes.io/path: "relative/file/path.yaml" + config.kubernetes.io/index: 2 ``` +This represents the thrid Resource in the file. + ### `config.kubernetes.io/local-config` `config.kubernetes.io/local-config` declares that the configuration is to local tools