From f1c3954586d01b8838fb200f1e9de4376b5852dd Mon Sep 17 00:00:00 2001 From: WrenIX Date: Thu, 21 Nov 2024 16:45:16 +0100 Subject: [PATCH] chore(global): drop asciidoc support --- README.adoc | 26 ------ README.adoc.gotmpl | 87 ------------------- docs/antora.yml | 8 -- docs/modules/ROOT/nav.adoc | 1 - docs/modules/ROOT/pages/index.adoc | 1 - docs/modules/charts/generate.sh | 16 ---- docs/modules/charts/nav.adoc | 24 ----- .../charts/pages/alertmanager-matrix.adoc | 1 - .../charts/pages/alertmanager-ntfy.adoc | 1 - .../charts/pages/authentik-application.adoc | 1 - docs/modules/charts/pages/conduit.adoc | 1 - docs/modules/charts/pages/element-call.adoc | 1 - docs/modules/charts/pages/forgejo-runner.adoc | 1 - docs/modules/charts/pages/gotosocial.adoc | 1 - docs/modules/charts/pages/grampsweb.adoc | 1 - docs/modules/charts/pages/headscale-ui.adoc | 1 - docs/modules/charts/pages/headscale.adoc | 1 - docs/modules/charts/pages/home-assistant.adoc | 1 - docs/modules/charts/pages/hydrogen-web.adoc | 1 - docs/modules/charts/pages/jellyfin.adoc | 1 - .../pages/matrix-authentication-service.adoc | 1 - .../charts/pages/matrix-sliding-sync.adoc | 1 - docs/modules/charts/pages/matrix-synapse.adoc | 1 - docs/modules/charts/pages/mautrix-signal.adoc | 1 - docs/modules/charts/pages/miniserve.adoc | 1 - docs/modules/charts/pages/monitoring.adoc | 1 - docs/modules/charts/pages/ntfy.adoc | 1 - docs/modules/charts/pages/postgresql.adoc | 1 - .../charts/pages/speedtest-exporter.adoc | 1 - docs/modules/charts/pages/stalwart-mail.adoc | 1 - publish.sh | 4 +- 31 files changed, 2 insertions(+), 188 deletions(-) delete mode 100644 README.adoc delete mode 100644 README.adoc.gotmpl delete mode 100644 docs/antora.yml delete mode 100644 docs/modules/ROOT/nav.adoc delete mode 120000 docs/modules/ROOT/pages/index.adoc delete mode 100755 docs/modules/charts/generate.sh delete mode 100644 docs/modules/charts/nav.adoc delete mode 120000 docs/modules/charts/pages/alertmanager-matrix.adoc delete mode 120000 docs/modules/charts/pages/alertmanager-ntfy.adoc delete mode 120000 docs/modules/charts/pages/authentik-application.adoc delete mode 120000 docs/modules/charts/pages/conduit.adoc delete mode 120000 docs/modules/charts/pages/element-call.adoc delete mode 120000 docs/modules/charts/pages/forgejo-runner.adoc delete mode 120000 docs/modules/charts/pages/gotosocial.adoc delete mode 120000 docs/modules/charts/pages/grampsweb.adoc delete mode 120000 docs/modules/charts/pages/headscale-ui.adoc delete mode 120000 docs/modules/charts/pages/headscale.adoc delete mode 120000 docs/modules/charts/pages/home-assistant.adoc delete mode 120000 docs/modules/charts/pages/hydrogen-web.adoc delete mode 120000 docs/modules/charts/pages/jellyfin.adoc delete mode 120000 docs/modules/charts/pages/matrix-authentication-service.adoc delete mode 120000 docs/modules/charts/pages/matrix-sliding-sync.adoc delete mode 120000 docs/modules/charts/pages/matrix-synapse.adoc delete mode 120000 docs/modules/charts/pages/mautrix-signal.adoc delete mode 120000 docs/modules/charts/pages/miniserve.adoc delete mode 120000 docs/modules/charts/pages/monitoring.adoc delete mode 120000 docs/modules/charts/pages/ntfy.adoc delete mode 120000 docs/modules/charts/pages/postgresql.adoc delete mode 120000 docs/modules/charts/pages/speedtest-exporter.adoc delete mode 120000 docs/modules/charts/pages/stalwart-mail.adoc diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 1203432..0000000 --- a/README.adoc +++ /dev/null @@ -1,26 +0,0 @@ -= helm-charts - -== Usage - -Helm must be installed and setup to your kubernetes cluster to use the charts. -Refer to Helm's https://helm.sh/docs[documentation] to get started. -Once Helm has been set up correctly, fetch the charts as follows: - -[source,bash] ----- -helm pull oci://codeberg.org/wrenix/helm-charts/ ----- - -You can install a chart release using the following command: - -[source,bash] ----- -helm install oci://codeberg.org/wrenix/helm-charts/ --values values.yaml ----- - -To uninstall a chart release use `helm`'s delete command: - -[source,bash] ----- -helm uninstall ----- diff --git a/README.adoc.gotmpl b/README.adoc.gotmpl deleted file mode 100644 index 05424bd..0000000 --- a/README.adoc.gotmpl +++ /dev/null @@ -1,87 +0,0 @@ -{{ define "chart.header" }}= {{ .Name }} -{{ end }} -{{ define "chart.versionBadge" }} -image::https://img.shields.io/badge/Version-{{ .Version | replace "-" "--" }}-informational?style=flat-square[Version: {{ .Version }}]{{end}} -{{ define "chart.typeBadge" }} -image::https://img.shields.io/badge/Version-{{ .Type }}-informational?style=flat-square[Type: {{ .Type }}]{{end}} -{{ define "chart.appVersionBadge" }}{{- if (ne .AppVersion "") }} -image::https://img.shields.io/badge/AppVersion-{{ .AppVersion }}-informational?style=flat-square[AppVersion: {{ .AppVersion }}]{{ end }}{{end}} -{{ define "chart.maintainersHeader" }}== Maintainers{{ end }} -{{ define "chart.maintainersTable" }}.Maintainers -|=== -| Name | Email | Url - {{- range .Maintainers }} - -| {{ .Name }} -| {{ if .Email }}<{{ .Email }}>{{ end }} -| {{ if .Url }}<{{ .Url }}>{{ end }} - {{- end }} -|=== -{{ end }} -{{ define "chart.valuesHeader" }}== Values{{ end }} -{{ define "chart.valuesTable" -}} -{{- if .Sections.Sections -}} -{{- range .Sections.Sections }} -.Values {{.SectionName }} -{{ template "chart.valuesOneTable" .SectionItems }} -{{- end }}{{/* range sections*/}} -{{- if .Sections.DefaultSection.SectionItems -}} -.Values {{.Sections.DefaultSection.SectionName }} -{{ template "chart.valuesOneTable" .Sections.DefaultSection.SectionItems }} -{{- end }}{{/* end default section */}} -{{- else }}{{/* if no sections */}} -.Values -{{ template "chart.valuesOneTable" .Values }} -{{- end }} -{{ end }}{{/* end chart.valuesTable */}} -{{ define "chart.valuesOneTable" -}} -|=== -| Key | Type | Default | Description - {{- range . }} - -| {{ .Key }} -| {{ .Type }} -| {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} -| {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} - {{- end }} -|=== -{{ end }}{{/* end chart.valuesOneTable */}} - -{{- define "chart.prerequirements" -}}{{- end -}} - -{{ template "chart.header" . }} -{{ template "chart.deprecationWarning" . }} - -{{ template "chart.badgesSection" . }} -{{ template "chart.maintainersSection" . }} - -{{ template "chart.prerequirements" . }} - -== Usage - -Helm must be installed and setup to your kubernetes cluster to use the charts. -Refer to Helm's https://helm.sh/docs[documentation] to get started. -Once Helm has been set up correctly, fetch the charts as follows: - -[source,bash] ----- -helm pull oci://codeberg.org/wrenix/helm-charts/{{ template "chart.name" . }} ----- - -You can install a chart release using the following command: - -[source,bash] ----- -helm install {{ template "chart.name" . }}-release oci://codeberg.org/wrenix/helm-charts/{{ template "chart.name" . }} --values values.yaml ----- - -To uninstall a chart release use `helm`'s delete command: - -[source,bash] ----- -helm uninstall {{ template "chart.name" . }}-release ----- - -{{ template "chart.valuesSection" . }} - -Autogenerated from chart metadata using https://github.com/norwoodj/helm-docs[helm-docs] diff --git a/docs/antora.yml b/docs/antora.yml deleted file mode 100644 index 1bbd506..0000000 --- a/docs/antora.yml +++ /dev/null @@ -1,8 +0,0 @@ -name: wrenix-helm -title: "WrenIX's Helm charts" -version: - main: latest - -nav: - - modules/ROOT/nav.adoc - - modules/charts/nav.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc deleted file mode 100644 index 5d67faa..0000000 --- a/docs/modules/ROOT/nav.adoc +++ /dev/null @@ -1 +0,0 @@ -* xref:index.adoc[Home] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc deleted file mode 120000 index 2cfd4f7..0000000 --- a/docs/modules/ROOT/pages/index.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../README.adoc \ No newline at end of file diff --git a/docs/modules/charts/generate.sh b/docs/modules/charts/generate.sh deleted file mode 100755 index 8be5646..0000000 --- a/docs/modules/charts/generate.sh +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/sh -ROOT_DIR="./docs/modules/charts/" - -rm "${ROOT_DIR}/pages/"*".adoc" - -echo "* charts" > "${ROOT_DIR}/nav.adoc" -for name in * ; do - if \ - [ ! -d $name ] || \ - [ ! -f $name/Chart.yaml ] \ - ; then - continue; - fi - ln -sf "../../../../${name}/README.adoc" "${ROOT_DIR}/pages/${name}.adoc"; - echo "** xref:${name}.adoc[${name}]" >> "${ROOT_DIR}/nav.adoc" -done diff --git a/docs/modules/charts/nav.adoc b/docs/modules/charts/nav.adoc deleted file mode 100644 index 017ce21..0000000 --- a/docs/modules/charts/nav.adoc +++ /dev/null @@ -1,24 +0,0 @@ -* charts -** xref:alertmanager-matrix.adoc[alertmanager-matrix] -** xref:alertmanager-ntfy.adoc[alertmanager-ntfy] -** xref:authentik-application.adoc[authentik-application] -** xref:conduit.adoc[conduit] -** xref:element-call.adoc[element-call] -** xref:forgejo-runner.adoc[forgejo-runner] -** xref:gotosocial.adoc[gotosocial] -** xref:grampsweb.adoc[grampsweb] -** xref:headscale.adoc[headscale] -** xref:headscale-ui.adoc[headscale-ui] -** xref:home-assistant.adoc[home-assistant] -** xref:hydrogen-web.adoc[hydrogen-web] -** xref:jellyfin.adoc[jellyfin] -** xref:matrix-authentication-service.adoc[matrix-authentication-service] -** xref:matrix-sliding-sync.adoc[matrix-sliding-sync] -** xref:matrix-synapse.adoc[matrix-synapse] -** xref:mautrix-signal.adoc[mautrix-signal] -** xref:miniserve.adoc[miniserve] -** xref:monitoring.adoc[monitoring] -** xref:ntfy.adoc[ntfy] -** xref:postgresql.adoc[postgresql] -** xref:speedtest-exporter.adoc[speedtest-exporter] -** xref:stalwart-mail.adoc[stalwart-mail] diff --git a/docs/modules/charts/pages/alertmanager-matrix.adoc b/docs/modules/charts/pages/alertmanager-matrix.adoc deleted file mode 120000 index ff1eee6..0000000 --- a/docs/modules/charts/pages/alertmanager-matrix.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../alertmanager-matrix/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/alertmanager-ntfy.adoc b/docs/modules/charts/pages/alertmanager-ntfy.adoc deleted file mode 120000 index e2a0a08..0000000 --- a/docs/modules/charts/pages/alertmanager-ntfy.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../alertmanager-ntfy/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/authentik-application.adoc b/docs/modules/charts/pages/authentik-application.adoc deleted file mode 120000 index 70e47ed..0000000 --- a/docs/modules/charts/pages/authentik-application.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../authentik-application/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/conduit.adoc b/docs/modules/charts/pages/conduit.adoc deleted file mode 120000 index 6875802..0000000 --- a/docs/modules/charts/pages/conduit.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../conduit/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/element-call.adoc b/docs/modules/charts/pages/element-call.adoc deleted file mode 120000 index c551b35..0000000 --- a/docs/modules/charts/pages/element-call.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../element-call/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/forgejo-runner.adoc b/docs/modules/charts/pages/forgejo-runner.adoc deleted file mode 120000 index 0eb60e0..0000000 --- a/docs/modules/charts/pages/forgejo-runner.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../forgejo-runner/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/gotosocial.adoc b/docs/modules/charts/pages/gotosocial.adoc deleted file mode 120000 index 3bff7d2..0000000 --- a/docs/modules/charts/pages/gotosocial.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../gotosocial/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/grampsweb.adoc b/docs/modules/charts/pages/grampsweb.adoc deleted file mode 120000 index a22b6d5..0000000 --- a/docs/modules/charts/pages/grampsweb.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../grampsweb/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/headscale-ui.adoc b/docs/modules/charts/pages/headscale-ui.adoc deleted file mode 120000 index bcac646..0000000 --- a/docs/modules/charts/pages/headscale-ui.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../headscale-ui/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/headscale.adoc b/docs/modules/charts/pages/headscale.adoc deleted file mode 120000 index ae41e9a..0000000 --- a/docs/modules/charts/pages/headscale.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../headscale/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/home-assistant.adoc b/docs/modules/charts/pages/home-assistant.adoc deleted file mode 120000 index d31bc71..0000000 --- a/docs/modules/charts/pages/home-assistant.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../home-assistant/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/hydrogen-web.adoc b/docs/modules/charts/pages/hydrogen-web.adoc deleted file mode 120000 index bfe8227..0000000 --- a/docs/modules/charts/pages/hydrogen-web.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../hydrogen-web/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/jellyfin.adoc b/docs/modules/charts/pages/jellyfin.adoc deleted file mode 120000 index 90b210f..0000000 --- a/docs/modules/charts/pages/jellyfin.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../jellyfin/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/matrix-authentication-service.adoc b/docs/modules/charts/pages/matrix-authentication-service.adoc deleted file mode 120000 index 7f372d3..0000000 --- a/docs/modules/charts/pages/matrix-authentication-service.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../matrix-authentication-service/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/matrix-sliding-sync.adoc b/docs/modules/charts/pages/matrix-sliding-sync.adoc deleted file mode 120000 index abf59a4..0000000 --- a/docs/modules/charts/pages/matrix-sliding-sync.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../matrix-sliding-sync/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/matrix-synapse.adoc b/docs/modules/charts/pages/matrix-synapse.adoc deleted file mode 120000 index 88889a5..0000000 --- a/docs/modules/charts/pages/matrix-synapse.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../matrix-synapse/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/mautrix-signal.adoc b/docs/modules/charts/pages/mautrix-signal.adoc deleted file mode 120000 index 1376c24..0000000 --- a/docs/modules/charts/pages/mautrix-signal.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../mautrix-signal/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/miniserve.adoc b/docs/modules/charts/pages/miniserve.adoc deleted file mode 120000 index c268382..0000000 --- a/docs/modules/charts/pages/miniserve.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../miniserve/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/monitoring.adoc b/docs/modules/charts/pages/monitoring.adoc deleted file mode 120000 index 5852e47..0000000 --- a/docs/modules/charts/pages/monitoring.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../monitoring/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/ntfy.adoc b/docs/modules/charts/pages/ntfy.adoc deleted file mode 120000 index b037d84..0000000 --- a/docs/modules/charts/pages/ntfy.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../ntfy/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/postgresql.adoc b/docs/modules/charts/pages/postgresql.adoc deleted file mode 120000 index 05240d6..0000000 --- a/docs/modules/charts/pages/postgresql.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../postgresql/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/speedtest-exporter.adoc b/docs/modules/charts/pages/speedtest-exporter.adoc deleted file mode 120000 index 76661ca..0000000 --- a/docs/modules/charts/pages/speedtest-exporter.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../speedtest-exporter/README.adoc \ No newline at end of file diff --git a/docs/modules/charts/pages/stalwart-mail.adoc b/docs/modules/charts/pages/stalwart-mail.adoc deleted file mode 120000 index 36173e1..0000000 --- a/docs/modules/charts/pages/stalwart-mail.adoc +++ /dev/null @@ -1 +0,0 @@ -../../../../stalwart-mail/README.adoc \ No newline at end of file diff --git a/publish.sh b/publish.sh index 3cd653f..9851df7 100755 --- a/publish.sh +++ b/publish.sh @@ -53,7 +53,7 @@ for p in * ; do set -e echo "update docs" helm-docs -t ./README.md.gotmpl -t _docs.gotmpl -o README.md -g "${p}" - helm-docs -t ./README.adoc.gotmpl -t _docs.gotmpl -o README.adoc -g "${p}" + rm "${p}/README.adoc" echo "package and push helm-chart" helm package "${p}" @@ -67,7 +67,7 @@ for p in * ; do echo "push to git" set -e - git add "${p}/" "docs/modules/charts/nav.adoc" "docs/modules/charts/pages/${p}.adoc" + git add "${p}/" git commit -m "${COMMIT_SCOPE}(${p}): ${COMMIT_MESSAGE}" git tag "${tag}" --no-sign; git push --tags origin main;