From a4058ca0012211a7d700f1056c742d996241c726 Mon Sep 17 00:00:00 2001 From: TrueCharts-Bot Date: Sat, 1 May 2021 19:56:12 +0000 Subject: [PATCH] Commit docs updates Signed-off-by: TrueCharts-Bot --- docs/apps/incubator/podgrab/CONFIG.md | 8 ++++ docs/apps/incubator/podgrab/index.md | 54 +++++++++++++++++++++++++++ incubator/podgrab/1.0.0/README.md | 2 +- incubator/podgrab/1.0.0/app-readme.md | 2 +- 4 files changed, 64 insertions(+), 2 deletions(-) create mode 100644 docs/apps/incubator/podgrab/CONFIG.md create mode 100644 docs/apps/incubator/podgrab/index.md diff --git a/docs/apps/incubator/podgrab/CONFIG.md b/docs/apps/incubator/podgrab/CONFIG.md new file mode 100644 index 00000000000..6d760c18421 --- /dev/null +++ b/docs/apps/incubator/podgrab/CONFIG.md @@ -0,0 +1,8 @@ +# Configuration Options + +##### 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. diff --git a/docs/apps/incubator/podgrab/index.md b/docs/apps/incubator/podgrab/index.md new file mode 100644 index 00000000000..85223e52144 --- /dev/null +++ b/docs/apps/incubator/podgrab/index.md @@ -0,0 +1,54 @@ +# Introduction + +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square) + +A self-hosted podcast manager to download episodes as soon as they become live. + +TrueCharts are designed to be installed as TrueNAS SCALE app only. We can not guarantee this charts works as a stand-alone helm installation. +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/apps/issues/new/choose)** + +## Source Code + +* +* + +## Requirements + +Kubernetes: `>=1.16.0-0` + +## Dependencies + +| Repository | Name | Version | +|------------|------|---------| +| https://truecharts.org/ | common | 3.5.2 | + +## Installing the Chart + +To install the chart with the release name `podgrab` + +- Open TrueNAS SCALE +- Go to Apps +- Click "Install" for this specific Apps +- Fill out the configuration form + +## Uninstalling the Chart + +To uninstall the `podgrab` deployment + +- Open TrueNAS SCALE +- Go to Apps +- Go to "Installed Apps" +- Expand the menu in the top-right corner of this App +- Click "Remove" for this specific Apps + +The command removes all the Kubernetes components associated with the chart **including storage volumes** _(Except hostPath Storage)_ and deletes the release. + +## Support + +- 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) + +---------------------------------------------- +Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0) +All Rights Reserved - The TrueCharts Project diff --git a/incubator/podgrab/1.0.0/README.md b/incubator/podgrab/1.0.0/README.md index 5ff183126b5..85223e52144 100644 --- a/incubator/podgrab/1.0.0/README.md +++ b/incubator/podgrab/1.0.0/README.md @@ -1,6 +1,6 @@ # Introduction -![Version: 3.1.2](https://img.shields.io/badge/Version-3.1.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square) +![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square) A self-hosted podcast manager to download episodes as soon as they become live. diff --git a/incubator/podgrab/1.0.0/app-readme.md b/incubator/podgrab/1.0.0/app-readme.md index 5a36cdd1cef..d2f853b98fe 100644 --- a/incubator/podgrab/1.0.0/app-readme.md +++ b/incubator/podgrab/1.0.0/app-readme.md @@ -1,2 +1,2 @@ -Podgrab - podcast downloader and player +A self-hosted podcast manager to download episodes as soon as they become live. This App is supplied by TrueCharts, for more information please visit https://truecharts.org