From a9f7b4d7dbac9003872dcf186dd0fd65586aefbe Mon Sep 17 00:00:00 2001 From: Kjeld Schouten Date: Sat, 25 May 2024 12:30:16 +0200 Subject: [PATCH] Improve links in readme/docs a bit --- .github/scripts/chart-docs.sh | 6 ++++-- templates/README.md.tpl | 16 +++++++++------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/.github/scripts/chart-docs.sh b/.github/scripts/chart-docs.sh index 2bccd66c2a8..05f956c5d75 100755 --- a/.github/scripts/chart-docs.sh +++ b/.github/scripts/chart-docs.sh @@ -161,9 +161,11 @@ process_index() { echo "The link is: ${link}" echo "- ${link}" >>${index_path} done - echo "" >>${index_path} - echo -e "## Readme Content\n" >>website/src/content/docs/charts/${train}/${chart}/index.md + echo "" >>${index_path} + echo "---" >>${index_path} + echo "" >>${index_path} + echo -e "## Readme\n" >>website/src/content/docs/charts/${train}/${chart}/index.md tail -n +4 "charts/${train}/${chart}/README.md" >>website/src/content/docs/charts/${train}/${chart}/readmetmp.md sed -i 's/##/###/' "website/src/content/docs/charts/${train}/${chart}/readmetmp.md" cat "website/src/content/docs/charts/${train}/${chart}/readmetmp.md" >>"website/src/content/docs/charts/${train}/${chart}/index.md" diff --git a/templates/README.md.tpl b/templates/README.md.tpl index ee758deb77e..d744216cf6a 100644 --- a/templates/README.md.tpl +++ b/templates/README.md.tpl @@ -21,26 +21,28 @@ To install TrueCharts Helm charts using Helm, you can use our OCI Repository. For more information on how to install TrueCharts Helm charts, checkout the instructions on the website: https://truecharts.org/helm/ - -### TrueNAS SCALE Apps - -For more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the [quick-start guides for TrueNAS SCALE](https://truecharts.org/scale/guides/scale-intro). - -## Configuration Options +#### Configuration Options To view the chart specific options, please view Values.yaml included in the chart. +The most recent version of which, is available here: https://github.com/truecharts/charts/charts/TRAINPLACEHOLDER/CHARTPLACEHOLDER/values.yaml All our Charts use a shared "common" library chart that contains most of the templating and options. For the complete overview of all available options, please checkout the documentation for them on the website: https://truecharts.org/common/ +For information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/truecharts/library-charts/blob/main/library/common/values.yaml + +### TrueNAS SCALE Apps + +For more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the [quick-start guides for TrueNAS SCALE](https://truecharts.org/scale). + ## Chart Specific Guides and information All our charts have dedicated documentation pages. The documentation for this chart can be found here: https://truecharts.org/charts/TRAINPLACEHOLDER/CHARTPLACEHOLDER -## Support +## Support - See the [Website](https://truecharts.org) - Check our [Discord](https://discord.gg/tVsPTHWTtr)