public/helm-charts
1
0
Fork 0
mirror of https://github.com/bjw-s-labs/helm-charts.git synced 2025-07-03 08:37:03 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: Update docs

Browse source
This commit is contained in:
Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs 2023-01-11 09:00:16 +01:00
parent 9b7377de7f
commit 9cfc6276db
No known key found for this signature in database
GPG key ID: BC5E2BD907F9A8EC
3 changed files with 51 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

61
README.md
View file

@ -1,16 +1,28 @@
# helm-charts
A collection of Helm charts
<div align="center">
## Goal
<img src="https://github.com/bjw-s/bjw-s/blob/main/_assets/images/logo.jpg?raw=true" align="left" width="144px" height="144px"/>
This repo contains Helm charts that I have developed to run applications in my
[home Kubernetes cluster](https://github.com/bjw-s/home-ops/).
## helm-charts
This repo is not intended to be a replacement for any of the large collections
of Helm charts that are out there.
</div>
<div align="center">
[![Discord](https://img.shields.io/discord/673534664354430999?style=for-the-badge&label&logo=discord&logoColor=white&color=blue)](https://discord.gg/k8s-at-home)
</div>
<br><br>
👋 Welcome to my Helm Charts repository. This repo contains Helm charts that I have developed to run applications in my [home Kubernetes cluster](https://github.com/bjw-s/home-ops/).
This repo is **not** intended to be a replacement for any of the large collections of Helm charts that are out there.
---
## Installation
[Helm](https://helm.sh) must be installed to use the charts in this repository.
The Helm repository can be installed as follows:
```console
@ -19,14 +31,37 @@ helm repo add bjw-s https://bjw-s.github.io/helm-charts
You can then run `helm search repo bjw-s` to search the charts.
## Documentation
---
Documentation can be found [here](https://bjw-s.github.io/helm-charts/docs/).
### 📖 Docs
## Contributing
The documentation that goes along with this repo can be found [over here](https://bjw-s.github.io/helm-charts/).
See [CONTRIBUTING.md](./CONTRIBUTING.md)
---
## License
### 🔎 Support
[Apache 2.0 License](./LICENSE)
If you like this project, please consider supporting my work through my [GitHub sponsorship page](https://github.com/sponsors/bjw-s?frequency=one-time).
---
## How do I find people running these charts?
### Discord
Join the k8s-at-home [Discord](https://discord.gg/sTMX7Vh) community on Discord.
### Repository topics
Have a look at people running Kubernetes at home by checking the ["`k8s-at-home`" topic on GitHub](https://github.com/topics/k8s-at-home?o=desc&s=updated).
### Search
You can use this following [search engine](https://nanne.dev/k8s-at-home-search/) provided by [@whazor](https://github.com/whazor) to search for public
repositories containing any application you might wish to run.
---
### 🔏 License
See [LICENSE](https://github.com/bjw-s/helm-charts/blob/main/LICENSE)

5
docs/book.toml
View file

@ -36,6 +36,5 @@ limit-results = 15
command = "mdbook-admonish"
assets_version = "2.0.0" # do not edit: managed by `mdbook-admonish install`
[preprocessor.open-on-gh]
command = "mdbook-open-on-gh"
renderer = ["html"]
[preprocessor.emojicodes]
after = [ "links" ]

45
docs/src/introduction.md
View file

@ -1,44 +1 @@
# Welcome
Welcome to the documentation for the [bjw-s Helm charts](https://github.com/bjw-s/helm-charts) project.
## Getting started
[Helm](https://helm.sh) must be installed to use the charts in this repository.
Refer to Helm's [documentation](https://helm.sh/docs/) to get started.
## Installation
```sh
helm repo add bjw-s http://bjw-s.github.io/helm-charts/
```
You can then run `helm search repo bjw-s` to search the charts.
## Support
If you like this project, please consider supporting my work through my [GitHub sponsorship page](https://github.com/sponsors/bjw-s?frequency=one-time).
## How do I find people running Kubernetes at home?
### Discord
Join the k8s-at-home [Discord](https://discord.gg/sTMX7Vh) community on Discord.
### Repository topics
Have a look at people running Kubernetes at home
[on GitHub](https://github.com/topics/k8s-at-home?o=desc&s=updated) and
<!-- Disable link check because it requires login -->
<!-- markdown-link-check-disable-next-line -->
[on GitLab](https://gitlab.com/search?search=k8s-at-home).
### Search
You can use this following [search engine](https://nanne.dev/k8s-at-home-search/) provided by [@whazor](https://github.com/whazor) to search for public
repositories containing any application you might wish to run.
## License
This project is licensed under the terms of the Apache 2.0 License license.
{{ #include ../../README.md }}