Add and Update documentation and workflows

Co-authored-by: Stavros Kois <47820033+stavros-k@users.noreply.github.com>

.github/CODEOWNERS

@@ -1,6 +1,26 @@
 # Default code owner
 *       @ornias1993
 
-/charts/esphome/*	@tprelog
-/charts/unifi/*     @whiskerz007
-/charts/emby/* @djs52
+# Apps maintained by ornias1993
+sonarr/	@ornias1993
+radarr/	@ornias1993
+traefik/	@ornias1993
+plex/	@ornias1993
+lidarr/	@ornias1993
+jackett/	@ornias1993
+kms/	@ornias1993
+ombi/	@ornias1993
+transmission/	@ornias1993
+tautulli/	@ornias1993
+
+# Apps maintained by tprelog
+esphome/	@tprelog
+zwavejs2mqtt/	@tprelog
+home-assistant/	@tprelog
+
+# Apps maintained by stavros-k
+handbrake/*	@stavros-k
+collabora-online/	@stavros-k
+
+# Apps maintained by djs52
+emby/ @djs52

.github/ISSUE_TEMPLATE/app_request.md

@@ -7,21 +7,5 @@ assignees: ''
 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+**Describe the app you request to be added**
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,8 +1,8 @@
 ---
-name: Feature request
+name: Feature or Enhancement request
 about: Suggest an idea for this project
 title: ''
-labels: Feature
+labels: enhancement
 assignees: ''
 
 ---

.github/README.md

@@ -13,13 +13,10 @@ All our apps are supposed to work together, be easy to setup using the TrueNAS U
 
 
 ## Getting started using TrueCharts
-Installing TrueCharts within TrueNAS SCALE, still requires the CLI. However it's not hard:
-- Go to you shell of choice (either SSH or the TrueNAS webui shell)
-- enter `cli`
-- enter `app catalog create repository="https://github.com/truecharts/apps" label="TrueCharts"`
+Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list.
 
-For more information, please visit our website:
-https://truecharts.org
+For more information:
+https://truecharts.org/manual/adding-truecharts/
 
 ## FAQ
 

.github/workflows/docs.copy.yaml

@@ -11,6 +11,8 @@ on:
     paths:
       - 'library/**/Chart.yaml'
       - '.tools/gen-helm-docs.sh'
+      - '.tools/templates/docs/**'
+      - '.tools/templates/app/*.gotmpl'
       - '**.gotmpl'
       - '**/LICENSE'
       - '**LICENSE'
@@ -43,7 +45,7 @@ jobs:
       - name: Copy general readme to website
         run: |
           yes | cp -rf .github/README.md docs/about/index.md || echo "readme copy failed, continuing..."
-           yes | cp -rf .github/CODE_OF_CONDUCT docs/about/code_of_conduct.md || echo "CODE_OF_CONDUCT copy failed, continuing..."
+          yes | cp -rf .github/CODE_OF_CONDUCT docs/about/code_of_conduct.md || echo "CODE_OF_CONDUCT copy failed, continuing..."
           yes | cp -rf .github/CONTRIBUTING docs/development/contributing.md || echo "CONTRIBUTING copy failed, continuing..."
           yes | cp -rf LICENSE docs/about/LICENSE.md || echo "license copy failed, continuing..."
           sed -i '1s/^/# License<br>\n\n/' docs/about/LICENSE.md
@@ -60,6 +62,7 @@ jobs:
                 echo "Processing: ${chart} - folder: ${maxfolderversion}"
                 mkdir -p docs/apps/${chartname} || echo "app path already exists, continuing..."
                 yes | cp -rf ${chart}/${maxfolderversion}/README.md docs/apps/${chartname}/index.md || echo "readme copy failed, continuing..."
+                yes | cp -rf ${chart}/${maxfolderversion}/CONFIG.md docs/apps/${chartname}/CONFIG.md || echo "config copy failed, continuing..."
                 yes | cp -rf ${chart}/${maxfolderversion}/LICENSE docs/apps/${chartname}/LICENSE.md || echo "license copy failed, continuing..."
                 sed -i '1s/^/# License<br>\n\n/' docs/apps/${chartname}/LICENSE.md || echo "license edit failed, continuing..."
             fi
@@ -75,6 +78,7 @@ jobs:
                 echo "Processing: ${chart} - folder: ${maxfolderversion}"
                 mkdir -p docs/apps/${chartname} || echo "app path already exists, continuing..."
                 yes | cp -rf ${chart}/${maxfolderversion}/README.md docs/apps/${chartname}/index.md || echo "readme copy failed, continuing..."
