diff --git a/.github/README.md b/.github/README.md index a7f9ae1b092..19d5d21edf1 100644 --- a/.github/README.md +++ b/.github/README.md @@ -9,9 +9,13 @@ TrueCharts is a catalog of highly optimised TrueNAS SCALE Apps. Made for the community, By the community! Our primary goals are: + - Micro-Service Centered + - Native Kubernetes + - Stability + - 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. @@ -103,9 +107,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) + - Open a discussion on [GitHub Discussions](https://github.com/truecharts/apps/discussions) + - Send us an [email](mailto://info@truecharts.org) + - Or [join our Discord server](https://truecharts.org/discord)
@@ -119,9 +127,9 @@ To contact the TrueCharts project: A lot of our work is based on the great effort of others. We would love to extend special thanks to these projects we owe a lot to: -| | | | -| :---------------: | :---------------: | :---------------: | -| TrueNAS SCALE | K8S-At-Home | Traefik | +| | | | | +| :---------------: | :---------------: | :---------------: | :---------------: | +| TrueNAS SCALE | K8S-At-Home | Traefik | Authelia |
diff --git a/docs/about/index.md b/docs/about/index.md index 1b2fc6d1365..8d12061e656 100644 --- a/docs/about/index.md +++ b/docs/about/index.md @@ -1,23 +1,16 @@ # FAQ -- Q: I tried to run TrueCharts on TrueNAS SCALE 20.12 or 21.02 and it doesn't work.
-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
-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 +A: Please file an issue about it, after checking the wiki, discord and Github to make sure it hasn't been discussed already - Q: Isn't there more documentation for app x
-A: If it's not on our [website](https://truecharts.org), we do not. There might be other sources for documentation however! +A: If it's not on our [website](https://truecharts.org) or the discord, we (sadly) do not. There might be other sources for documentation however! - Q: Function x doesn't seem to be working, should it be working?
-A: Maybe, please file an issue - -- Q: I'm missing a lot of configuration opions in the install GUI.
-A: We try to aim for a balance in the amount of options vs the simplicity of installation. Suggestions are always welcome +A: Maybe, please file an issue on github or ask on the Discord - Q: Is my data guaranteed to be secure?
-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. +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. - Q: sabnzbd isn't starting.
A: SabNZBD has a weird security implementation that requires you to add the hostname or IP adress to their config file. In the future we might automate this proces, but currently we do not. diff --git a/docs/about/maintainers-wanted.md b/docs/about/maintainers-wanted.md deleted file mode 100644 index 41aeceaca2c..00000000000 --- a/docs/about/maintainers-wanted.md +++ /dev/null @@ -1,30 +0,0 @@ -# Maintainers Wanted - -While a lot of containers are based on the common chart, we at TrueCharts still prefer to have at least one dedicated actual maintainer for every chart. Preferably someone who actually uses said App. - -#### Are you the one we are looking for? -If you have experience working on SCALE Apps, TrueCharts and/or Helm Charts and are interested in maintaing one of the Apps below please contact us by [email](mailto://info@truecharts.org) - -_Please note: We always prefer maintainers that have worked on one of our Apps before and, if thats not the case, people with verifyable experience with SCALE Apps and/or Helm Charts_ - -### Current Apps without maintainers - -- bazarr -- Calibre-web -- freshrss -- gaps -- grocy -- heimdall -- lazylibrarian -- lychee -- navidrome -- node-red -- nzb-get -- nzbhydra -- organizr -- qbittorrent -- readarr -- sabnzbd -- truecommand -- tvheadend -- unifi diff --git a/docs/about/sponsor.md b/docs/about/sponsor.md index 4f38f383497..69e37f0d2f4 100644 --- a/docs/about/sponsor.md +++ b/docs/about/sponsor.md @@ -1,4 +1,4 @@ -# Sponsors and Donators +# Sponsors Us ### Sponsorship diff --git a/docs/requirements.txt b/docs/requirements.txt index 95af4e40e66..56615aa4203 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1,2 @@ mkdocs-video +mkdocs-awesome-pages-plugin diff --git a/mkdocs.yml b/mkdocs.yml index 1846cdeb6cf..603ceb2d4ab 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,6 +40,7 @@ extra_css: # Plugins plugins: - search + - awesome-pages - mkdocs-video - minify: minify_html: true