Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(docs): improve docs with examples #31

Merged
merged 5 commits into from
Dec 5, 2023
Merged

feat(docs): improve docs with examples #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
315367d
feat(docs): add overview.png
rafalgalaw Dec 4, 2023
690b179
fix(scripts): exclude images from being checked for license header
rafalgalaw Dec 4, 2023
1d71598
feat(docs): add quickstart guide
rafalgalaw Dec 4, 2023
586006f
fix(docs): add excalidraw file
rafalgalaw Dec 5, 2023
dc96f28
fix(docs): add repo cr to diagram and fix samples
rafalgalaw Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@

`garm-operator` is a [Kubernetes®](https://kubernetes.io) operator that manages the lifecycle of [garm](https://github.com/cloudbase/garm) objects by creating/updating/deleting corresponding objects in the Kubernetes cluster.

![garm components overview](docs/assets/overview.png "Architecture Overview")
rafalgalaw marked this conversation as resolved.
Show resolved Hide resolved

## 🔀 Versioning

### Garm Version
Expand Down Expand Up @@ -102,4 +104,4 @@ Please visit <https://www.mercedes-benz-techinnovation.com/en/imprint/> for info

Notice: Before you use the program in productive use, please take all necessary precautions,
e.g. testing and verifying the program with regard to your specific use.
The program was tested solely for our own use cases, which might differ from yours.
The program was tested solely for our own use cases, which might differ from yours.