+                yes | cp -rf ${chart}/${maxfolderversion}/CONFIG.md docs/apps/${chartname}/CONFIG.md || echo "config copy failed, continuing..."
                 yes | cp -rf ${chart}/${maxfolderversion}/LICENSE docs/apps/${chartname}/LICENSE.md || echo "license copy failed, continuing..."
                 sed -i '1s/^/# License<br>\n\n/' docs/apps/${chartname}/LICENSE.md || echo "license edit failed, continuing..."
             fi

.github/workflows/docs.deploy.yaml

@@ -8,6 +8,7 @@ on:
     paths:
       - 'docs/**'
       - '.github/workflows/docs.deploy.yaml'
+      - 'mkdocs.yml'
 
 jobs:
   build:

.tools/gen-helm-docs.sh

@@ -14,9 +14,9 @@ command -v helm-docs >/dev/null 2>&1 || {
 repository=$(git rev-parse --show-toplevel)
 
 # Templates to copy into each chart directory
-readme_template="${repository}/.tools/templates/chart/README.md.gotmpl"
-config_template="${repository}/.tools/templates/chart/CONFIG.md.gotmpl"
-app_readme_template="${repository}/.tools/templates/chart/app-readme.md.gotmpl"
+readme_template="${repository}/.tools/templates/docs/README.md.gotmpl"
+config_template="${repository}/.tools/templates/docs/CONFIG.md.gotmpl"
+app_readme_template="${repository}/.tools/templates/docs/app-readme.md.gotmpl"
 
 root="${repository}"
 
@@ -27,49 +27,20 @@ for chart in stable/*; do
       chartname=$(basename ${chart})
       echo "-] Copying templates to ${repository}/${chart}/${maxfolderversion}"
       # Copy CONFIG template to each Chart directory, do not overwrite if exists
-      cp -n "${config_template}" "${chart}/${maxfolderversion}/CONFIG.md.gotmpl" || true
-      helm-docs \
-          --ignore-file=".helmdocsignore" \
-		  --output-file="README.md" \
-          --template-files="${repository}/.tools/templates/chart/README.md.gotmpl" \
-          --chart-search-root="${chart}/${maxfolderversion}"
-      helm-docs \
-          --ignore-file=".helmdocsignore" \
-          --output-file="CONFIG.md" \
-          --template-files="${chart}/${maxfolderversion}/CONFIG.md.gotmpl" \
-          --chart-search-root="${chart}/${maxfolderversion}"
       helm-docs \
           --ignore-file=".helmdocsignore" \
-          --output-file="app-readme.md" \
-          --template-files="${repository}/.tools/templates/chart/app-readme.md.gotmpl" \
-          --chart-search-root="${chart}/${maxfolderversion}"
-
-
-  fi
-done
-
-for chart in stable/*; do
-  if [ -d "${chart}" ]; then
-      maxfolderversion=$(ls -l ${chart} | grep ^d | awk '{print $9}' | tail -n 1)
-      maxchartversion=$(cat ${chart}/${maxfolderversion}/Chart.yaml | grep "^version: " | awk -F" " '{ print $2 }')
-      chartname=$(basename ${chart})
-      echo "-] Copying templates to ${repository}/${chart}/${maxfolderversion}"
-      # Copy CONFIG template to each Chart directory, do not overwrite if exists
-      cp -n "${config_template}" "${chart}/${maxfolderversion}/CONFIG.md.gotmpl" || true
-      helm-docs \
-          --ignore-file=".helmdocsignore" \
-		  --output-file="README.md" \
-          --template-files="${repository}/.tools/templates/chart/README.md.gotmpl" \
+          --output-file="README.md" \
+          --template-files="${repository}/.tools/templates/docs/README.md.gotmpl" \
           --chart-search-root="${chart}/${maxfolderversion}"
       helm-docs \
           --ignore-file=".helmdocsignore" \
           --output-file="CONFIG.md" \
-          --template-files="${chart}/${maxfolderversion}/CONFIG.md.gotmpl" \
+          --template-files="${repository}/.tools/templates/docs/CONFIG.md.gotmpl" \
           --chart-search-root="${chart}/${maxfolderversion}"
       helm-docs \
           --ignore-file=".helmdocsignore" \
           --output-file="app-readme.md" \
-          --template-files="${repository}/.tools/templates/chart/app-readme.md.gotmpl" \
+          --template-files="${repository}/.tools/templates/docs/app-readme.md.gotmpl" \
           --chart-search-root="${chart}/${maxfolderversion}"
 
 
@@ -87,17 +58,17 @@ for chart in beta/*; do
       helm-docs \
           --ignore-file=".helmdocsignore" \
 		  --output-file="README.md" \
-          --template-files="${repository}/.tools/templates/chart/README.md.gotmpl" \
+          --template-files="${repository}/.tools/templates/docs/README.md.gotmpl" \
           --chart-search-root="${chart}/${maxfolderversion}"
       helm-docs \
           --ignore-file=".helmdocsignore" \
           --output-file="CONFIG.md" \
-          --template-files="${chart}/${maxfolderversion}/CONFIG.md.gotmpl" \
+          --template-files="${repository}/.tools/templates/docs/CONFIG.md.gotmpl" \
           --chart-search-root="${chart}/${maxfolderversion}"
       helm-docs \
           --ignore-file=".helmdocsignore" \
           --output-file="app-readme.md" \
-          --template-files="${repository}/.tools/templates/chart/app-readme.md.gotmpl" \
+          --template-files="${repository}/.tools/templates/docs/app-readme.md.gotmpl" \
           --chart-search-root="${chart}/${maxfolderversion}"
 
 

.tools/templates/docs/CONFIG.md.gotmpl

@@ -0,0 +1,17 @@
+{{- define "custom.custom.configuration.header" -}}
+# Configuration Options
+{{- end -}}
+
+{{- define "custom.custom.configuration" -}}
+{{ template "custom.custom.configuration.header" . }}
+
+##### Connecting to other apps
+If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Together" guide:
+https://truecharts.org/manual/linking/
+
+
+##### Available config options
+In the future this page is going to contain an automated list of options available in the installation/edit UI.
+{{- end -}}
+
+{{ template "custom.custom.configuration" . }}

.tools/templates/chart/README.md.gotmpl → .tools/templates/docs/README.md.gotmpl

@@ -60,14 +60,10 @@ To uninstall the `{{ template "chart.name" . }}` deployment
 The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release.
 {{- end -}}
 
-{{- define "custom.configuration.header" -}}
-## Configuration
-{{- end -}}
-
 {{- define "custom.support" -}}
 ## Support
 
-- See the [Wiki](https://wiki.truecharts.org)
+- See the [Wiki](https://truecharts.org)
 - Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
 - Ask a [question](https://github.com/truecharts/apps/discussions)
 {{- end -}}

docs/about/FAQ.md

@@ -1,27 +1,21 @@
 # FAQ
 
-- Q: I tried to run TrueCharts on TrueNAS SCALE 20.12 and it doesn't work.<br>
-A: TrueNAS SCALE 20.12 has never supported custom charts in any way, shape or form. Hence TrueCharts is 21.02+ only
+- Q: I tried to run TrueCharts on TrueNAS SCALE 20.12 or 21.02 and it doesn't work.<br>
+A: TrueNAS SCALE 20.12 has never supported custom charts in any way, shape or form. Hence TrueCharts is 21.04+ only
 
 - Q: Please include app X<br>
 A: Please file an issue about it, after checking the wiki to make sure it hasn't been discussed already:
 https://github.com/truecharts/apps/wiki/k8s-at-home-to-SCALE-App-migration-list
 
 - Q: Isn't there more documentation for app x<br>
-A: If it's not on our [wiki](https://wiki.truecharts.org), we do not. Currently during TrueNAS SCALE ALPHA/BETA we focus on the technical aspects.
+A: If it's not on our [website](https://truecharts.org), we do not. There might be other sources for documentation however!
 
 - Q: Function x doesn't seem to be working, should it be working?<br>
 A: Maybe, please file an issue
 
 - Q: I'm missing a lot of configuration opions in the install GUI.<br>
 A: We try to aim for a balance in the amount of options vs the simplicity of installation. Suggestions are always welcome
 
-- Q: The portal button isn't working.<br>
-A: Portal buttons are current't not implemented very well and are considered "not supported" for the time being
-
-- Q: I selected letsencrypt but still get a traefik certificate.<br>
-A: Cert Manager might take up to 10 minutes to fetch the right certificate and requires free access to 1.1.1.1:53. Until the right certificate is fetched, it will use the Traefik Default cert.
-
 - Q: Is my data guaranteed to be secure?<br>
 A: ix_volumes (the auto generated storage) is considered relatively secure as long as you don't delete the App, but we can't give an absolute guarantee. data mounted using a hostPath, is as secure as the application that is using the data, our charts do not actively alter said dataset/folder. However: SCALE is still ALPHA, so breaking changes in the storage design are very likely.
 

docs/about/index.md

@@ -13,13 +13,10 @@ All our apps are supposed to work together, be easy to setup using the TrueNAS U
 
 
 ## Getting started using TrueCharts
-Installing TrueCharts within TrueNAS SCALE, still requires the CLI. However it's not hard:
-- Go to you shell of choice (either SSH or the TrueNAS webui shell)
-- enter `cli`
-- enter `app catalog create repository="https://github.com/truecharts/apps" label="TrueCharts"`
+Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list.
 
-For more information, please visit our website:
-https://truecharts.org
+For more information:
+https://truecharts.org/manual/adding-truecharts/
 
 ## FAQ
 

docs/apps/bazarr/CONFIG.md

@@ -1,3 +1,8 @@
 # Configuration Options
 
-N/A
+##### Connecting to other apps
+If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Together" guide:
+https://truecharts.org/manual/linking/
+
+##### Available config options
+In the future this page is going to contain an automated list of options available in the installation/edit UI.

docs/apps/bazarr/index.md

@@ -47,7 +47,7 @@ The command removes all the Kubernetes components associated with the chart **in
 
 ## Support
 
-- See the [Wiki](https://wiki.truecharts.org)
+- See the [Wiki](https://truecharts.org)
 - Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
 - Ask a [question](https://github.com/truecharts/apps/discussions)
 

docs/apps/calibre-web/CONFIG.md

@@ -1,3 +1,8 @@
 # Configuration Options
 
-N/A
+##### Connecting to other apps
+If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Together" guide:
+https://truecharts.org/manual/linking/
+
+##### Available config options
+In the future this page is going to contain an automated list of options available in the installation/edit UI.

docs/apps/calibre-web/index.md

@@ -47,7 +47,7 @@ The command removes all the Kubernetes components associated with the chart **in
 
 ## Support
 
-- See the [Wiki](https://wiki.truecharts.org)
+- See the [Wiki](https://truecharts.org)
 - Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
 - Ask a [question](https://github.com/truecharts/apps/discussions)
 

docs/apps/collabora-online/CONFIG.md

@@ -1,3 +1,8 @@
 # Configuration Options
 
-N/A
+##### Connecting to other apps
+If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Together" guide:
+https://truecharts.org/manual/linking/
+
+##### Available config options
+In the future this page is going to contain an automated list of options available in the installation/edit UI.

docs/apps/collabora-online/index.md

@@ -47,7 +47,7 @@ The command removes all the Kubernetes components associated with the chart **in
 
 ## Support
 
-- See the [Wiki](https://wiki.truecharts.org)
+- See the [Wiki](https://truecharts.org)
 - Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
 - Ask a [question](https://github.com/truecharts/apps/discussions)
 

docs/apps/collabora-online/notes.md

@@ -0,0 +1,8 @@
+# Installation Notes
+
+* If you don't enable `Reverse Proxy` on `Collabora` (It's not recommended as it is unsecure), in order for it to work you have to 
+    * Remove `-o:ssl.termination=true -o:ssl.enable=false` from `Extra Parameters`.
+    * Set `Server Name` to `hostIP:port` (The port number you set for `NodePort`)
+    * Set `Service type` to `NodePort`
+    * Set `Port type` to `HTTPS`
+    * Disable certificate validation in the app you are going to use it. (eg. Nextcloud have a checkbox under Collabora's URL to disable Cert Validtation)

docs/apps/emby/CONFIG.md

@@ -1,3 +1,8 @@
 # Configuration Options
 
-N/A
+##### Connecting to other apps
+If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our "Linking Apps Together" guide:
+https://truecharts.org/manual/linking/
+
+##### Available config options
+In the future this page is going to contain an automated list of options available in the installation/edit UI.

docs/apps/emby/index.md

@@ -46,7 +46,7 @@ The command removes all the Kubernetes components associated with the chart **in
 
 ## Support
 
-- See the [Wiki](https://wiki.truecharts.org)
+- See the [Wiki](https://truecharts.org)
 - Open a [issue](https://github.com/truecharts/apps/issues/new/choose)
 - Ask a [question](https://github.com/truecharts/apps/discussions)