From e05f42919749dc0d66cd57b471c1f21150ea826f Mon Sep 17 00:00:00 2001 From: TrueCharts-Bot Date: Sun, 11 Apr 2021 13:19:22 +0000 Subject: [PATCH] Commit docs updates Signed-off-by: TrueCharts-Bot --- docs/index.md | 145 ++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 124 insertions(+), 21 deletions(-) diff --git a/docs/index.md b/docs/index.md index 0c706cae2fd..46cdca903b5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,46 +1,99 @@ --- hide: - - navigation # Hide navigation - - toc # Hide table of contents + - navigation + - toc --- +# TrueCharts
+# About TrueCharts
+**Community App Catalog for TrueNAS SCALE** -TrueCharts is the community that maintains TrueCharts. +[![docs](https://img.shields.io/badge/docs-rtfm-yellow?logo=gitbook&logoColor=white&style=for-the-badge)](https://truecharts.org/) +[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=for-the-badge)](https://discord.gg/tVsPTHWTtr) +[![GitHub last commit](https://img.shields.io/github/last-commit/truecharts/apps?color=brightgreen&logoColor=white&style=for-the-badge)](https://github.com/truecharts/apps/commits) -# TrueCharts +--- TrueCharts is a catalog of highly optimised TrueNAS SCALE Apps. Made for the community, By the community! -If you are interested in using TrueCharts, please visit us on github [github](https://github.com/truecharts/apps/) +Our primary goals are: +- Micro-Service Centered +- Native Kubernetes +- Stability +- Consistancy + +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. + +
+ +## Getting started using TrueCharts +[![docs](https://img.shields.io/badge/docs-rtfm-yellow?logo=gitbook&logoColor=white&style=for-the-badge)](https://truecharts.org/) --- -### Supported operating systems +Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list. -While we always aim for our charts to be fully stock-kubernetes compatbile, we can only guarantee compatibility with TrueNAS SCALE Apps. As we are primarily a TrueNAS SCALE App catalog. +For more information: +https://truecharts.org/manual/adding-truecharts/ -Though we try to make our Apps as version independent as possible we have a limited capacity to support older versions of TrueNAS SCALE. Our focus is the current version of TrueNAS. +### Support -That being said: We do look forward to contributions to improve support for stock-kubernetes for our Charts! +Please check our [FAQ](https://truecharts.org/about/FAQ/), [manual](https://truecharts.org/manual) and [Issue tracker](https://github.com/truecharts/apps/issues) There is a significant chance your issue has been reported before! -### Development +Still something not working as expected? [Contact us!](https://truecharts.org/about/contact/) and we'll figure it out together! -Our development proces is fully distributed and agile, every chart-maintainer is free to set their own roadmap and development speed and does not have to comply to a centralised roadmap. +### Roadmap -This ensures freedom and flexibility for everyone involved and makes sure you, the end user, always has the latest and greated of every App installed. - -#### Roadmap - -However for big "breaking" changes we do have a roadmap during the ALPHA and BETA stages of TrueNAS SCALE. +For big "breaking" changes we do have a roadmap during the ALPHA and BETA stages of TrueNAS SCALE. Assuming the release dates of TrueNAS SCALE will keep following the previous 2 months between releases, we will have the following big milestones: ---- -- TrueCharts DB Edition - TrueNAS SCALE 21.06 + +**TrueCharts DB Edition - TrueNAS SCALE 21.06** _This release will focus on adding a solid framework of using (and adding) databases to Apps within TrueCharts. This will lead to significantly more App possibilities and performance increases for existing Apps._ + +
+ + +## Development +[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge)](https://github.com/pre-commit/pre-commit) +[![renovate](https://img.shields.io/badge/renovate-enabled-brightgreen?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjUgNSAzNzAgMzcwIj48Y2lyY2xlIGN4PSIxODkiIGN5PSIxOTAiIHI9IjE4NCIgZmlsbD0iI2ZlMiIvPjxwYXRoIGZpbGw9IiM4YmIiIGQ9Ik0yNTEgMjU2bC0zOC0zOGExNyAxNyAwIDAxMC0yNGw1Ni01NmMyLTIgMi02IDAtN2wtMjAtMjFhNSA1IDAgMDAtNyAwbC0xMyAxMi05LTggMTMtMTNhMTcgMTcgMCAwMTI0IDBsMjEgMjFjNyA3IDcgMTcgMCAyNGwtNTYgNTdhNSA1IDAgMDAwIDdsMzggMzh6Ii8+PHBhdGggZmlsbD0iI2Q1MSIgZD0iTTMwMCAyODhsLTggOGMtNCA0LTExIDQtMTYgMGwtNDYtNDZjLTUtNS01LTEyIDAtMTZsOC04YzQtNCAxMS00IDE1IDBsNDcgNDdjNCA0IDQgMTEgMCAxNXoiLz48cGF0aCBmaWxsPSIjYjMwIiBkPSJNMjg1IDI1OGw3IDdjNCA0IDQgMTEgMCAxNWwtOCA4Yy00IDQtMTEgNC0xNiAwbC02LTdjNCA1IDExIDUgMTUgMGw4LTdjNC01IDQtMTIgMC0xNnoiLz48cGF0aCBmaWxsPSIjYTMwIiBkPSJNMjkxIDI2NGw4IDhjNCA0IDQgMTEgMCAxNmwtOCA3Yy00IDUtMTEgNS0xNSAwbC05LThjNSA1IDEyIDUgMTYgMGw4LThjNC00IDQtMTEgMC0xNXoiLz48cGF0aCBmaWxsPSIjZTYyIiBkPSJNMjYwIDIzM2wtNC00Yy02LTYtMTctNi0yMyAwLTcgNy03IDE3IDAgMjRsNCA0Yy00LTUtNC0xMSAwLTE2bDgtOGM0LTQgMTEtNCAxNSAweiIvPjxwYXRoIGZpbGw9IiNiNDAiIGQ9Ik0yODQgMzA0Yy00IDAtOC0xLTExLTRsLTQ3LTQ3Yy02LTYtNi0xNiAwLTIybDgtOGM2LTYgMTYtNiAyMiAwbDQ3IDQ2YzYgNyA2IDE3IDAgMjNsLTggOGMtMyAzLTcgNC0xMSA0em0tMzktNzZjLTEgMC0zIDAtNCAybC04IDdjLTIgMy0yIDcgMCA5bDQ3IDQ3YTYgNiAwIDAwOSAwbDctOGMzLTIgMy02IDAtOWwtNDYtNDZjLTItMi0zLTItNS0yeiIvPjxwYXRoIGZpbGw9IiMxY2MiIGQ9Ik0xNTIgMTEzbDE4LTE4IDE4IDE4LTE4IDE4em0xLTM1bDE4LTE4IDE4IDE4LTE4IDE4em0tOTAgODlsMTgtMTggMTggMTgtMTggMTh6bTM1LTM2bDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMxZGQiIGQ9Ik0xMzQgMTMxbDE4LTE4IDE4IDE4LTE4IDE4em0tMzUgMzZsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzJiYiIgZD0iTTExNiAxNDlsMTgtMTggMTggMTgtMTggMTh6bTU0LTU0bDE4LTE4IDE4IDE4LTE4IDE4em0tODkgOTBsMTgtMTggMTggMTgtMTggMTh6bTEzOS04NWwyMyAyM2M0IDQgNCAxMSAwIDE2TDE0MiAyNDBjLTQgNC0xMSA0LTE1IDBsLTI0LTI0Yy00LTQtNC0xMSAwLTE1bDEwMS0xMDFjNS01IDEyLTUgMTYgMHoiLz48cGF0aCBmaWxsPSIjM2VlIiBkPSJNMTM0IDk1bDE4LTE4IDE4IDE4LTE4IDE4em0tNTQgMThsMTgtMTcgMTggMTctMTggMTh6bTU1LTUzbDE4LTE4IDE4IDE4LTE4IDE4em05MyA0OGwtOC04Yy00LTUtMTEtNS0xNiAwTDEwMyAyMDFjLTQgNC00IDExIDAgMTVsOCA4Yy00LTQtNC0xMSAwLTE1bDEwMS0xMDFjNS00IDEyLTQgMTYgMHoiLz48cGF0aCBmaWxsPSIjOWVlIiBkPSJNMjcgMTMxbDE4LTE4IDE4IDE4LTE4IDE4em01NC01M2wxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjMGFhIiBkPSJNMjMwIDExMGwxMyAxM2M0IDQgNCAxMSAwIDE2TDE0MiAyNDBjLTQgNC0xMSA0LTE1IDBsLTEzLTEzYzQgNCAxMSA0IDE1IDBsMTAxLTEwMWM1LTUgNS0xMSAwLTE2eiIvPjxwYXRoIGZpbGw9IiMxYWIiIGQ9Ik0xMzQgMjQ4Yy00IDAtOC0yLTExLTVsLTIzLTIzYTE2IDE2IDAgMDEwLTIzTDIwMSA5NmExNiAxNiAwIDAxMjIgMGwyNCAyNGM2IDYgNiAxNiAwIDIyTDE0NiAyNDNjLTMgMy03IDUtMTIgNXptNzgtMTQ3bC00IDItMTAxIDEwMWE2IDYgMCAwMDAgOWwyMyAyM2E2IDYgMCAwMDkgMGwxMDEtMTAxYTYgNiAwIDAwMC05bC0yNC0yMy00LTJ6Ii8+PC9zdmc+)](https://github.com/renovatebot/renovate) +[![GitHub last commit](https://img.shields.io/github/last-commit/truecharts/apps?color=brightgreen&logoColor=white&style=for-the-badge)](https://github.com/truecharts/apps/commits) --- -### Featured Projects +Our development proces 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 greated of every App installed. + + +### Getting into creating Apps + +Creating charts takes some getting used to, as it's based on Helm charts. We highly suggest prior knowhow 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/development) + +### Automation and you + +We provide a lot of tools to make it easier to develop charts, templates, automated testing, automated fixes, automated docs. Even automated update is included. We also actively try to collaborate with other k8s community projects on tooling, for the betterment of all! + +Those tools do, however, take time to develop and are certainly not bug free. If you find mistakes in our tooling, please feel free to repost issues or submit any fixes you feel appropiate! + +
+ + +## Contact and Support +[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=for-the-badge)](https://discord.gg/tVsPTHWTtr) +--- + +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) + +
+ + +## Featured Projects 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: @@ -48,7 +101,57 @@ A lot of our work is based on the great effort of others. We would love to exten | :---------------: | :---------------: | :---------------: | | TrueNAS SCALE | K8S-At-Home | Traefik | +
-### Support or Contact -Having trouble with TrueCharts? Check out the documentation available on this website or our [github](https://github.com/truecharts/apps/) and we’ll help you sort it out. +## Contributors ✨ + + +[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=for-the-badge)](#contributors) + +Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + +--- + + + + + + + + + + + + + + + + + + +

Kjeld Schouten-Lebbing
💻 🚇 📖
Justin Clift
📖
whiskerz007
💻
Stavros Kois
💻 📖
allen-4
💻
Troy Prelog
💻 📖
Dan Sheridan
💻

Sebastien Dupont
📖
Vegetto
👀
+ + + + + + +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! + + + +## Licence +[![License](https://img.shields.io/badge/License-BSD%203--Clause-orange.svg?style=for-the-badge)](https://github.com/truecharts/apps/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 rootfolder. + +Some Apps may also contain parts in other licenses, such as libraries or templates, these files can be recognised by their individual headers. + +[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ftruecharts%2Ftruecharts.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Ftruecharts%2Ftruecharts?ref=badge_large) + +`SPDX-License-Identifier: BSD-3-Clause` + +--- +![built-with-resentment](http://forthebadge.com/images/badges/built-with-resentment.svg) ![contains-technical-debt](http://forthebadge.com/images/badges/contains-technical-debt.svg)