From e69e3089aace2f37be61657a4deaac6c49b61831 Mon Sep 17 00:00:00 2001 From: Gabe Cook Date: Sun, 16 Apr 2023 02:21:59 -0500 Subject: [PATCH] :memo: (docs): Add pretty chart names --- README.md | 70 +++++++++---------- charts/adguard-home/README.md | 2 +- charts/adguard-home/README_CONFIG.md.gotmpl | 4 ++ charts/ascii-movie/README.md | 2 +- charts/ascii-movie/README_CONFIG.md.gotmpl | 4 ++ charts/bookstack/README.md | 2 +- charts/bookstack/README_CONFIG.md.gotmpl | 4 ++ charts/borgmatic/README.md | 2 +- charts/borgmatic/README_CONFIG.md.gotmpl | 4 ++ charts/changedetection-io/README.md | 2 +- .../README_CONFIG.md.gotmpl | 4 ++ charts/domain-watch/README.md | 2 +- charts/domain-watch/README_CONFIG.md.gotmpl | 4 ++ charts/esphome/README.md | 2 +- charts/esphome/README_CONFIG.md.gotmpl | 4 ++ charts/flame/README.md | 2 +- charts/flame/README_CONFIG.md.gotmpl | 4 ++ charts/hammond/README.md | 2 +- charts/hammond/README_CONFIG.md.gotmpl | 4 ++ charts/headscale/README.md | 2 +- charts/headscale/README_CONFIG.md.gotmpl | 4 ++ charts/healthchecks/README.md | 2 +- charts/healthchecks/README_CONFIG.md.gotmpl | 4 ++ charts/home-assistant/README.md | 2 +- charts/home-assistant/README_CONFIG.md.gotmpl | 4 ++ charts/homer/README.md | 2 +- charts/homer/README_CONFIG.md.gotmpl | 4 ++ charts/limo/README.md | 2 +- charts/limo/README_CONFIG.md.gotmpl | 4 ++ charts/matrimony/README.md | 2 +- charts/matrimony/README_CONFIG.md.gotmpl | 4 ++ charts/memos/README.md | 2 +- charts/memos/README_CONFIG.md.gotmpl | 4 ++ charts/miniflux/README.md | 2 +- charts/miniflux/README_CONFIG.md.gotmpl | 4 ++ charts/mnemonic-ninja/README.md | 2 +- charts/mnemonic-ninja/README_CONFIG.md.gotmpl | 4 ++ charts/monica/README.md | 2 +- charts/monica/README_CONFIG.md.gotmpl | 4 ++ charts/nightscout/README.md | 2 +- charts/nightscout/README_CONFIG.md.gotmpl | 4 ++ charts/obico/README.md | 2 +- charts/obico/README_CONFIG.md.gotmpl | 4 ++ charts/paperless-ngx/README.md | 2 +- charts/paperless-ngx/README_CONFIG.md.gotmpl | 4 ++ charts/pictshare/README.md | 2 +- charts/pictshare/README_CONFIG.md.gotmpl | 4 ++ charts/plex/README.md | 2 +- charts/plex/README_CONFIG.md.gotmpl | 4 ++ charts/podgrab/README.md | 2 +- charts/podgrab/README_CONFIG.md.gotmpl | 4 ++ charts/portfolio/README.md | 2 +- charts/portfolio/README_CONFIG.md.gotmpl | 4 ++ charts/qbittorrent/README.md | 2 +- charts/qbittorrent/README_CONFIG.md.gotmpl | 4 ++ charts/relax-sounds/README.md | 2 +- charts/relax-sounds/README_CONFIG.md.gotmpl | 4 ++ charts/rss-bridge/README.md | 2 +- charts/rss-bridge/README_CONFIG.md.gotmpl | 4 ++ charts/rsshub/README.md | 2 +- charts/rsshub/README_CONFIG.md.gotmpl | 4 ++ charts/scanservjs/README.md | 2 +- charts/scanservjs/README_CONFIG.md.gotmpl | 4 ++ charts/smarter-device-manager/README.md | 2 +- .../README_CONFIG.md.gotmpl | 4 ++ charts/tandoor/README.md | 2 +- charts/tandoor/README_CONFIG.md.gotmpl | 4 ++ charts/transsmute/README.md | 2 +- charts/transsmute/README_CONFIG.md.gotmpl | 4 ++ charts/vaultwarden/README.md | 2 +- charts/vaultwarden/README_CONFIG.md.gotmpl | 4 ++ docs/plugins/filter_readmes.py | 8 ++- hack/gen-chart-summary.sh | 3 +- hack/templates/README.md.gotmpl | 3 +- hack/templates/README_CONFIG.md.gotmpl | 4 ++ 75 files changed, 224 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index ce0853de3..88e6353cf 100644 --- a/README.md +++ b/README.md @@ -41,38 +41,38 @@ helm delete my- | Chart | Description | | ----- | ----------- | -| [adguard-home adguard-home icon](charts/adguard-home/) | Free and open source, powerful network-wide ads & trackers blocking DNS server. | -| [ascii-movie ascii-movie icon](charts/ascii-movie/) | Star Wars movie SSH and Telnet server | -| [bookstack bookstack icon](charts/bookstack/) | A simple, self-hosted, easy-to-use platform for organising and storing information. | -| [borgmatic borgmatic icon](charts/borgmatic/) | borgmatic is simple, configuration-driven backup software for servers and workstations. Protect your files with client-side encryption. Backup your databases too. Monitor it all with integrated third-party services. | -| [changedetection-io changedetection-io icon](charts/changedetection-io/) | Live your data-life pro-actively, track website content changes and receive notifications via Discord, Email, Slack, Telegram and 70+ more. | -| [domain-watch domain-watch icon](charts/domain-watch/) | Tool to watch whois reports and notify when statuses change or expiration is incoming. | -| [esphome esphome icon](charts/esphome/) | ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems. | -| [flame flame icon](charts/flame/) | Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors. | -| [hammond hammond icon](charts/hammond/) | A self-hosted vehicle expense tracking system with support for multiple users. | -| [headscale headscale icon](charts/headscale/) | An open source, self-hosted implementation of the Tailscale control server. | -| [healthchecks healthchecks icon](charts/healthchecks/) | A cron monitoring tool written in Python & Django | -| [home-assistant home-assistant icon](charts/home-assistant/) | Open source home automation that puts local control and privacy first. | -| [homer homer icon](charts/homer/) | A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file. | -| [limo ](charts/limo/) | A file upload server. | -| [matrimony matrimony icon](charts/matrimony/) | Self-hosted wedding site configured via YAML | -| [memos memos icon](charts/memos/) | A lightweight, self-hosted memo hub. Open Source and Free forever. | -| [miniflux miniflux icon](charts/miniflux/) | Miniflux is a minimalist and opinionated feed reader. | -| [mnemonic-ninja mnemonic-ninja icon](charts/mnemonic-ninja/) | Mnemonic Ninja is a website to convert between a number and its corresponding word to aid in memorization. | -| [monica monica icon](charts/monica/) | Personal CRM. Remember everything about your friends, family and business relationships. | -| [nightscout nightscout icon](charts/nightscout/) | Web-based CGM (Continuous Glucose Monitor) to allow multiple caregivers to remotely view a patient's glucose data in real time. | -| [obico obico icon](charts/obico/) | Obico is a community-built, open-source smart 3D printing platform used by makers, enthusiasts, and tinkerers around the world. | -| [paperless-ngx paperless-ngx icon](charts/paperless-ngx/) | A community-supported supercharged version of paperless: scan, index and archive all your physical documents | -| [pictshare pictshare icon](charts/pictshare/) | PictShare is an open source image, mp4, pastebin hosting service with a simple resizing and upload API that you can host yourself. | -| [plex plex icon](charts/plex/) | Plex organizes all of your personal media so you can enjoy it no matter where you are. | -| [podgrab ](charts/podgrab/) | A self-hosted podcast manager to download episodes as soon as they become live. | -| [portfolio portfolio icon](charts/portfolio/) | My personal portfolio website | -| [qbittorrent qbittorrent icon](charts/qbittorrent/) | The qBittorrent project aims to provide an open-source software alternative to µTorrent. | -| [relax-sounds relax-sounds icon](charts/relax-sounds/) | Relax Sounds is a website that lets you stream relaxing sounds to your browser or over Google Cast. | -| [rss-bridge rss-bridge icon](charts/rss-bridge/) | The RSS feed for websites missing it. | -| [rsshub rsshub icon](charts/rsshub/) | RSSHub is an open source, easy to use, and extensible RSS feed generator. It's capable of generating RSS feeds from pretty much everything. | -| [scanservjs scanservjs icon](charts/scanservjs/) | scanservjs is a web UI frontend for your scanner. It allows you to share one or more scanners (using SANE) on a network without the need for drivers or complicated installation. | -| [smarter-device-manager smarter-device-manager icon](charts/smarter-device-manager/) | Manage hardware resource allocation without a need for privileged containers. | -| [tandoor tandoor icon](charts/tandoor/) | Application for managing recipes, planning meals, building shopping lists and much much more! | -| [transsmute transsmute icon](charts/transsmute/) | Transsmute builds RSS feeds for websites that don't provide them. | -| [vaultwarden vaultwarden icon](charts/vaultwarden/) | Unofficial Bitwarden compatible server written in Rust. | +| [AdGuard Home adguard-home icon](charts/adguard-home/) | Free and open source, powerful network-wide ads & trackers blocking DNS server. | +| [ASCII Movie ascii-movie icon](charts/ascii-movie/) | Star Wars movie SSH and Telnet server | +| [Bookstack bookstack icon](charts/bookstack/) | A simple, self-hosted, easy-to-use platform for organising and storing information. | +| [Borgmatic borgmatic icon](charts/borgmatic/) | borgmatic is simple, configuration-driven backup software for servers and workstations. Protect your files with client-side encryption. Backup your databases too. Monitor it all with integrated third-party services. | +| [ChangeDetection.io changedetection-io icon](charts/changedetection-io/) | Live your data-life pro-actively, track website content changes and receive notifications via Discord, Email, Slack, Telegram and 70+ more. | +| [Domain Watch domain-watch icon](charts/domain-watch/) | Tool to watch whois reports and notify when statuses change or expiration is incoming. | +| [Home Assistant esphome icon](charts/esphome/) | ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems. | +| [Flame flame icon](charts/flame/) | Flame is self-hosted startpage for your server. Easily manage your apps and bookmarks with built-in editors. | +| [Hammond hammond icon](charts/hammond/) | A self-hosted vehicle expense tracking system with support for multiple users. | +| [Headscale headscale icon](charts/headscale/) | An open source, self-hosted implementation of the Tailscale control server. | +| [Healthchecks healthchecks icon](charts/healthchecks/) | A cron monitoring tool written in Python & Django | +| [Home Assistant home-assistant icon](charts/home-assistant/) | Open source home automation that puts local control and privacy first. | +| [Homer homer icon](charts/homer/) | A dead simple static HOMepage for your servER to keep your services on hand, from a simple yaml configuration file. | +| [Limo ](charts/limo/) | A file upload server. | +| [Matrimony matrimony icon](charts/matrimony/) | Self-hosted wedding site configured via YAML | +| [Memos memos icon](charts/memos/) | A lightweight, self-hosted memo hub. Open Source and Free forever. | +| [Miniflux miniflux icon](charts/miniflux/) | Miniflux is a minimalist and opinionated feed reader. | +| [Mnemonic Ninja mnemonic-ninja icon](charts/mnemonic-ninja/) | Mnemonic Ninja is a website to convert between a number and its corresponding word to aid in memorization. | +| [Monica monica icon](charts/monica/) | Personal CRM. Remember everything about your friends, family and business relationships. | +| [Nightscout nightscout icon](charts/nightscout/) | Web-based CGM (Continuous Glucose Monitor) to allow multiple caregivers to remotely view a patient's glucose data in real time. | +| [Obico obico icon](charts/obico/) | Obico is a community-built, open-source smart 3D printing platform used by makers, enthusiasts, and tinkerers around the world. | +| [Paperless-ngx paperless-ngx icon](charts/paperless-ngx/) | A community-supported supercharged version of paperless: scan, index and archive all your physical documents | +| [Pictshare pictshare icon](charts/pictshare/) | PictShare is an open source image, mp4, pastebin hosting service with a simple resizing and upload API that you can host yourself. | +| [Plex plex icon](charts/plex/) | Plex organizes all of your personal media so you can enjoy it no matter where you are. | +| [Podgrab ](charts/podgrab/) | A self-hosted podcast manager to download episodes as soon as they become live. | +| [Portfolio portfolio icon](charts/portfolio/) | My personal portfolio website | +| [qBittorrent qbittorrent icon](charts/qbittorrent/) | The qBittorrent project aims to provide an open-source software alternative to µTorrent. | +| [Relax Sounds relax-sounds icon](charts/relax-sounds/) | Relax Sounds is a website that lets you stream relaxing sounds to your browser or over Google Cast. | +| [RSS-Bridge rss-bridge icon](charts/rss-bridge/) | The RSS feed for websites missing it. | +| [RSSHub rsshub icon](charts/rsshub/) | RSSHub is an open source, easy to use, and extensible RSS feed generator. It's capable of generating RSS feeds from pretty much everything. | +| [Scanservjs scanservjs icon](charts/scanservjs/) | scanservjs is a web UI frontend for your scanner. It allows you to share one or more scanners (using SANE) on a network without the need for drivers or complicated installation. | +| [Smarter Device Manager smarter-device-manager icon](charts/smarter-device-manager/) | Manage hardware resource allocation without a need for privileged containers. | +| [Tandoor tandoor icon](charts/tandoor/) | Application for managing recipes, planning meals, building shopping lists and much much more! | +| [Transsmute transsmute icon](charts/transsmute/) | Transsmute builds RSS feeds for websites that don't provide them. | +| [Vaultwarden vaultwarden icon](charts/vaultwarden/) | Unofficial Bitwarden compatible server written in Rust. | diff --git a/charts/adguard-home/README.md b/charts/adguard-home/README.md index e05f24e13..ee0cd1920 100644 --- a/charts/adguard-home/README.md +++ b/charts/adguard-home/README.md @@ -1,4 +1,4 @@ -# adguard-home +# AdGuard Home adguard-home logo diff --git a/charts/adguard-home/README_CONFIG.md.gotmpl b/charts/adguard-home/README_CONFIG.md.gotmpl index e93d80bfa..396f0d1c0 100644 --- a/charts/adguard-home/README_CONFIG.md.gotmpl +++ b/charts/adguard-home/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +AdGuard Home +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/ascii-movie/README.md b/charts/ascii-movie/README.md index 4b5966128..7aa047c95 100644 --- a/charts/ascii-movie/README.md +++ b/charts/ascii-movie/README.md @@ -1,4 +1,4 @@ -# ascii-movie +# ASCII Movie ascii-movie logo diff --git a/charts/ascii-movie/README_CONFIG.md.gotmpl b/charts/ascii-movie/README_CONFIG.md.gotmpl index e93d80bfa..a2b4beb16 100644 --- a/charts/ascii-movie/README_CONFIG.md.gotmpl +++ b/charts/ascii-movie/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +ASCII Movie +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/bookstack/README.md b/charts/bookstack/README.md index d36526bcf..f3306d4e0 100644 --- a/charts/bookstack/README.md +++ b/charts/bookstack/README.md @@ -1,4 +1,4 @@ -# bookstack +# Bookstack bookstack logo diff --git a/charts/bookstack/README_CONFIG.md.gotmpl b/charts/bookstack/README_CONFIG.md.gotmpl index e93d80bfa..9c4f74099 100644 --- a/charts/bookstack/README_CONFIG.md.gotmpl +++ b/charts/bookstack/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Bookstack +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/borgmatic/README.md b/charts/borgmatic/README.md index 87a4e5273..e12190b2e 100644 --- a/charts/borgmatic/README.md +++ b/charts/borgmatic/README.md @@ -1,4 +1,4 @@ -# borgmatic +# Borgmatic borgmatic logo diff --git a/charts/borgmatic/README_CONFIG.md.gotmpl b/charts/borgmatic/README_CONFIG.md.gotmpl index 7b50d4d8d..a932e199d 100644 --- a/charts/borgmatic/README_CONFIG.md.gotmpl +++ b/charts/borgmatic/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Borgmatic +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration diff --git a/charts/changedetection-io/README.md b/charts/changedetection-io/README.md index 6fb582289..f270c755a 100644 --- a/charts/changedetection-io/README.md +++ b/charts/changedetection-io/README.md @@ -1,4 +1,4 @@ -# changedetection-io +# ChangeDetection.io changedetection-io logo diff --git a/charts/changedetection-io/README_CONFIG.md.gotmpl b/charts/changedetection-io/README_CONFIG.md.gotmpl index e93d80bfa..87962bcde 100644 --- a/charts/changedetection-io/README_CONFIG.md.gotmpl +++ b/charts/changedetection-io/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +ChangeDetection.io +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/domain-watch/README.md b/charts/domain-watch/README.md index 76ea6804f..8a2de14fd 100644 --- a/charts/domain-watch/README.md +++ b/charts/domain-watch/README.md @@ -1,4 +1,4 @@ -# domain-watch +# Domain Watch domain-watch logo diff --git a/charts/domain-watch/README_CONFIG.md.gotmpl b/charts/domain-watch/README_CONFIG.md.gotmpl index e93d80bfa..889fd4996 100644 --- a/charts/domain-watch/README_CONFIG.md.gotmpl +++ b/charts/domain-watch/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Domain Watch +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/esphome/README.md b/charts/esphome/README.md index eee9583f1..98912d4cc 100644 --- a/charts/esphome/README.md +++ b/charts/esphome/README.md @@ -1,4 +1,4 @@ -# esphome +# Home Assistant esphome logo diff --git a/charts/esphome/README_CONFIG.md.gotmpl b/charts/esphome/README_CONFIG.md.gotmpl index 6715f9502..d33e40858 100644 --- a/charts/esphome/README_CONFIG.md.gotmpl +++ b/charts/esphome/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Home Assistant +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/flame/README.md b/charts/flame/README.md index a2110b291..fe6bf6334 100644 --- a/charts/flame/README.md +++ b/charts/flame/README.md @@ -1,4 +1,4 @@ -# flame +# Flame flame logo diff --git a/charts/flame/README_CONFIG.md.gotmpl b/charts/flame/README_CONFIG.md.gotmpl index e93d80bfa..e6bb5e8cb 100644 --- a/charts/flame/README_CONFIG.md.gotmpl +++ b/charts/flame/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Flame +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/hammond/README.md b/charts/hammond/README.md index e2dac796f..593b30ecc 100644 --- a/charts/hammond/README.md +++ b/charts/hammond/README.md @@ -1,4 +1,4 @@ -# hammond +# Hammond hammond logo diff --git a/charts/hammond/README_CONFIG.md.gotmpl b/charts/hammond/README_CONFIG.md.gotmpl index e93d80bfa..835f62b22 100644 --- a/charts/hammond/README_CONFIG.md.gotmpl +++ b/charts/hammond/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Hammond +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/headscale/README.md b/charts/headscale/README.md index 4bc9b226e..414357448 100644 --- a/charts/headscale/README.md +++ b/charts/headscale/README.md @@ -1,4 +1,4 @@ -# headscale +# Headscale headscale logo diff --git a/charts/headscale/README_CONFIG.md.gotmpl b/charts/headscale/README_CONFIG.md.gotmpl index fe9495667..e437af0fe 100644 --- a/charts/headscale/README_CONFIG.md.gotmpl +++ b/charts/headscale/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Headscale +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/healthchecks/README.md b/charts/healthchecks/README.md index 176a6084b..a9d852516 100644 --- a/charts/healthchecks/README.md +++ b/charts/healthchecks/README.md @@ -1,4 +1,4 @@ -# healthchecks +# Healthchecks healthchecks logo diff --git a/charts/healthchecks/README_CONFIG.md.gotmpl b/charts/healthchecks/README_CONFIG.md.gotmpl index b30f82f51..e933109b5 100644 --- a/charts/healthchecks/README_CONFIG.md.gotmpl +++ b/charts/healthchecks/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Healthchecks +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/home-assistant/README.md b/charts/home-assistant/README.md index f0c686e0f..74b8c4c7d 100644 --- a/charts/home-assistant/README.md +++ b/charts/home-assistant/README.md @@ -1,4 +1,4 @@ -# home-assistant +# Home Assistant home-assistant logo diff --git a/charts/home-assistant/README_CONFIG.md.gotmpl b/charts/home-assistant/README_CONFIG.md.gotmpl index d5c6b2d3a..a41690321 100644 --- a/charts/home-assistant/README_CONFIG.md.gotmpl +++ b/charts/home-assistant/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Home Assistant +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/homer/README.md b/charts/homer/README.md index d5f7b3b3c..f297a4fa6 100644 --- a/charts/homer/README.md +++ b/charts/homer/README.md @@ -1,4 +1,4 @@ -# homer +# Homer homer logo diff --git a/charts/homer/README_CONFIG.md.gotmpl b/charts/homer/README_CONFIG.md.gotmpl index e93d80bfa..3b4917be0 100644 --- a/charts/homer/README_CONFIG.md.gotmpl +++ b/charts/homer/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Homer +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/limo/README.md b/charts/limo/README.md index 9dc982cea..e32a492f6 100644 --- a/charts/limo/README.md +++ b/charts/limo/README.md @@ -1,4 +1,4 @@ -# limo +# Limo ![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat) diff --git a/charts/limo/README_CONFIG.md.gotmpl b/charts/limo/README_CONFIG.md.gotmpl index e93d80bfa..f93396c34 100644 --- a/charts/limo/README_CONFIG.md.gotmpl +++ b/charts/limo/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Limo +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/matrimony/README.md b/charts/matrimony/README.md index 6a9baaaa5..8a4320963 100644 --- a/charts/matrimony/README.md +++ b/charts/matrimony/README.md @@ -1,4 +1,4 @@ -# matrimony +# Matrimony matrimony logo diff --git a/charts/matrimony/README_CONFIG.md.gotmpl b/charts/matrimony/README_CONFIG.md.gotmpl index e93d80bfa..142241c21 100644 --- a/charts/matrimony/README_CONFIG.md.gotmpl +++ b/charts/matrimony/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Matrimony +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/memos/README.md b/charts/memos/README.md index 8597318bc..bfbe5f611 100644 --- a/charts/memos/README.md +++ b/charts/memos/README.md @@ -1,4 +1,4 @@ -# memos +# Memos memos logo diff --git a/charts/memos/README_CONFIG.md.gotmpl b/charts/memos/README_CONFIG.md.gotmpl index e93d80bfa..aea3e3507 100644 --- a/charts/memos/README_CONFIG.md.gotmpl +++ b/charts/memos/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Memos +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/miniflux/README.md b/charts/miniflux/README.md index fef84e828..62c51d02e 100644 --- a/charts/miniflux/README.md +++ b/charts/miniflux/README.md @@ -1,4 +1,4 @@ -# miniflux +# Miniflux miniflux logo diff --git a/charts/miniflux/README_CONFIG.md.gotmpl b/charts/miniflux/README_CONFIG.md.gotmpl index e93d80bfa..c84861b98 100644 --- a/charts/miniflux/README_CONFIG.md.gotmpl +++ b/charts/miniflux/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Miniflux +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/mnemonic-ninja/README.md b/charts/mnemonic-ninja/README.md index 145b104b8..d6f8cb273 100644 --- a/charts/mnemonic-ninja/README.md +++ b/charts/mnemonic-ninja/README.md @@ -1,4 +1,4 @@ -# mnemonic-ninja +# Mnemonic Ninja mnemonic-ninja logo diff --git a/charts/mnemonic-ninja/README_CONFIG.md.gotmpl b/charts/mnemonic-ninja/README_CONFIG.md.gotmpl index e93d80bfa..3ae5448d5 100644 --- a/charts/mnemonic-ninja/README_CONFIG.md.gotmpl +++ b/charts/mnemonic-ninja/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Mnemonic Ninja +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/monica/README.md b/charts/monica/README.md index f8163a8ae..fe138117e 100644 --- a/charts/monica/README.md +++ b/charts/monica/README.md @@ -1,4 +1,4 @@ -# monica +# Monica monica logo diff --git a/charts/monica/README_CONFIG.md.gotmpl b/charts/monica/README_CONFIG.md.gotmpl index e93d80bfa..bc9276704 100644 --- a/charts/monica/README_CONFIG.md.gotmpl +++ b/charts/monica/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Monica +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/nightscout/README.md b/charts/nightscout/README.md index b9f99cdca..aa60601af 100644 --- a/charts/nightscout/README.md +++ b/charts/nightscout/README.md @@ -1,4 +1,4 @@ -# nightscout +# Nightscout nightscout logo diff --git a/charts/nightscout/README_CONFIG.md.gotmpl b/charts/nightscout/README_CONFIG.md.gotmpl index e93d80bfa..79374ec06 100644 --- a/charts/nightscout/README_CONFIG.md.gotmpl +++ b/charts/nightscout/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Nightscout +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/obico/README.md b/charts/obico/README.md index c8a63f9d6..f1d6f1719 100644 --- a/charts/obico/README.md +++ b/charts/obico/README.md @@ -1,4 +1,4 @@ -# obico +# Obico obico logo diff --git a/charts/obico/README_CONFIG.md.gotmpl b/charts/obico/README_CONFIG.md.gotmpl index e93d80bfa..abd529a4d 100644 --- a/charts/obico/README_CONFIG.md.gotmpl +++ b/charts/obico/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Obico +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/paperless-ngx/README.md b/charts/paperless-ngx/README.md index 7c17644c9..4a7611023 100644 --- a/charts/paperless-ngx/README.md +++ b/charts/paperless-ngx/README.md @@ -1,4 +1,4 @@ -# paperless-ngx +# Paperless-ngx paperless-ngx logo diff --git a/charts/paperless-ngx/README_CONFIG.md.gotmpl b/charts/paperless-ngx/README_CONFIG.md.gotmpl index bdda3df95..02cedad08 100644 --- a/charts/paperless-ngx/README_CONFIG.md.gotmpl +++ b/charts/paperless-ngx/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Paperless-ngx +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/pictshare/README.md b/charts/pictshare/README.md index 702cac704..771724fe7 100644 --- a/charts/pictshare/README.md +++ b/charts/pictshare/README.md @@ -1,4 +1,4 @@ -# pictshare +# Pictshare pictshare logo diff --git a/charts/pictshare/README_CONFIG.md.gotmpl b/charts/pictshare/README_CONFIG.md.gotmpl index e93d80bfa..e526a581c 100644 --- a/charts/pictshare/README_CONFIG.md.gotmpl +++ b/charts/pictshare/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Pictshare +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/plex/README.md b/charts/plex/README.md index 5c465e27d..4ba9261eb 100644 --- a/charts/plex/README.md +++ b/charts/plex/README.md @@ -1,4 +1,4 @@ -# plex +# Plex plex logo diff --git a/charts/plex/README_CONFIG.md.gotmpl b/charts/plex/README_CONFIG.md.gotmpl index 1b8b86f88..5fd5f9154 100644 --- a/charts/plex/README_CONFIG.md.gotmpl +++ b/charts/plex/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Plex +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/podgrab/README.md b/charts/podgrab/README.md index 4394f5409..216f3a832 100644 --- a/charts/podgrab/README.md +++ b/charts/podgrab/README.md @@ -1,4 +1,4 @@ -# podgrab +# Podgrab ![Version: 0.4.0](https://img.shields.io/badge/Version-0.4.0-informational?style=flat) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat) diff --git a/charts/podgrab/README_CONFIG.md.gotmpl b/charts/podgrab/README_CONFIG.md.gotmpl index e93d80bfa..ad7f7cf61 100644 --- a/charts/podgrab/README_CONFIG.md.gotmpl +++ b/charts/podgrab/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Podgrab +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/portfolio/README.md b/charts/portfolio/README.md index 3f2e34dcc..19de7d91c 100644 --- a/charts/portfolio/README.md +++ b/charts/portfolio/README.md @@ -1,4 +1,4 @@ -# portfolio +# Portfolio portfolio logo diff --git a/charts/portfolio/README_CONFIG.md.gotmpl b/charts/portfolio/README_CONFIG.md.gotmpl index e93d80bfa..4981ef685 100644 --- a/charts/portfolio/README_CONFIG.md.gotmpl +++ b/charts/portfolio/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Portfolio +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/qbittorrent/README.md b/charts/qbittorrent/README.md index 1cb28252d..6e24956e5 100644 --- a/charts/qbittorrent/README.md +++ b/charts/qbittorrent/README.md @@ -1,4 +1,4 @@ -# qbittorrent +# qBittorrent qbittorrent logo diff --git a/charts/qbittorrent/README_CONFIG.md.gotmpl b/charts/qbittorrent/README_CONFIG.md.gotmpl index 877bedaf8..7f8969a8d 100644 --- a/charts/qbittorrent/README_CONFIG.md.gotmpl +++ b/charts/qbittorrent/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +qBittorrent +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/relax-sounds/README.md b/charts/relax-sounds/README.md index 05bdf61e5..03c54c243 100644 --- a/charts/relax-sounds/README.md +++ b/charts/relax-sounds/README.md @@ -1,4 +1,4 @@ -# relax-sounds +# Relax Sounds relax-sounds logo diff --git a/charts/relax-sounds/README_CONFIG.md.gotmpl b/charts/relax-sounds/README_CONFIG.md.gotmpl index e93d80bfa..8ef04d2f9 100644 --- a/charts/relax-sounds/README_CONFIG.md.gotmpl +++ b/charts/relax-sounds/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Relax Sounds +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/rss-bridge/README.md b/charts/rss-bridge/README.md index 51fc727a3..2b516d0ba 100644 --- a/charts/rss-bridge/README.md +++ b/charts/rss-bridge/README.md @@ -1,4 +1,4 @@ -# rss-bridge +# RSS-Bridge rss-bridge logo diff --git a/charts/rss-bridge/README_CONFIG.md.gotmpl b/charts/rss-bridge/README_CONFIG.md.gotmpl index e93d80bfa..2a4fdfc12 100644 --- a/charts/rss-bridge/README_CONFIG.md.gotmpl +++ b/charts/rss-bridge/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +RSS-Bridge +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/rsshub/README.md b/charts/rsshub/README.md index 6d9bd6e25..812b47d93 100644 --- a/charts/rsshub/README.md +++ b/charts/rsshub/README.md @@ -1,4 +1,4 @@ -# rsshub +# RSSHub rsshub logo diff --git a/charts/rsshub/README_CONFIG.md.gotmpl b/charts/rsshub/README_CONFIG.md.gotmpl index e93d80bfa..50b8cffb8 100644 --- a/charts/rsshub/README_CONFIG.md.gotmpl +++ b/charts/rsshub/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +RSSHub +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/scanservjs/README.md b/charts/scanservjs/README.md index fb30b7f6f..699588040 100644 --- a/charts/scanservjs/README.md +++ b/charts/scanservjs/README.md @@ -1,4 +1,4 @@ -# scanservjs +# Scanservjs scanservjs logo diff --git a/charts/scanservjs/README_CONFIG.md.gotmpl b/charts/scanservjs/README_CONFIG.md.gotmpl index e93d80bfa..87a547257 100644 --- a/charts/scanservjs/README_CONFIG.md.gotmpl +++ b/charts/scanservjs/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Scanservjs +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/smarter-device-manager/README.md b/charts/smarter-device-manager/README.md index 4140d009d..da3dab72c 100644 --- a/charts/smarter-device-manager/README.md +++ b/charts/smarter-device-manager/README.md @@ -1,4 +1,4 @@ -# smarter-device-manager +# Smarter Device Manager smarter-device-manager logo diff --git a/charts/smarter-device-manager/README_CONFIG.md.gotmpl b/charts/smarter-device-manager/README_CONFIG.md.gotmpl index 75f8107ec..1cf8cc327 100644 --- a/charts/smarter-device-manager/README_CONFIG.md.gotmpl +++ b/charts/smarter-device-manager/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Smarter Device Manager +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/tandoor/README.md b/charts/tandoor/README.md index 41807818e..b512e6fc5 100644 --- a/charts/tandoor/README.md +++ b/charts/tandoor/README.md @@ -1,4 +1,4 @@ -# tandoor +# Tandoor tandoor logo diff --git a/charts/tandoor/README_CONFIG.md.gotmpl b/charts/tandoor/README_CONFIG.md.gotmpl index e93d80bfa..d4149da0d 100644 --- a/charts/tandoor/README_CONFIG.md.gotmpl +++ b/charts/tandoor/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Tandoor +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/transsmute/README.md b/charts/transsmute/README.md index 01d335a1e..21e07357e 100644 --- a/charts/transsmute/README.md +++ b/charts/transsmute/README.md @@ -1,4 +1,4 @@ -# transsmute +# Transsmute transsmute logo diff --git a/charts/transsmute/README_CONFIG.md.gotmpl b/charts/transsmute/README_CONFIG.md.gotmpl index e93d80bfa..eb341d903 100644 --- a/charts/transsmute/README_CONFIG.md.gotmpl +++ b/charts/transsmute/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Transsmute +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/charts/vaultwarden/README.md b/charts/vaultwarden/README.md index 5f6a33e12..9c5b25f04 100644 --- a/charts/vaultwarden/README.md +++ b/charts/vaultwarden/README.md @@ -1,4 +1,4 @@ -# vaultwarden +# Vaultwarden vaultwarden logo diff --git a/charts/vaultwarden/README_CONFIG.md.gotmpl b/charts/vaultwarden/README_CONFIG.md.gotmpl index d2bf66e13..e9907b609 100644 --- a/charts/vaultwarden/README_CONFIG.md.gotmpl +++ b/charts/vaultwarden/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +Vaultwarden +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}} diff --git a/docs/plugins/filter_readmes.py b/docs/plugins/filter_readmes.py index f158673ee..ca09804b4 100644 --- a/docs/plugins/filter_readmes.py +++ b/docs/plugins/filter_readmes.py @@ -43,11 +43,15 @@ def filter_chart_readme(markdown: str, page: Page, config: Config): markdown = yaml_re.sub(f"({config.repo_url}/blob/main/{page.url}\\1)", markdown) # Set metadata from Chart.yaml - yaml_file = os.path.join(os.path.dirname(page.file.abs_src_path), "Chart.yaml") + chart_dir = os.path.dirname(page.file.abs_src_path) + yaml_file = os.path.join(chart_dir, "Chart.yaml") + readme_file = os.path.join(chart_dir, "README.md") with open(yaml_file) as f: contents = yaml.load(f) if "description" in contents: - page.meta["description"] = contents["description"] + with open(readme_file) as readme: + title = re.sub(r"^# ", "", readme.readline().rstrip("\n")) + page.meta["description"] = f"Helm Chart for {title}: {contents['description']}" if "keywords" in contents: page.meta["tags"] = contents["keywords"] diff --git a/hack/gen-chart-summary.sh b/hack/gen-chart-summary.sh index 8a734c8d0..64d48967f 100755 --- a/hack/gen-chart-summary.sh +++ b/hack/gen-chart-summary.sh @@ -33,6 +33,7 @@ sed -i '' '/^'"$charts_header"'$/,$d' "$charts_summary_file" fi chart_icon="$chart_name icon" fi - echo "| [$chart_name $chart_icon](charts/$chart_name/) | $chart_description |" + pretty_name="$(head -n1 "$(dirname "$chart_yaml")/README.md" | sed 's/^# //')" + echo "| [$pretty_name $chart_icon](charts/$chart_name/) | $chart_description |" done } >> "$charts_summary_file" diff --git a/hack/templates/README.md.gotmpl b/hack/templates/README.md.gotmpl index 9b58b0018..4b9279b3f 100644 --- a/hack/templates/README.md.gotmpl +++ b/hack/templates/README.md.gotmpl @@ -111,7 +111,8 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} - Autogenerated from chart metadata using [helm-docs](https://github.com/norwoodj/helm-docs) {{- end -}} -{{ template "chart.header" . }} +# {{ template "custom.chart.name" . }} + {{ template "custom.chart.icon" . }} {{ template "chart.versionBadge" . }} diff --git a/hack/templates/README_CONFIG.md.gotmpl b/hack/templates/README_CONFIG.md.gotmpl index e93d80bfa..2a8b9ecc9 100644 --- a/hack/templates/README_CONFIG.md.gotmpl +++ b/hack/templates/README_CONFIG.md.gotmpl @@ -1,3 +1,7 @@ +{{- define "custom.chart.name" -}} +# {{ .Name }} +{{- end -}} + {{- define "custom.custom.configuration.header" -}} ## Custom configuration {{- end -}}