From 18096936587dd723874c7012be93aacfed3f6c24 Mon Sep 17 00:00:00 2001 From: kjeld Schouten-Lebbing Date: Thu, 11 Mar 2021 12:13:39 +0100 Subject: [PATCH] try integrating the homepage --- .github/docs/index.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/.github/docs/index.md b/.github/docs/index.md index 307770bb0fa..f0c126de8a0 100644 --- a/.github/docs/index.md +++ b/.github/docs/index.md @@ -1,3 +1,38 @@ -# Home +## Home -This is a placeholder homepage, please view at our other pages for more information about TrueCharts +TrueCharts is the community that maintains TrueCharts. + +### TrueCharts +TrueCharts is a one-line iocage jail management and deployment tool for FreeNAS and FreeBSD. +If you are interested in using TrueCharts, please visit us on github [github](https://github.com/truecharts/charts/) + +### Supported operating systems + +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. + +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. + +That being said: We do look forward to contributions to improve support for stock-kubernetes for our Charts! + +### Development + +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. + +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. +Assuming the release dates of TrueNAS SCALE will keep following the previous 2 months between releases, we will have the following big milestones: + +**TrueCharts 2 - TrueNAS SCALE 21.04** + +Will mostly be a "polish-and-fix release" and will feature heavy rewrites of core components of TrueCharts, as well as rework to have a nicer fit within the TrueNAS SCALE ecosystem. + +**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. + +### Support or Contact + +Having trouble with TrueCharts? Check out our [Wiki](https://wiki.truecharts.org) or [github](https://github.com/truecharts/charts/) and we’ll help you sort it out.