From 3833037862ea436bec0b6a1b6a88b0761a62996a Mon Sep 17 00:00:00 2001 From: Patrice Ferlet Date: Tue, 3 Dec 2024 13:52:22 +0100 Subject: [PATCH] doc(refresh): after changing names and adding functions --- doc/docs/packages/generator.md | 45 ++++++++++++++++++++-------------- doc/docs/packages/utils.md | 4 +-- 2 files changed, 29 insertions(+), 20 deletions(-) diff --git a/doc/docs/packages/generator.md b/doc/docs/packages/generator.md index 4bf6f23..cd4f809 100644 --- a/doc/docs/packages/generator.md +++ b/doc/docs/packages/generator.md @@ -119,7 +119,7 @@ type ChartTemplate struct { ``` -## type [ConfigMap]() +## type [ConfigMap]() ConfigMap is a kubernetes ConfigMap. Implements the DataMap interface. @@ -131,7 +131,7 @@ type ConfigMap struct { ``` -### func [NewConfigMap]() +### func [NewConfigMap]() ```go func NewConfigMap(service types.ServiceConfig, appName string, forFile bool) *ConfigMap @@ -140,7 +140,7 @@ func NewConfigMap(service types.ServiceConfig, appName string, forFile bool) *Co NewConfigMap creates a new ConfigMap from a compose service. The appName is the name of the application taken from the project name. The ConfigMap is filled by environment variables and labels "map\-env". -### func [NewConfigMapFromDirectory]() +### func [NewConfigMapFromDirectory]() ```go func NewConfigMapFromDirectory(service types.ServiceConfig, appName, path string) *ConfigMap @@ -148,8 +148,17 @@ func NewConfigMapFromDirectory(service types.ServiceConfig, appName, path string NewConfigMapFromDirectory creates a new ConfigMap from a compose service. This path is the path to the file or directory. If the path is a directory, all files in the directory are added to the ConfigMap. Each subdirectory are ignored. Note that the Generate\(\) function will create the subdirectories ConfigMaps. + +### func \(\*ConfigMap\) [AddBinaryData]() + +```go +func (c *ConfigMap) AddBinaryData(key string, value []byte) +``` + +AddBinaryData adds binary data to the configmap. Append or overwrite the value if the key already exists. + -### func \(\*ConfigMap\) [AddData]() +### func \(\*ConfigMap\) [AddData]() ```go func (c *ConfigMap) AddData(key, value string) @@ -157,17 +166,8 @@ func (c *ConfigMap) AddData(key, value string) AddData adds a key value pair to the configmap. Append or overwrite the value if the key already exists. - -### func \(\*ConfigMap\) [AppendDir]() - -```go -func (c *ConfigMap) AppendDir(path string) -``` - -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. - -### func \(\*ConfigMap\) [AppendFile]() +### func \(\*ConfigMap\) [AppendFile]() ```go func (c *ConfigMap) AppendFile(path string) @@ -175,8 +175,17 @@ func (c *ConfigMap) AppendFile(path string) + +### func \(\*ConfigMap\) [AppenddDir]() + +```go +func (c *ConfigMap) AppenddDir(path string) +``` + +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. + -### func \(\*ConfigMap\) [Filename]() +### func \(\*ConfigMap\) [Filename]() ```go func (c *ConfigMap) Filename() string @@ -185,7 +194,7 @@ func (c *ConfigMap) Filename() string Filename returns the filename of the configmap. If the configmap is used for files, the filename contains the path. -### func \(\*ConfigMap\) [SetData]() +### func \(\*ConfigMap\) [SetData]() ```go func (c *ConfigMap) SetData(data map[string]string) @@ -194,7 +203,7 @@ func (c *ConfigMap) SetData(data map[string]string) SetData sets the data of the configmap. It replaces the entire data. -### func \(\*ConfigMap\) [Yaml]() +### func \(\*ConfigMap\) [Yaml]() ```go func (c *ConfigMap) Yaml() ([]byte, error) @@ -421,7 +430,7 @@ func (d *Deployment) Yaml() ([]byte, error) Yaml returns the yaml representation of the deployment. -## type [FileMapUsage]() +## type [FileMapUsage]() FileMapUsage is the usage of the filemap. diff --git a/doc/docs/packages/utils.md b/doc/docs/packages/utils.md index 2f0ad01..35a62ba 100644 --- a/doc/docs/packages/utils.md +++ b/doc/docs/packages/utils.md @@ -196,13 +196,13 @@ type Icon string const ( IconSuccess Icon = "✅" IconFailure Icon = "❌" - IconWarning Icon = "⚠️'" + IconWarning Icon = "❕" IconNote Icon = "📝" IconWorld Icon = "🌐" IconPlug Icon = "🔌" IconPackage Icon = "📦" IconCabinet Icon = "🗄️" - IconInfo Icon = "❕" + IconInfo Icon = "🔵" IconSecret Icon = "🔒" IconConfig Icon = "🔧" IconDependency Icon = "🔗"