docs context: Document ResourceSet & Context struct fields

1 files changed, 19 insertions, 2 deletions

diff --git a/context/context.go b/context/context.go
index 66a45390e0f0..ff17eccc345e 100644
--- a/context/context.go
+++ b/context/context.go
@@ -8,20 +8,37 @@ import (
 )
 
 type ResourceSet struct {
+	// Name of the resource set. This can be used in include/exclude statements during kontemplate runs.
 	Name   string                 `json:"name"`
+
+	// Path to the folder containing the files for this resource set. This defaults to the value of the 'name' field
+	// if unset.
 	Path   string                 `json:"path"`
+
+	// Values to include when interpolating resources from this resource set.
 	Values map[string]interface{} `json:"values"`
 
-	// Fields for resource set collections
+	// Nested resource sets to include
 	Include []ResourceSet `json:"include"`
+
+	// Parent resource set for flattened resource sets. Should not be manually specified.
 	Parent  string
 }
 
 type Context struct {
+	// The name of the kubectl context
 	Name            string                 `json:"context"`
+
+	// Global variables that should be accessible by all resource sets
 	Global          map[string]interface{} `json:"global"`
-	ResourceSets    []ResourceSet          `json:"include"`
+
+	// File names of YAML or JSON files including extra variables that should be globally accessible
 	VariableImports []string               `json:"import"`
+
+	// The resource sets to include in this context
+	ResourceSets    []ResourceSet          `json:"include"`
+
+	// This field represents the absolute path to the context base directory and should not be manually specified.
 	BaseDir         string
 }