fix(docs): fix links (#3362)
* fix(docs): fix links * update report to charts * update some references from apps -> charts
This commit is contained in:
Stavros Kois
+1
-1
@@ -2,7 +2,7 @@ style: github
|
||||
template: CHANGELOG.tpl.md
|
||||
info:
|
||||
title: CHANGELOG
|
||||
repository_url: https://github.com/truecharts/apps
|
||||
repository_url: https://github.com/truecharts/charts
|
||||
options:
|
||||
commits:
|
||||
# filters:
|
||||
|
||||
+16
-16
@@ -1,14 +1,14 @@
|
||||
# TrueCharts
|
||||
|
||||
**Community App Catalog for TrueNAS SCALE**
|
||||
**Community Chart Catalog for TrueNAS SCALE**
|
||||
|
||||
[](https://truecharts.org/)
|
||||
[](https://discord.gg/Js6xv9nGuU)
|
||||
[](https://github.com/truecharts/apps/commits)
|
||||
[](https://github.com/truecharts/charts/commits)
|
||||
|
||||
---
|
||||
|
||||
TrueCharts is a catalog of highly optimised TrueNAS SCALE Apps. Made for the community, By the community!
|
||||
TrueCharts is a catalog of highly optimised TrueNAS SCALE Charts. Made for the community, By the community!
|
||||
|
||||
Our primary goals are:
|
||||
|
||||
@@ -20,7 +20,7 @@ Our primary goals are:
|
||||
|
||||
- Consistency
|
||||
|
||||
All our apps are supposed to work together, be easy to setup using the TrueNAS UI and, above all, give the average user more than enough options to tune things to their liking.
|
||||
All our charts are supposed to work together, be easy to setup using the TrueNAS UI and, above all, give the average user more than enough options to tune things to their liking.
|
||||
|
||||
<br />
|
||||
|
||||
@@ -54,13 +54,13 @@ _The current project is hitting internal performance issues, for this reason we
|
||||
|
||||
**Refactor the Common Chart - TrueNAS SCALE "Bluefin" 22.xx ALPHA 2**
|
||||
|
||||
_The shared Common (chart) basis, used by all our Apps, needs some significant code cleanup. Primarily all code needs to follow a standardised format and comply to the same standard_
|
||||
_The shared Common (chart) basis, used by all our Charts, needs some significant code cleanup. Primarily all code needs to follow a standardised format and comply to the same standard_
|
||||
|
||||
<br />
|
||||
|
||||
**Increased test coverage - TrueNAS SCALE "Bluefin" 22.xx BETA 1**
|
||||
|
||||
_With most parts of our project somewhat cleaned up, we need to work on increasing the coverage of our test system. Our unittests should cover all features and we should also take upgrades into account when testing App changes_
|
||||
_With most parts of our project somewhat cleaned up, we need to work on increasing the coverage of our test system. Our unittests should cover all features and we should also take upgrades into account when testing Chart changes_
|
||||
|
||||
<br />
|
||||
|
||||
@@ -68,18 +68,18 @@ _With most parts of our project somewhat cleaned up, we need to work on increasi
|
||||
|
||||
[](https://github.com/pre-commit/pre-commit)
|
||||
[](https://github.com/renovatebot/renovate)
|
||||
[](https://github.com/truecharts/apps/commits)
|
||||
[](https://github.com/truecharts/charts/commits)
|
||||
|
||||
---
|
||||
|
||||
Our development process is fully distributed and agile, so every chart-maintainer is free to set their own roadmap and development speed and does not have to comply to a centralised roadmap.
|
||||
This ensures freedom and flexibility for everyone involved and makes sure you, the end user, always has the latest and greatest of every App installed.
|
||||
This ensures freedom and flexibility for everyone involved and makes sure you, the end user, always has the latest and greatest of every Chart installed.
|
||||
|
||||
### Getting into creating Apps
|
||||
### Getting into creating Charts
|
||||
|
||||
Creating charts takes some getting used to, as it's based on Helm charts. We highly suggest prior know-how on creation/modifying Helm Charts, before taking on the challenge of creating SCALE Apps.
|
||||
|
||||
For more information on creating SCALE Apps and Helm charts, please check out our [development manual](https://truecharts.org/)
|
||||
For more information on creating SCALE Apps and Helm charts, please check out our [development manual](https://truecharts.org/docs/manual/development/License-headers)
|
||||
|
||||
### Automation and you
|
||||
|
||||
@@ -97,13 +97,13 @@ Those tools do, however, take time to develop and are certainly not bug free. If
|
||||
|
||||
To contact the TrueCharts project:
|
||||
|
||||
- Create an issue on [Github issues](https://github.com/truecharts/apps/issues)
|
||||
- Create an issue on [Github issues](https://github.com/truecharts/charts/issues)
|
||||
|
||||
- Open a [Support Ticket](https://truecharts.org/discord)
|
||||
- Open a [Support Ticket](https://discord.com/channels/830763548678291466/936275413179723826)
|
||||
|
||||
- Send us an [email](mailto://info@truecharts.org)
|
||||
|
||||
- Or [join our Discord server](https://truecharts.org/discord)
|
||||
- Or [join our Discord server](https://discord.gg/tVsPTHWTtr)
|
||||
|
||||
<br />
|
||||
|
||||
@@ -294,13 +294,13 @@ This project follows the [all-contributors](https://github.com/all-contributors/
|
||||
|
||||
## Licence
|
||||
|
||||
[](https://github.com/truecharts/apps/blob/master/docs/LICENSE.BSD3)
|
||||
[](https://github.com/truecharts/charts/blob/master/docs/LICENSE.BSD3)
|
||||
|
||||
---
|
||||
|
||||
Truecharts as a whole, is based on a BSD-3-clause license, this ensures almost everyone can use and modify our charts. However: As a lot of Apps are based on upstream Helm Charts, Licences can vary on a per-App basis. This can easily be seen by the presence of a "LICENSE" file in the App root folder.
|
||||
Truecharts as a whole, is based on a BSD-3-clause license, this ensures almost everyone can use and modify our charts. However: As a lot of Charts are based on upstream Helm Charts, Licences can vary on a per-Chart basis. This can easily be seen by the presence of a "LICENSE" file in the Chart root folder.
|
||||
|
||||
Some Apps may also contain parts in other licenses, such as libraries or templates, these files can be recognised by their individual headers.
|
||||
Some Charts may also contain parts in other licenses, such as libraries or templates, these files can be recognised by their individual headers.
|
||||
|
||||
`SPDX-License-Identifier: BSD-3-Clause`
|
||||
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
owner: truecharts
|
||||
git-repo: apps
|
||||
repo: apps
|
||||
git-repo: charts
|
||||
repo: charts
|
||||
charts-dir: charts/*
|
||||
charts_repo_url: "https://charts.truecharts.org"
|
||||
SkipExisting: true
|
||||
|
||||
@@ -306,7 +306,7 @@ clean_apps() {
|
||||
local chartname="$2"
|
||||
local train="$3"
|
||||
local chartversion="$4"
|
||||
echo "Cleaning SCALE catalog for App: ${chartname}"
|
||||
echo "Cleaning SCALE catalog for Chart: ${chartname}"
|
||||
rm -Rf catalog/${train}/${chartname}/${chartversion} 2>/dev/null || :
|
||||
rm -Rf catalog/${train}/${chartname}/item.yaml 2>/dev/null || :
|
||||
}
|
||||
@@ -318,7 +318,7 @@ patch_apps() {
|
||||
local train="$3"
|
||||
local chartversion="$4"
|
||||
local target="catalog/${train}/${chartname}/${chartversion}"
|
||||
echo "Applying SCALE patches for App: ${chartname}"
|
||||
echo "Applying SCALE patches for Chart: ${chartname}"
|
||||
sed -i '100,$ d' ${target}/CHANGELOG.md || :
|
||||
mv ${target}/app-changelog.md ${target}/CHANGELOG.md 2>/dev/null || :
|
||||
# Temporary fix to prevent the UI from bugging out on 21.08
|
||||
|
||||
@@ -3,7 +3,7 @@ set -o errexit
|
||||
set -o nounset
|
||||
set -o pipefail
|
||||
|
||||
# Designed to ensure the appversion in Chart.yaml is in sync with the primary App tag if found
|
||||
# Designed to ensure the appversion in Chart.yaml is in sync with the primary Chart tag if found
|
||||
# Also makes sure that home link is pointing to the correct url
|
||||
sync_tag() {
|
||||
local chart="$1"
|
||||
|
||||
@@ -36,6 +36,6 @@ jobs:
|
||||
- uses: vishnudxb/cancel-workflow@c3c77eb4383ba7d023e6614a07d94fe990501ac6 # tag=v1.2
|
||||
if: failure()
|
||||
with:
|
||||
repo: truecharts/apps
|
||||
repo: truecharts/charts
|
||||
workflow_id: ${{ github.run_id }}
|
||||
access_token: ${{ github.token }}
|
||||
|
||||
@@ -321,6 +321,6 @@ jobs:
|
||||
- uses: vishnudxb/cancel-workflow@c3c77eb4383ba7d023e6614a07d94fe990501ac6 # tag=v1.2
|
||||
if: failure()
|
||||
with:
|
||||
repo: truecharts/apps
|
||||
repo: truecharts/chart
|
||||
workflow_id: ${{ github.run_id }}
|
||||
access_token: ${{ github.token }}
|
||||
|
||||
@@ -409,6 +409,6 @@ jobs:
|
||||
- uses: vishnudxb/cancel-workflow@c3c77eb4383ba7d023e6614a07d94fe990501ac6 # tag=v1.2
|
||||
if: failure()
|
||||
with:
|
||||
repo: truecharts/apps
|
||||
repo: truecharts/charts
|
||||
workflow_id: ${{ github.run_id }}
|
||||
access_token: ${{ github.token }}
|
||||
|
||||
@@ -88,5 +88,5 @@ jobs:
|
||||
git config user.name "TrueCharts-Bot"
|
||||
git config user.email "bot@truecharts.org"
|
||||
git add --all
|
||||
git commit -sm "Commit bumped App Version" || exit 0
|
||||
git commit -sm "Commit bumped Chart Version" || exit 0
|
||||
git push
|
||||
|
||||
@@ -6,12 +6,12 @@ appVersion: 1.0.0
|
||||
description: CHARTNAME App for TrueNAS SCALE
|
||||
type: application
|
||||
deprecated: false
|
||||
home: https://github.com/truecharts/apps/tree/master/charts/stable/CHARTNAME
|
||||
icon: https://raw.githubusercontent.com/truecharts/apps/master/stable/CHARTNAME/icon.png?raw=true
|
||||
home: https://github.com/truecharts/charts/tree/master/charts/stable/CHARTNAME
|
||||
icon: https://raw.githubusercontent.com/truecharts/charts/master/stable/CHARTNAME/icon.png?raw=true
|
||||
keywords:
|
||||
- CHARTNAME
|
||||
sources:
|
||||
- https://github.com/truecharts/apps/tree/master/charts/CHARTNAME
|
||||
- https://github.com/truecharts/charts/tree/master/charts/CHARTNAME
|
||||
dependencies:
|
||||
- name: common
|
||||
repository: https://library-charts.truecharts.org
|
||||
|
||||
@@ -33,7 +33,7 @@ For more information, please click here: [{{ template "chart.name" . }}](https:/
|
||||
|
||||
### TrueNAS SCALE
|
||||
|
||||
To install this App on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/Quick-Start%20Guides/02-Installing-an-App/).
|
||||
To install this Chart on TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Installing-an-App).
|
||||
|
||||
### Helm
|
||||
|
||||
@@ -52,7 +52,7 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }}
|
||||
|
||||
**Upgrading, Rolling Back and Uninstalling the Chart**
|
||||
|
||||
To upgrade, rollback or delete this App from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/Quick-Start%20Guides/04-Upgrade-rollback-delete-an-App/).
|
||||
To upgrade, rollback or delete this Chart from TrueNAS SCALE check our [Quick-Start Guide](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/Upgrade-rollback-delete-an-App).
|
||||
|
||||
### Helm
|
||||
|
||||
@@ -75,7 +75,7 @@ Read through the [values.yaml](./values.yaml) file. It has several commented out
|
||||
Other values may be used from the [values.yaml](https://github.com/truecharts/library-charts/tree/main/charts/stable/common/values.yaml) from the [common library](https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common).
|
||||
{{- end -}}
|
||||
{{- define "custom.configuration.example.set" -}}
|
||||
#### Configure using the Commandline
|
||||
#### Configure using the command line
|
||||
|
||||
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`.
|
||||
|
||||
@@ -95,9 +95,9 @@ helm install {{ template "chart.name" . }} {{ template "custom.helm.path" . }} -
|
||||
```
|
||||
{{- end -}}
|
||||
{{- define "custom.linking" -}}
|
||||
#### Connecting to other apps
|
||||
#### Connecting to other charts
|
||||
|
||||
If you need to connect this App to other Apps on TrueNAS SCALE, please refer to our [Linking Apps Internally](https://truecharts.org/docs/manual/Quick-Start%20Guides/06-linking-apps/) quick-start guide.
|
||||
If you need to connect this Chart to other Charts on TrueNAS SCALE, please refer to our [Linking Charts Internally](https://truecharts.org/docs/manual/SCALE%20Apps/Quick-Start%20Guides/linking-apps) quick-start guide.
|
||||
{{- end -}}
|
||||
{{- define "custom.support" -}}
|
||||
## Support
|
||||
|
||||
@@ -21,14 +21,14 @@
|
||||
attrs:
|
||||
- variable: cpu
|
||||
label: CPU
|
||||
description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/manual/indepth/validation/"
|
||||
description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/docs/manual/SCALE%20Apps/indepth/validation"
|
||||
schema:
|
||||
type: string
|
||||
default: 4000m
|
||||
valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$'
|
||||
- variable: memory
|
||||
label: RAM
|
||||
description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/manual/indepth/validation/"
|
||||
description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/docs/manual/SCALE%20Apps/indepth/validation"
|
||||
schema:
|
||||
type: string
|
||||
default: 8Gi
|
||||
@@ -41,14 +41,14 @@
|
||||
attrs:
|
||||
- variable: cpu
|
||||
label: CPU
|
||||
description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/manual/indepth/validation/"
|
||||
description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/docs/manual/SCALE%20Apps/indepth/validation"
|
||||
schema:
|
||||
type: string
|
||||
default: 10m
|
||||
valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$'
|
||||
- variable: memory
|
||||
label: "RAM"
|
||||
description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/manual/indepth/validation/"
|
||||
description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/docs/manual/SCALE%20Apps/indepth/validation"
|
||||
schema:
|
||||
type: string
|
||||
default: 50Mi
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
default: 568
|
||||
- variable: UMASK
|
||||
label: UMASK
|
||||
description: When supported by the container, this sets the UMASK for tha App. Not supported by all Apps
|
||||
description: When supported by the container, this sets the UMASK for the App. Not supported by all Apps
|
||||
schema:
|
||||
type: string
|
||||
default: "002"
|
||||
|
||||
+21
-21
@@ -387,7 +387,7 @@ gen_dh_cat() {
|
||||
}
|
||||
export -f gen_dh_cat
|
||||
|
||||
# Designed to ensure the appversion in Chart.yaml is in sync with the primary App tag if found
|
||||
# Designed to ensure the appversion in Chart.yaml is in sync with the primary Chart tag if found
|
||||
# Also makes sure that home link is pointing to the correct url
|
||||
sync_tag() {
|
||||
local chart="$1"
|
||||
@@ -529,19 +529,19 @@ copy_docs() {
|
||||
local chartversion="$4"
|
||||
echo "Copying docs for: ${chart}"
|
||||
if [ "${chartname}" == "common" ]; then
|
||||
mkdir -p docs/apps/common || :
|
||||
yes | cp -rf charts/library/common/README.md docs/apps/common/index.md 2>/dev/null || :
|
||||
yes | cp -rf charts/library/common/helm-values.md docs/apps/common/helm-values.md 2>/dev/null || :
|
||||
mkdir -p docs/charts/common || :
|
||||
yes | cp -rf charts/library/common/README.md docs/charts/common/index.md 2>/dev/null || :
|
||||
yes | cp -rf charts/library/common/helm-values.md docs/charts/common/helm-values.md 2>/dev/null || :
|
||||
else
|
||||
mkdir -p docs/apps/${train}/${chartname} || echo "app path already exists, continuing..."
|
||||
yes | cp -rf ${chart}/README.md docs/apps/${train}/${chartname}/index.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/CHANGELOG.md docs/apps/${train}/${chartname}/CHANGELOG.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/security.md docs/apps/${train}/${chartname}/security.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/CONFIG.md docs/apps/${train}/${chartname}/CONFIG.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/helm-values.md docs/apps/${train}/${chartname}/helm-values.md 2>/dev/null || :
|
||||
rm docs/apps/${train}/${chartname}/LICENSE.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/LICENSE docs/apps/${train}/${chartname}/LICENSE.md 2>/dev/null || :
|
||||
sed -i '1s/^/# License<br>\n\n/' docs/apps/${train}/${chartname}/LICENSE.md 2>/dev/null || :
|
||||
mkdir -p docs/charts/${train}/${chartname} || echo "chart path already exists, continuing..."
|
||||
yes | cp -rf ${chart}/README.md docs/charts/${train}/${chartname}/index.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/CHANGELOG.md docs/charts/${train}/${chartname}/CHANGELOG.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/security.md docs/charts/${train}/${chartname}/security.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/CONFIG.md docs/charts/${train}/${chartname}/CONFIG.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/helm-values.md docs/charts/${train}/${chartname}/helm-values.md 2>/dev/null || :
|
||||
rm docs/charts/${train}/${chartname}/LICENSE.md 2>/dev/null || :
|
||||
yes | cp -rf ${chart}/LICENSE docs/charts/${train}/${chartname}/LICENSE.md 2>/dev/null || :
|
||||
sed -i '1s/^/# License<br>\n\n/' docs/charts/${train}/${chartname}/LICENSE.md 2>/dev/null || :
|
||||
fi
|
||||
}
|
||||
export -f copy_docs
|
||||
@@ -564,7 +564,7 @@ clean_apps() {
|
||||
local chartname="$2"
|
||||
local train="$3"
|
||||
local chartversion="$4"
|
||||
echo "Cleaning SCALE catalog for App: ${chartname}"
|
||||
echo "Cleaning SCALE catalog for Chart: ${chartname}"
|
||||
rm -Rf catalog/${train}/${chartname}/${chartversion} 2>/dev/null || :
|
||||
rm -Rf catalog/${train}/${chartname}/item.yaml 2>/dev/null || :
|
||||
}
|
||||
@@ -576,7 +576,7 @@ patch_apps() {
|
||||
local train="$3"
|
||||
local chartversion="$4"
|
||||
local target="catalog/${train}/${chartname}/${chartversion}"
|
||||
echo "Applying SCALE patches for App: ${chartname}"
|
||||
echo "Applying SCALE patches for Chart: ${chartname}"
|
||||
sed -i '100,$ d' ${target}/CHANGELOG.md || :
|
||||
mv ${target}/app-changelog.md ${target}/CHANGELOG.md 2>/dev/null || :
|
||||
# Temporary fix to prevent the UI from bugging out on 21.08
|
||||
@@ -594,7 +594,7 @@ patch_apps() {
|
||||
# Generate SCALE App description file
|
||||
cat ${target}/Chart.yaml | yq .description -r >> ${target}/app-readme.md
|
||||
echo "" >> ${target}/app-readme.md
|
||||
echo "This App is supplied by TrueCharts, for more information please visit https://truecharts.org" >> ${target}/app-readme.md
|
||||
echo "This Chart is supplied by TrueCharts, for more information please visit https://truecharts.org" >> ${target}/app-readme.md
|
||||
}
|
||||
export -f patch_apps
|
||||
|
||||
@@ -603,7 +603,7 @@ copy_apps() {
|
||||
local chartname="$2"
|
||||
local train="$3"
|
||||
local chartversion="$4"
|
||||
echo "Copying App to Catalog: ${2}"
|
||||
echo "Copying Chart to Catalog: ${2}"
|
||||
mkdir -p catalog/${train}/${chartname}/${chartversion}
|
||||
cp -Rf ${chart}/* catalog/${train}/${chartname}/${chartversion}/
|
||||
|
||||
@@ -624,7 +624,7 @@ upload_catalog() {
|
||||
git config user.name "TrueCharts-Bot"
|
||||
git config user.email "bot@truecharts.org"
|
||||
git add --all
|
||||
git commit -sm "Commit new App releases for TrueCharts" || exit 0
|
||||
git commit -sm "Commit new Chart releases for TrueCharts" || exit 0
|
||||
git push
|
||||
cd -
|
||||
rm -rf catalog
|
||||
@@ -637,7 +637,7 @@ upload_dhcatalog() {
|
||||
git config user.name "TrueCharts-Bot"
|
||||
git config user.email "bot@truecharts.org"
|
||||
git add --all
|
||||
git commit -sm "Commit new App releases for TrueCharts" || exit 0
|
||||
git commit -sm "Commit new Chart releases for TrueCharts" || exit 0
|
||||
git push
|
||||
cd -
|
||||
rm -rf dh_catalog
|
||||
@@ -732,8 +732,8 @@ parse_command_line() {
|
||||
fi
|
||||
|
||||
if [[ -z "$repo" ]]; then
|
||||
echo "No repo configured, defaulting to apps" >&2
|
||||
repo="apps"
|
||||
echo "No repo configured, defaulting to charts" >&2
|
||||
repo="charts"
|
||||
fi
|
||||
|
||||
if [[ -z "$charts_repo_url" ]]; then
|
||||
|
||||
Reference in New Issue
Block a user