Cloned2Preserve
/
TrueChartsClone
mirror of https://github.com/truecharts/charts.git
1
0
Fork 0
Code

Improve links in readme/docs a bit

This commit is contained in:
Kjeld Schouten 2024-05-25 12:30:16 +02:00
parent df12568a69
commit a9f7b4d7db
2 changed files with 13 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.github/scripts/chart-docs.sh vendored
View File

@ -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"

16
templates/README.md.tpl
View File

@ -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)