docs: improve references and add imports and functions docs

Author: LukasGentele

docs/hack/functions/main.go

@@ -30,8 +30,10 @@ type Function struct {
 func main() {
 	functionRefContent := "\n\n"
 	globalFunctionRefContent := "\n\n"
+	pipelineFunctionRefContent := "\n\n"
 	functionRefFile := functionPartialBasePath + "reference.mdx"
 	globalFunctionRefFile := functionPartialBasePath + "reference_global.mdx"
+	pipelineFunctionRefFile := functionPartialBasePath + "reference_pipeline.mdx"
 
 	groups := map[string]*util.Group{}
 
@@ -74,9 +76,23 @@ func main() {
 
 		partialImport := util.GetPartialImport(functionFile, functionRefFile)
 		partialUse := fmt.Sprintf(util.TemplatePartialUse, util.GetPartialImportName(function.Name))
+		partialImportGlobal := partialImport
+		partialUseGlobal := partialUse
+		partialImportPipeline := partialImport
+		partialUsePipeline := partialUse
+		writeRef := true
+		writeGlobalRef := false
+		writePipelineRef := false
 
 		if function.Group != "" {
 			groupID := strings.ToLower(function.Group)
+
+			globalGroupID := fmt.Sprintf("%s_global", groupID)
+			globalGroup, globalGroupExists := groups[globalGroupID]
+
+			pipelineGroupID := fmt.Sprintf("%s_pipeline", groupID)
+			pipelineGroup, pipelineGroupExists := groups[pipelineGroupID]
+
 			group, groupExists := groups[groupID]
 			if !groupExists {
 				group = &util.Group{
@@ -88,20 +104,60 @@ func main() {
 				groups[groupID] = group
 			}
 
+			writeRef = !groupExists
+			partialImportGlobal = ""
+			partialUseGlobal = ""
+			partialImportPipeline = ""
+			partialUsePipeline = ""
+
+			if !globalGroupExists {
+				globalGroup = &util.Group{
+					Name:    function.Group,
+					File:    fmt.Sprintf(functionPartialBasePath+"group_%s.mdx", globalGroupID),
+					Imports: &[]string{},
+					Content: "\n\n",
+				}
+				groups[globalGroupID] = globalGroup
+				writeGlobalRef = true
+				partialImportGlobal = util.GetPartialImport(globalGroup.File, globalFunctionRefFile)
+				partialUseGlobal = fmt.Sprintf(util.TemplatePartialUse, util.GetPartialImportName(globalGroup.File))
+			}
+
+			if !pipelineGroupExists {
+				pipelineGroup = &util.Group{
+					Name:    function.Group,
+					File:    fmt.Sprintf(functionPartialBasePath+"group_%s.mdx", pipelineGroupID),
+					Imports: &[]string{},
+					Content: "\n\n",
+				}
+				groups[pipelineGroupID] = pipelineGroup
+				writePipelineRef = true
+				partialImportPipeline = util.GetPartialImport(pipelineGroup.File, pipelineFunctionRefFile)
+				partialUsePipeline = fmt.Sprintf(util.TemplatePartialUse, util.GetPartialImportName(pipelineGroup.File))
+			}
+
 			group.Content = partialImport + group.Content + partialUse
 
-			if groupExists {
-				continue
+			if function.IsGlobal {
+				globalGroup.Content = partialImport + globalGroup.Content + partialUse
+			} else {
+				pipelineGroup.Content = partialImport + pipelineGroup.Content + partialUse
 			}
 
 			partialImport = util.GetPartialImport(group.File, functionRefFile)
 			partialUse = fmt.Sprintf(util.TemplatePartialUse, util.GetPartialImportName(group.File))
 		}
 
-		functionRefContent = partialImport + functionRefContent + partialUse
+		if writeRef {
+			functionRefContent = partialImport + functionRefContent + partialUse
+		}
 
-		if function.IsGlobal {
-			globalFunctionRefContent = partialImport + globalFunctionRefContent + partialUse
+		if writeGlobalRef {
+			globalFunctionRefContent = partialImportGlobal + globalFunctionRefContent + partialUseGlobal
+		}
+
+		if writePipelineRef {
+			pipelineFunctionRefContent = partialImportPipeline + pipelineFunctionRefContent + partialUsePipeline
 		}
 	}
 
@@ -116,6 +172,11 @@ func main() {
 	if err != nil {
 		panic(err)
 	}
+
+	err = ioutil.WriteFile(pipelineFunctionRefFile, []byte(pipelineFunctionRefContent), os.ModePerm)
+	if err != nil {
+		panic(err)
+	}
 }
 
 func getFlagReference(functionName, functionFile string, flagRef reflect.Type, partialImports *[]string, pageContent string) string {

docs/hack/util/groups.go

@@ -5,6 +5,7 @@ import (
 	"io/ioutil"
 	"os"
 	"path/filepath"
+	"strings"
 )
 
 type Group struct {
@@ -17,21 +18,24 @@ type Group struct {
 func ProcessGroups(groups map[string]*Group) {
 	for groupID, group := range groups {
 		groupContent := group.Content
+		groupFileContent := ""
 
-		if group.Name != "" {
-			groupContent = "\n" + `<div className="group-name">` + group.Name + `</div>` + "\n\n" + groupContent
-		}
+		if strings.TrimSpace(group.Content) != "" {
+			if group.Name != "" {
+				groupContent = "\n" + `<div className="group-name">` + group.Name + `</div>` + "\n\n" + groupContent
+			}
 
-		groupImportContent := ""
-		for _, partialFile := range *group.Imports {
-			groupImportContent = groupImportContent + GetPartialImport(partialFile, group.File)
-		}
+			groupImportContent := ""
+			for _, partialFile := range *group.Imports {
+				groupImportContent = groupImportContent + GetPartialImport(partialFile, group.File)
+			}
 
-		if groupImportContent != "" {
-			groupImportContent = groupImportContent + "\n\n"
-		}
+			if groupImportContent != "" {
+				groupImportContent = groupImportContent + "\n\n"
+			}
 
-		groupFileContent := fmt.Sprintf(`%s<div className="group" data-group="%s">%s`+"\n"+`</div>`, groupImportContent, groupID, groupContent)
+			groupFileContent = fmt.Sprintf(`%s<div className="group" data-group="%s">%s`+"\n"+`</div>`, groupImportContent, groupID, groupContent)
+		}
 
 		err := os.MkdirAll(filepath.Dir(group.File), os.ModePerm)
 		if err != nil {

docs/hack/util/schema.go

@@ -91,9 +91,11 @@ func createSections(basePath, prefix string, schema *jsonschema.Schema, definiti
 			if fieldSchema, ok := field.(*jsonschema.Schema); ok {
 				fieldContent := ""
 				fieldFile := fmt.Sprintf("%s%s%s.mdx", basePath, prefix, fieldName)
+				fieldFileReference := fieldFile
 				fieldType := "object"
 				isNameObjectMap := false
 				groupID, _ := fieldSchema.Extras[groupKey].(string)
+				expandable := false
 
 				var patternPropertySchema *jsonschema.Schema
 				var nestedSchema *jsonschema.Schema
@@ -116,66 +118,47 @@ func createSections(basePath, prefix string, schema *jsonschema.Schema, definiti
 					if ok {
 						newPrefix := prefix + fieldName + prefixSeparator
 						createSections(basePath, newPrefix, nestedSchema, definitions, depth+1, isNameObjectMap)
-					}
-				} else {
-					required := contains(schema.Required, fieldName)
-					fieldDefault := ""
-
-					fieldType = fieldSchema.Type
-					if fieldType == "" && fieldSchema.OneOf != nil {
-						for _, oneOfType := range fieldSchema.OneOf {
-							if fieldType != "" {
-								fieldType = fieldType + "|"
-							}
-							fieldType = fieldType + oneOfType.Type
-						}
-					}
+						fieldFileReference = fmt.Sprintf("%s%s%s_reference.mdx", basePath, prefix, fieldName)
 
-					if isNameObjectMap {
-						fieldNameSingular := pluralizeClient.Singular(fieldName)
-						fieldType = "<" + fieldNameSingular + "_name>:"
+						fieldContent = GetPartialImport(fieldFileReference, fieldFile) + "\n\n" + fmt.Sprintf(TemplatePartialUse, GetPartialImportName(fieldFileReference))
 
-						if patternPropertySchema != nil && patternPropertySchema.Type != "" {
-							fieldType = fieldType + patternPropertySchema.Type
-						} else {
-							fieldType = fieldType + "object"
-						}
+						expandable = true
 					}
+				}
 
-					if fieldType == "array" {
-						fieldType = fieldSchema.Items.Type + "[]"
-					}
+				required := contains(schema.Required, fieldName)
+				fieldDefault := ""
 
-					if fieldType == "boolean" {
-						fieldDefault = "false"
-						if required {
-							fieldDefault = "true"
-							required = false
-						}
-					} else {
-						fieldDefault, ok = fieldSchema.Default.(string)
-						if !ok {
-							fieldDefault = ""
+				fieldType = fieldSchema.Type
+				if fieldType == "" && fieldSchema.OneOf != nil {
+					for _, oneOfType := range fieldSchema.OneOf {
+						if fieldType != "" {
+							fieldType = fieldType + "|"
 						}
+						fieldType = fieldType + oneOfType.Type
 					}
+				}
 
-					enumValues := GetEumValues(fieldSchema, required, &fieldDefault)
-
-					anchorName := anchorPrefix + fieldName
-					fieldContent = fmt.Sprintf(TemplateConfigField, false, " open", headlinePrefix, fieldName, required, fieldType, fieldDefault, enumValues, anchorName, fieldSchema.Description, "")
+				if isNameObjectMap {
+					fieldNameSingular := pluralizeClient.Singular(fieldName)
+					fieldType = "<" + fieldNameSingular + "_name>:"
 
-					err := os.MkdirAll(filepath.Dir(fieldFile), os.ModePerm)
-					if err != nil {
-						panic(err)
+					if patternPropertySchema != nil && patternPropertySchema.Type != "" {
+						fieldType = fieldType + patternPropertySchema.Type
+					} else {
+						fieldType = fieldType + "object"
 					}
+				}
 
-					err = ioutil.WriteFile(fieldFile, []byte(fieldContent), os.ModePerm)
-					if err != nil {
-						panic(err)
+				if fieldType == "array" {
+					if fieldSchema.Items.Type == "" {
+						fieldType = "object[]"
+					} else {
+						fieldType = fieldSchema.Items.Type + "[]"
 					}
 				}
 
-				fieldPartial := fmt.Sprintf(TemplatePartialUse, GetPartialImportName(fieldFile))
+				fieldPartial := fmt.Sprintf(TemplatePartialUse, GetPartialImportName(fieldFileReference))
 				if ref != "" {
 					if isNameObjectMap && nestedSchema != nil {
 						nameField, ok := nestedSchema.Properties.Get(nameFieldName)
@@ -194,7 +177,38 @@ func createSections(basePath, prefix string, schema *jsonschema.Schema, definiti
 					}
 
 					anchorName := anchorPrefix + fieldName
+
+					fieldContent = GetPartialImport(fieldFileReference, fieldFile) + "\n\n" + fmt.Sprintf(TemplateConfigField, true, " open", headlinePrefix, fieldName, false, fieldType, "", "", anchorName, fieldSchema.Description, fieldPartial)
+
 					fieldPartial = fmt.Sprintf(TemplateConfigField, true, "", headlinePrefix, fieldName, false, fieldType, "", "", anchorName, fieldSchema.Description, fieldPartial)
+				} else {
+					if fieldType == "boolean" {
+						fieldDefault = "false"
+						if required {
+							fieldDefault = "true"
+							required = false
+						}
+					} else {
+						fieldDefault, ok = fieldSchema.Default.(string)
+						if !ok {
+							fieldDefault = ""
+						}
+					}
+
+					enumValues := GetEumValues(fieldSchema, required, &fieldDefault)
+
+					anchorName := anchorPrefix + fieldName
+					fieldContent = fmt.Sprintf(TemplateConfigField, expandable, " open", headlinePrefix, fieldName, required, fieldType, fieldDefault, enumValues, anchorName, fieldSchema.Description, fieldContent)
+				}
+
+				err := os.MkdirAll(filepath.Dir(fieldFileReference), os.ModePerm)
+				if err != nil {
+					panic(err)
+				}
+
+				err = ioutil.WriteFile(fieldFile, []byte(fieldContent), os.ModePerm)
+				if err != nil {
+					panic(err)
 				}
 
 				if groupID != "" {
@@ -217,10 +231,10 @@ func createSections(basePath, prefix string, schema *jsonschema.Schema, definiti
 					}
 
 					group.Content = group.Content + fieldPartial
-					*group.Imports = append(*group.Imports, fieldFile)
+					*group.Imports = append(*group.Imports, fieldFileReference)
 				} else {
 					content = content + "\n\n" + fieldPartial
-					*partialImports = append(*partialImports, fieldFile)
+					*partialImports = append(*partialImports, fieldFileReference)
 				}
 			}
 		}
@@ -230,6 +244,8 @@ func createSections(basePath, prefix string, schema *jsonschema.Schema, definiti
 
 	if prefix == "" {
 		prefix = "reference"
+	} else {
+		prefix = strings.TrimSuffix(prefix, "/") + "_reference"
 	}
 
 	pageFile := fmt.Sprintf("%s%s.mdx", basePath, strings.TrimSuffix(prefix, "/"))
@@ -246,8 +262,6 @@ func createSections(basePath, prefix string, schema *jsonschema.Schema, definiti
 		panic(err)
 	}
 
-	//fmt.Println(content)
-
 	return content
 }
 

docs/pages/configuration/_partials/functions/group_checks_global.mdx

@@ -0,0 +1,17 @@
+<div className="group" data-group="checks_global">
+<div className="group-name">Checks</div>
+
+
+import PartialIstrue from "./is_true.mdx"
+import PartialIsos from "./is_os.mdx"
+import PartialIsequal from "./is_equal.mdx"
+import PartialIsempty from "./is_empty.mdx"
+import PartialIsdependency from "./is_dependency.mdx"
+
+<PartialIsdependency />
+<PartialIsempty />
+<PartialIsequal />
+<PartialIsos />
+<PartialIstrue />
+
+</div>

docs/pages/configuration/_partials/functions/group_checks_pipeline.mdx

@@ -0,0 +1,11 @@
+<div className="group" data-group="deployments_pipeline">
+<div className="group-name">Deployments</div>
+
+
+import PartialPurgedeployments from "./purge_deployments.mdx"
+import PartialCreatedeployments from "./create_deployments.mdx"
+
+<PartialCreatedeployments />
+<PartialPurgedeployments />
+
+</div>

docs/pages/configuration/_partials/functions/group_deployments_global.mdx

@@ -0,0 +1,11 @@
+<div className="group" data-group="dev_pipeline">
+<div className="group-name">Dev</div>
+
+
+import PartialStopdev from "./stop_dev.mdx"
+import PartialStartdev from "./start_dev.mdx"
+
+<PartialStartdev />
+<PartialStopdev />
+
+</div>