chore(docs): add markdownlint and cpell config files (and apply some linting) (#3140)
* chore(docs): apply some linting * chore(docs): add markdownlint and cpell config files * remove duplicate key * add extension recommendation * update cspell
This commit is contained in:
Stavros Kois
+25
-23
@@ -1,4 +1,5 @@
|
||||
# TrueCharts<br>
|
||||
# TrueCharts
|
||||
|
||||
**Community App Catalog for TrueNAS SCALE**
|
||||
|
||||
[](https://truecharts.org/)
|
||||
@@ -6,6 +7,7 @@
|
||||
[](https://github.com/truecharts/apps/commits)
|
||||
|
||||
---
|
||||
|
||||
TrueCharts is a catalog of highly optimised TrueNAS SCALE Apps. Made for the community, By the community!
|
||||
|
||||
Our primary goals are:
|
||||
@@ -20,12 +22,14 @@ Our primary goals are:
|
||||
|
||||
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.
|
||||
|
||||
<br>
|
||||
<br />
|
||||
|
||||
## Getting started using TrueCharts
|
||||
|
||||
[](https://truecharts.org/)
|
||||
|
||||
---
|
||||
|
||||
Installing TrueCharts within TrueNAS SCALE, is possible using the TrueNAS SCALE Catalog list.
|
||||
|
||||
Check TrueCharts [Quick-Start Guides](https://truecharts.org/manual/Quick-Start%20Guides/01-Adding-TrueCharts/) for more infotmation.
|
||||
@@ -40,29 +44,28 @@ Still something not working as expected? [Contact us!](https://truecharts.org/ab
|
||||
|
||||
For big changes we do have a roadmap, every spot on the roadmap is synced to a TrueNAS SCALE Release and should be read as "Should be added at or before this release"
|
||||
|
||||
|
||||
<br>
|
||||
<br />
|
||||
|
||||
**Restructure of the Project - TrueNAS SCALE "Bluefin" 22.xx ALPHA 1**
|
||||
|
||||
_The current project is hitting internal performance issues, for this reason we need to rework the structure and split some parts of the project into seperate repositories._
|
||||
|
||||
<br>
|
||||
<br />
|
||||
|
||||
**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_
|
||||
|
||||
<br>
|
||||
<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_
|
||||
|
||||
|
||||
<br>
|
||||
<br />
|
||||
|
||||
## Development
|
||||
|
||||
[](https://github.com/pre-commit/pre-commit)
|
||||
[](https://github.com/renovatebot/renovate)
|
||||
[](https://github.com/truecharts/apps/commits)
|
||||
@@ -72,7 +75,6 @@ _With most parts of our project somewhat cleaned up, we need to work on increasi
|
||||
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.
|
||||
|
||||
|
||||
### Getting into creating Apps
|
||||
|
||||
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.
|
||||
@@ -85,10 +87,10 @@ We provide a lot of tools to make it easier to develop charts, templates, automa
|
||||
|
||||
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 appropriate!
|
||||
|
||||
<br>
|
||||
|
||||
<br />
|
||||
|
||||
## Contact and Support
|
||||
|
||||
[](https://discord.gg/tVsPTHWTtr)
|
||||
|
||||
---
|
||||
@@ -103,29 +105,30 @@ To contact the TrueCharts project:
|
||||
|
||||
- Or [join our Discord server](https://truecharts.org/discord)
|
||||
|
||||
<br>
|
||||
<br />
|
||||
|
||||
<!-- INSERT-DISCORD-WIDGET -->
|
||||
|
||||
<br>
|
||||
|
||||
<br />
|
||||
|
||||
## 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:
|
||||
|
||||
| <a href="https://www.truenas.com/truenas-scale/"> <img src="https://user-images.githubusercontent.com/7613738/113836934-a1764e00-978d-11eb-8e19-a087c5c1f99b.png" width="150" height="150" /> </a> | <a href="https://k8s-at-home.com/"> <img src="https://user-images.githubusercontent.com/7613738/113837194-e26e6280-978d-11eb-9632-2e1529946302.png" width="150" height="150" /> </a> | <a href="https://traefik.io/traefik/"> <img src="https://user-images.githubusercontent.com/7613738/113837353-0b8ef300-978e-11eb-873e-14769acfe1f1.png" width="150" height="150" /> </a> | <a href="https://www.authelia.com/"> <img src="https://avatars.githubusercontent.com/u/59122411?s=200&v=4" width="150" height="150" /> </a> |
|
||||
| :---------------: | :---------------: | :---------------: | :---------------: |
|
||||
| <a href="https://www.truenas.com/truenas-scale/">TrueNAS SCALE</a> | <a href="https://k8s-at-home.com/">K8S-At-Home</a> | <a href="https://traefik.io/traefik/">Traefik</a> | <a href="https://www.authelia.com/">Authelia</a> |
|
||||
|
||||
<br>
|
||||
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| <a href="https://www.truenas.com/truenas-scale/">TrueNAS SCALE</a> | <a href="https://k8s-at-home.com/">K8S-At-Home</a> | <a href="https://traefik.io/traefik/">Traefik</a> | <a href="https://www.authelia.com/">Authelia</a> |
|
||||
|
||||
<br />
|
||||
|
||||
## Contributors ✨
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
|
||||
[](#contributors)
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
|
||||
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
||||
|
||||
---
|
||||
@@ -281,19 +284,18 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
|
||||
|
||||
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|
||||
|
||||
|
||||
|
||||
## Licence
|
||||
|
||||
[](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 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 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.
|
||||
|
||||
Some Apps 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`
|
||||
|
||||
---
|
||||
 
|
||||
|
||||
 
|
||||
|
||||
Reference in New Issue
Block a user