Skip to content

Commit 3833037

Browse files
committed
doc(refresh): after changing names and adding functions
1 parent 6dc92df commit 3833037

File tree

2 files changed

+27
-18
lines changed

2 files changed

+27
-18
lines changed

doc/docs/packages/generator.md

+25-16
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ type ChartTemplate struct {
119119
```
120120

121121
<a name="ConfigMap"></a>
122-
## type [ConfigMap](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L35-L40>)
122+
## type [ConfigMap](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L36-L41>)
123123

124124
ConfigMap is a kubernetes ConfigMap. Implements the DataMap interface.
125125

@@ -131,7 +131,7 @@ type ConfigMap struct {
131131
```
132132

133133
<a name="NewConfigMap"></a>
134-
### func [NewConfigMap](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L44>)
134+
### func [NewConfigMap](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L45>)
135135

136136
```go
137137
func NewConfigMap(service types.ServiceConfig, appName string, forFile bool) *ConfigMap
@@ -140,43 +140,52 @@ func NewConfigMap(service types.ServiceConfig, appName string, forFile bool) *Co
140140
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".
141141

142142
<a name="NewConfigMapFromDirectory"></a>
143-
### func [NewConfigMapFromDirectory](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L117>)
143+
### func [NewConfigMapFromDirectory](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L118>)
144144

145145
```go
146146
func NewConfigMapFromDirectory(service types.ServiceConfig, appName, path string) *ConfigMap
147147
```
148148

149149
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.
150150

151-
<a name="ConfigMap.AddData"></a>
152-
### func \(\*ConfigMap\) [AddData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L148>)
151+
<a name="ConfigMap.AddBinaryData"></a>
152+
### func \(\*ConfigMap\) [AddBinaryData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L154>)
153153

154154
```go
155-
func (c *ConfigMap) AddData(key, value string)
155+
func (c *ConfigMap) AddBinaryData(key string, value []byte)
156156
```
157157

158-
AddData adds a key value pair to the configmap. Append or overwrite the value if the key already exists.
158+
AddBinaryData adds binary data to the configmap. Append or overwrite the value if the key already exists.
159159

160-
<a name="ConfigMap.AppendDir"></a>
161-
### func \(\*ConfigMap\) [AppendDir](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L154>)
160+
<a name="ConfigMap.AddData"></a>
161+
### func \(\*ConfigMap\) [AddData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L149>)
162162

163163
```go
164-
func (c *ConfigMap) AppendDir(path string)
164+
func (c *ConfigMap) AddData(key, value string)
165165
```
166166

167-
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.
167+
AddData adds a key value pair to the configmap. Append or overwrite the value if the key already exists.
168168

169169
<a name="ConfigMap.AppendFile"></a>
170-
### func \(\*ConfigMap\) [AppendFile](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L189>)
170+
### func \(\*ConfigMap\) [AppendFile](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L209>)
171171

172172
```go
173173
func (c *ConfigMap) AppendFile(path string)
174174
```
175175

176176

177177

178+
<a name="ConfigMap.AppenddDir"></a>
179+
### func \(\*ConfigMap\) [AppenddDir](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L163>)
180+
181+
```go
182+
func (c *ConfigMap) AppenddDir(path string)
183+
```
184+
185+
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.
186+
178187
<a name="ConfigMap.Filename"></a>
179-
### func \(\*ConfigMap\) [Filename](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L207>)
188+
### func \(\*ConfigMap\) [Filename](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L232>)
180189

181190
```go
182191
func (c *ConfigMap) Filename() string
@@ -185,7 +194,7 @@ func (c *ConfigMap) Filename() string
185194
Filename returns the filename of the configmap. If the configmap is used for files, the filename contains the path.
186195

187196
<a name="ConfigMap.SetData"></a>
188-
### func \(\*ConfigMap\) [SetData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L217>)
197+
### func \(\*ConfigMap\) [SetData](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L242>)
189198

190199
```go
191200
func (c *ConfigMap) SetData(data map[string]string)
@@ -194,7 +203,7 @@ func (c *ConfigMap) SetData(data map[string]string)
194203
SetData sets the data of the configmap. It replaces the entire data.
195204

196205
<a name="ConfigMap.Yaml"></a>
197-
### func \(\*ConfigMap\) [Yaml](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L222>)
206+
### func \(\*ConfigMap\) [Yaml](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L247>)
198207

199208
```go
200209
func (c *ConfigMap) Yaml() ([]byte, error)
@@ -421,7 +430,7 @@ func (d *Deployment) Yaml() ([]byte, error)
421430
Yaml returns the yaml representation of the deployment.
422431

423432
<a name="FileMapUsage"></a>
424-
## type [FileMapUsage](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L19>)
433+
## type [FileMapUsage](<https://github.com/metal3d/katenary/blob/develop/generator/configMap.go#L20>)
425434

426435
FileMapUsage is the usage of the filemap.
427436

doc/docs/packages/utils.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -196,13 +196,13 @@ type Icon string
196196
const (
197197
IconSuccess Icon = ""
198198
IconFailure Icon = ""
199-
IconWarning Icon = "⚠️'"
199+
IconWarning Icon = ""
200200
IconNote Icon = "📝"
201201
IconWorld Icon = "🌐"
202202
IconPlug Icon = "🔌"
203203
IconPackage Icon = "📦"
204204
IconCabinet Icon = "🗄️"
205-
IconInfo Icon = ""
205+
IconInfo Icon = "🔵"
206206
IconSecret Icon = "🔒"
207207
IconConfig Icon = "🔧"
208208
IconDependency Icon = "🔗"

0 commit comments

Comments
 (0)