Changing logo, fix doc, catchy text...

This commit is contained in:
2024-04-04 09:50:17 +02:00
parent fc67cb668d
commit 50169c8fbc
13 changed files with 294 additions and 18 deletions

View File

@@ -36,8 +36,10 @@ The generation is made by using a `HelmChart` object:
```golang
chart := NewChart(appName string)
``` Then, some processes are made to detect the "main app verion" (tag for the main service image), bootstrapping
declared ports in labels, managing links to bind containers in one pods...
```
Then, some processes are made to detect the "main app verion" (tag for the main service image), bootstrapping declared
ports in labels, managing links to bind containers in one pods...
Then, a loop basically makes this:
@@ -54,7 +56,7 @@ for _, service := range project.Services {
**A lot** of string manipulations are made by each `Yaml()` methods. This is where you find the complex and impacting
operations. The `Yaml` methods **don't return a valid YAML content**. This is a Helm Chart Yaml content with template
conditions, vamues and calls to helper templates.
conditions, values and calls to helper templates.
> The `Yaml()` methods, in each object, need contribution, help, fixes, enhancements... They work, but there is a lot of
> complexity. Please, create issues, pull-requests and conversation in the GitHub repository.

View File

@@ -1,18 +1,35 @@
<div class="md-center"> <img src="statics/logo.png" /> </div>
<style>
#logo{
background-image: url('statics/logo-dark.svg');
background-repeat: no-repeat;
background-position: center;
background-size: contain;
height: 8em;
width: 100%;
margin: 0 auto;
}
[data-md-color-scheme=slate] #logo {
background-image: url('statics/logo-bright.svg');
}
</style>
<div class="md-center" id="logo"></div>
# Welcome to Katenary documentation
🚀 Unleash Productivity with Katenary! 🚀
!!! Edit "Thanks to..."
**Katenary is built with:**
<br /><a href="https://go.dev" target="_blank">:fontawesome-brands-golang:{ .go-logo }</a>
Tired of manual conversions? Katenary harnesses the labels from your "compose" file to craft complete Helm Charts
effortlessly, saving you time and energy.
**Documentation is built with:**
<br />
<a href="https://www.mkdocs.org/" target="_blank">MkDocs</a> using <a
href="https://squidfunk.github.io/mkdocs-material/" target="_blank">Material for MkDocs</a> theme template.
🛠️ Simple autmated CLI: Katenary handles the grunt work, generating everything needed for seamless service binding
and Helm Chart creation.
> Special thanks to all contributors, testors, and of course packages and tools authors.
💡 Effortless Efficiency: You only need to add labels when it's necessary to precise things. Then call `katenary convert` and let the magic happen.
# What ?
Katenary is a tool made to help you to transform "compose" files (`docker-compose.yml`, `podman-compose.yml`...) to
complete and production ready [Helm Chart](https://helm.sh).
@@ -25,7 +42,6 @@ It uses your current file and optionnaly labels to configure the result.
It's an opensource project, under MIT licence, partially developped at [Smile](https://www.smile.eu). The project source
code is hosted on the [:fontawesome-brands-github: Katenary GitHub Repository](https://github.com/metal3d/katenary).
## Install Katenary
Katenary is developped using the :fontawesome-brands-golang:{ .gopher } [Go](https://go.dev) language.
@@ -88,3 +104,35 @@ source <(katenary completion bash)
Add this line in you `~/.profile` or `~/.bashrc` file to have completion at startup.
!!! Edit "Special thanks"
**Katenary is built with:** <br />
> Special thanks to all contributors, testors, and of course packages and tools authors.
<a href="https://go.dev" target="_blank">:fontawesome-brands-golang:{ .go-logo }</a>
Go is an open source programming language that makes it easy to build simple, reliable, and efficient software.
Docker, Rancher, Helm, Kubernetes, Grafana, Prometheus, and many others are written in Go. Katenary uses Go-Compose
to parse compose files wich is the same library used by Podman-Compose and Docker-Compose. It also uses the
Kubernetes official packages to create Kubernetes objects before to generate the Helm Chart.
**Thanks to everyone who contributes to all these projects.**
**Everything was also possible because of:** <br />
<ul>
<li><a href="https://helm.sh" target="_blank"><img src="https://helm.sh/img/helm.svg" style="height: 1rem"/>
Helm</a> that is the main toppic of Katenary, Kubernetes is easier to use with it.</li>
<li><a href="https://cobra.dev/"><img src="https://cobra.dev/home/logo.png" style="height: 1rem"/> Cobra</a> that
makes command, subcommand and completion possible for Katenary with ease.</li>
</ul>
**Documentation is built with:** <br />
<a href="https://www.mkdocs.org/" target="_blank">MkDocs</a> using <a
href="https://squidfunk.github.io/mkdocs-material/" target="_blank">Material for MkDocs</a> theme template.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 17 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

145
doc/docs/statics/logo.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 21 KiB

View File

@@ -3,7 +3,7 @@ docs_dir: ./docs
theme:
name: material
custom_dir: overrides
logo: statics/logo.png
logo: statics/logo-dark.svg
palette:
- scheme: slate
toggle: