From 7cd38bbd235d8f0390e3da7b8d981e54e576f398 Mon Sep 17 00:00:00 2001 From: Patrice Ferlet Date: Fri, 4 Jul 2025 14:59:49 +0200 Subject: [PATCH] feat(doc): regenerate the package docs --- doc/docs/packages/generator.md | 16 ++++++++-------- doc/docs/packages/generator/extrafiles.md | 2 +- doc/docs/packages/parser.md | 2 +- doc/docs/packages/utils.md | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/docs/packages/generator.md b/doc/docs/packages/generator.md index 0283f52..a761861 100644 --- a/doc/docs/packages/generator.md +++ b/doc/docs/packages/generator.md @@ -6,7 +6,7 @@ import "katenary/generator" ``` -The generator package generates kubernetes objects from a "compose" file and transforms them into a helm chart. +Package generator generates kubernetes objects from a "compose" file and transforms them into a helm chart. The generator package is the core of katenary. It is responsible for generating kubernetes objects from a compose file and transforming them into a helm chart. Conversion manipulates Yaml representation of kubernetes object to add conditions, labels, annotations, etc. to the objects. It also create the values to be set to the values.yaml file. @@ -107,7 +107,7 @@ func UnWrapTPL(in []byte) []byte UnWrapTPL removes the line wrapping from a template. -## type [ChartTemplate]() +## type [ChartTemplate]() ChartTemplate is a template of a chart. It contains the content of the template and the name of the service. This is used internally to generate the templates. @@ -173,7 +173,7 @@ AddData adds a key value pair to the configmap. Append or overwrite the value if func (c *ConfigMap) AppendDir(path string) error ``` -AddFile adds files from given path to the configmap. It is not recursive, to add all files in a directory, you need to call this function for each subdirectory. +AppendDir adds files from given path to the configmap. It is not recursive, to add all files in a directory, you need to call this function for each subdirectory. ### func \(\*ConfigMap\) [AppendFile]() @@ -223,7 +223,7 @@ type ConfigMapMount struct { ``` -## type [ConvertOptions]() +## type [ConvertOptions]() ConvertOptions are the options to convert a compose project to a helm chart. @@ -448,7 +448,7 @@ const ( ``` -## type [HelmChart]() +## type [HelmChart]() HelmChart is a Helm Chart representation. It contains all the templates, values, versions, helpers... @@ -460,7 +460,7 @@ type HelmChart struct { Name string `yaml:"name"` Icon string `yaml:"icon,omitempty"` - ApiVersion string `yaml:"apiVersion"` + APIVersion string `yaml:"apiVersion"` Version string `yaml:"version"` AppVersion string `yaml:"appVersion"` Description string `yaml:"description"` @@ -491,7 +491,7 @@ The Generate function will create the HelmChart object this way: - Merge the same\-pod services. -### func [NewChart]() +### func [NewChart]() ```go func NewChart(name string) *HelmChart @@ -500,7 +500,7 @@ func NewChart(name string) *HelmChart NewChart creates a new empty chart with the given name. -### func \(\*HelmChart\) [SaveTemplates]() +### func \(\*HelmChart\) [SaveTemplates]() ```go func (chart *HelmChart) SaveTemplates(templateDir string) diff --git a/doc/docs/packages/generator/extrafiles.md b/doc/docs/packages/generator/extrafiles.md index 5c59366..82ba2e2 100644 --- a/doc/docs/packages/generator/extrafiles.md +++ b/doc/docs/packages/generator/extrafiles.md @@ -6,7 +6,7 @@ import "katenary/generator/extrafiles" ``` -extrafiles package provides function to generate the Chart files that are not objects. Like README.md and notes.txt... +Package extrafiles provides function to generate the Chart files that are not objects. Like README.md and notes.txt... ## func [NotesFile]() diff --git a/doc/docs/packages/parser.md b/doc/docs/packages/parser.md index 8f310aa..a283b11 100644 --- a/doc/docs/packages/parser.md +++ b/doc/docs/packages/parser.md @@ -6,7 +6,7 @@ import "katenary/parser" ``` -Parser package is a wrapper around compose\-go to parse compose files. +Package parser is a wrapper around compose\-go to parse compose files. ## func [Parse]() diff --git a/doc/docs/packages/utils.md b/doc/docs/packages/utils.md index fe5e325..b512f96 100644 --- a/doc/docs/packages/utils.md +++ b/doc/docs/packages/utils.md @@ -6,7 +6,7 @@ import "katenary/utils" ``` -Utils package provides some utility functions used in katenary. It defines some constants and functions used in the whole project. +Package utils provides some utility functions used in katenary. It defines some constants and functions used in the whole project. ## func [AsResourceName]() @@ -140,7 +140,7 @@ TplName returns the name of the kubernetes resource as a template string. It is func TplValue(serviceName, variable string, pipes ...string) string ``` -GetContainerByName returns a container by name and its index in the array. +TplValue returns a container by name and its index in the array. ## func [Warn]()