Merge pull request #89 from helmwave/0.38.x

0.38.x

Author: zhilyaev

docs/overrides/home.html

@@ -123,7 +123,7 @@
             </div>
             <div class="tx-hero__content">
                 <h1>Helmwave</h1>
-                <h2>Docker-Compose for helm</h2>
+                <h2>New 🌊 for helm</h2>
                 <p>With helmwave you can:</p>
                 <ul>
                     <li>Templating values</li>

docs/plan.md

@@ -1,6 +1,14 @@
 # Deep dive to plan
 
-By default, plan is stored in `.helmwave` directory
+
+## Definitions
+
+By default, plan is stored in `.helmwave` directory. This directory name is `plandir`.
+
+`Uniqname` is the unique release name, which is used to identify the release. Uniqname is `release-name@namespace@kube-context`.
+
+
+## Structure
 
 Explanation of what a plan is.
 
@@ -10,35 +18,62 @@ Explanation of what a plan is.
 - values/
 - charts/
 
-## planfile
+
+```
+tree .helmwave
+.helmwave
+|____charts/
+|____manifest
+| |____api@[email protected]
+| |____web@[email protected]
+|____values
+| |____api@ns@context
+| | |____cb18185ed7a1e8d2f06fc029708867eb.yml
+| |____web@ns@context
+| | |____63610d2dfb7f7427e17b6f3f58937161.yml
+|____charts
+| |____api@ns@context
+| | |____api-1.0.0.tgz
+| |____web@ns@context
+| | |____web-1.0.0.tgz
+|____planfile
+|____graph.md
+```
+
+### planfile
 
 Planfile is a main yaml document. It contains information about all your planned resources.
 Planfile is a computed `helmwave.yml` file.
 
+by default, planfile is stored in `.helmwave/planfile`
 
 
-## graph.md
+### graph.md
 
 graph.md is a markdown file. It contains visualisation for graph dependencies.
 
 You can open this file with your favorite IDE and render image with [mermaid](https://github.com/mermaid-js/mermaid). 
 
-## manifest
+### manifest
 
-Manifest is a directory where you can find all templated kubernetes resources in next format `<release>@<namespace>.yml`
+Manifest is a directory where you can find all templated kubernetes resources.
 
-You can scan the manifests in this directory.
+by default is stored in `.helmwave/manifest/<uniqname>.yml`
 
-See the [:material-duck: example](../ci/?h=ci#kube-linter-and-helmwave)
+You can do whatever you want with the manifests in this directory.
 
-Sure! You can apply that manifests directly like that: `kubectl apply -f .helmwave/manifest`
+**For example,**
 
-## values
+- You can apply that manifests directly like that: `kubectl apply -f .helmwave/manifest`
+- You can lint manifests [:material-duck: example](../ci/?h=ci#kube-linter-and-helmwave)
+
+### values
 
 Values is a directory where you can find rendered values files of your releases.
-To find the values for your releases you can use next pattern : `./helmwave/values/<release>@<namespace>/<hash>.yml`
+To find the values for your releases you can use next pattern: `.helmwave/values/<uniqname>/<hash>.yml`
+
 
-## charts
+### charts
 
 Charts is a directory where helmwave can store downloaded charts for all your releases. 
 It's not required but very useful when you want to use helmwave with DMZ cases.

docs/tpl.md

@@ -1,5 +1,3 @@
-
-
 # 📄 Templating
 
 > Helmwave using [go templates](https://godoc.org/text/template) for templating.

mkdocs.yml

@@ -117,7 +117,7 @@ theme:
     - search.highlight
 
 extra:
-  ver: 0.36.3
+  ver: 0.38.0
   version:
     provider: mike
     default: latest