Create wiki update CI
This adds a CI that automatically crafts a wiki-site from repository content
This commit is contained in:
kjeld Schouten-Lebbing
@@ -0,0 +1,71 @@
|
||||
# Code of Conduct
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
contributors and maintainers pledge to making participation in our project and
|
||||
our community a harassment-free experience for everyone, regardless of age, body
|
||||
size, disability, ethnicity, sex characteristics, gender, level of experience,
|
||||
education, socio-economic status, nationality, personal appearance, race,
|
||||
religion, or sexual identity and orientation.
|
||||
|
||||
## Our Standards
|
||||
|
||||
Examples of behavior that contributes to creating a positive environment
|
||||
include:
|
||||
|
||||
* Being respectful of differing viewpoints and experiences
|
||||
* Gracefully accepting constructive criticism
|
||||
* Focusing on what is best for the community
|
||||
|
||||
Examples of unacceptable behavior by participants include:
|
||||
|
||||
* The use of sexual imagery and unwelcome sexual advances
|
||||
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||
* Public or private harassment
|
||||
* Publishing others' private information, such as a physical or electronic
|
||||
address, without explicit permission
|
||||
|
||||
## Our Responsibilities
|
||||
|
||||
Project maintainers are responsible for clarifying the standards of acceptable
|
||||
behavior and are expected to take appropriate and fair corrective action in
|
||||
response to any instances of unacceptable behavior.
|
||||
|
||||
Project maintainers have the right and responsibility to remove, edit, or
|
||||
reject comments, commits, code, wiki edits, issues, and other contributions
|
||||
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||
permanently any contributor for other behaviors that they deem inappropriate,
|
||||
threatening, offensive, or harmful.
|
||||
|
||||
## Scope
|
||||
|
||||
This Code of Conduct applies both within project spaces and in public spaces
|
||||
when an individual is representing the project or its community. Examples of
|
||||
representing a project or community include using an official project e-mail
|
||||
address, posting via an official social media account, or acting as an appointed
|
||||
representative at an online or offline event. Representation of a project may be
|
||||
further defined and clarified by project maintainers.
|
||||
|
||||
## Enforcement
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported by contacting the project team at truecharts@schouten-lebbing.nl. All
|
||||
complaints will be reviewed and investigated and will result in a response that
|
||||
is deemed necessary and appropriate to the circumstances. The project team is
|
||||
obligated to maintain confidentiality with regard to the reporter of an incident.
|
||||
Further details of specific enforcement policies may be posted separately.
|
||||
|
||||
Project maintainers who do not follow or enforce the Code of Conduct in good
|
||||
faith may face temporary or permanent repercussions as determined by other
|
||||
members of the project's leadership.
|
||||
|
||||
## Attribution
|
||||
|
||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
||||
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
|
||||
|
||||
[homepage]: https://www.contributor-covenant.org
|
||||
|
||||
For answers to common questions about this code of conduct, see
|
||||
https://www.contributor-covenant.org/faq
|
||||
@@ -0,0 +1,77 @@
|
||||
# Contribution and Review Guidelines
|
||||
|
||||
This project welcomes any and all input, but we need to have a few quality guidelines. These guidelines will be examplained here, in this document.
|
||||
|
||||
### GIT Guidelines
|
||||
***
|
||||
#### New to GIT
|
||||
|
||||
If you have never used git before, you can look up our general reference on our wiki.
|
||||
|
||||
#### Git and You
|
||||
|
||||
GIT is a fantastic system, but while using it we have a few guidelines to keep it fantastic for everyone.
|
||||
|
||||
* Submit complete PR's.
|
||||
* Add [DNM] if you do not want your PR merged yet.
|
||||
* Always try and fill in the whole form, even for small PR's.
|
||||
* Don't close when a reviewer requests changes (just push the changes or ask for help).
|
||||
* Explain what you did in your PR.
|
||||
* Be thorough.
|
||||
* If you can add screenshots to clarify.
|
||||
* Always try to add "Fixes #000" (where 000 is the Issue your PR fixes)
|
||||
* found something you want to fix yourself? Please do make an issue too.
|
||||
|
||||
### Structure Guidelines
|
||||
***
|
||||
|
||||
#### Inclusion of files and folders
|
||||
|
||||
Although GIT is quite friendly in what it accepts in terms of files and folder changes in a commit, a reviewer's or bugfixer's time is not unlimited. For that reason, we have a few specific guidelines in regards to the inclusion of files and folders in your PR.
|
||||
|
||||
* Only include files you actually changed.
|
||||
* Try not to include multiple changes in one PR
|
||||
* Want to change the formatting of multiple files too? Make a separate PR.
|
||||
|
||||
|
||||
### Code Guidelines
|
||||
***
|
||||
#### Your code, your style, my review
|
||||
|
||||
Here at TrueCharts, we value people having their own style. But your code needs to be reviewable and editable by others too. For that reason, we have a few basic coding guidelines
|
||||
|
||||
* **Always** explain regex in a comment within your code.
|
||||
* Write simple code and don't try to impress.
|
||||
* We will run (Basic) automated reformating of code once in a while.
|
||||
* Document your changes in your code and if need be, on the wiki.
|
||||
* All PR's should be able to pass our automated tests.
|
||||
|
||||
#### Apps requirements
|
||||
|
||||
- Apps should always save user-specific data in a persistant location. That can be connected by both IXVolume or Hostpath
|
||||
- Apps should not require the user to edit any config file themselves. All config changes should be either automated or using the UI
|
||||
- Apps should not use default passwords, the user should always be forced(!) to put credentials in manually
|
||||
|
||||
|
||||
### Review Guidelines
|
||||
***
|
||||
Even us review gods need some guidelines once in a while.
|
||||
|
||||
* Let people learn from their mistakes
|
||||
* Review instead of merging without comments
|
||||
* Abide by these guidelines in your review
|
||||
* Tests exist for a reason. Don't merge with test-failures
|
||||
|
||||
|
||||
|
||||
### Todo vs Feature vs bug:
|
||||
***
|
||||
Please take note of the difference between a TODO and Feature
|
||||
|
||||
* Bug: An unexpected behavior of the script or a crash. Including, but not limited to, errors and warnings.
|
||||
* Todo: When you come across something that needs tweaking/adding during development, is not an unexpected behavior
|
||||
* Feature: When you, out of personal preference, want something added or changed.
|
||||
|
||||
### That's it!
|
||||
***
|
||||
Someone will come along and review the changes. If everything looks good then they will merge it with the main repo. If you need any help don't be afraid to ask in the discord channel: [https://discord.gg/tFcTpBp](https://discord.gg/tFcTpBp)
|
||||
@@ -0,0 +1,65 @@
|
||||
|
||||
# TrueCharts:<br>Community App Catalog for TrueNAS SCALE
|
||||
[](https://github.com/truecharts/truecharts/commits) [](https://github.com/truecharts/truecharts/blob/master/docs/LICENSE.BSD3)[](https://app.fossa.com/projects/git%2Bgithub.com%2Ftruecharts%2Ftruecharts?ref=badge_shield)
|
||||
|
||||
Truecharts is an innitiative to provide high quality Apps to use with the TrueNAS SCALE App Ecosystem.
|
||||
Our primary goals are:
|
||||
- Freedom
|
||||
- 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
|
||||
Installing TrueCharts within TrueNAS SCALE, still requires the CLI. However it's not hard:
|
||||
- Go to you shell of choice (either SSH or the TrueNAS webui shell)
|
||||
- enter `cli`
|
||||
- enter `app catalog create repository="https://github.com/truecharts/truecharts" label="TrueCharts"`
|
||||
|
||||
## FAQ
|
||||
- Q: I tried to run TrueCharts on TrueNAS SCALE 20.12 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.02+ only
|
||||
|
||||
- Q: Please include app X<br>
|
||||
A: Please file an issue about it, after checking the wiki to make sure it hasn't been discussed already:
|
||||
https://github.com/truecharts/truecharts/wiki/k8s-at-home-to-SCALE-App-migration-list
|
||||
|
||||
- Q: Isn't there more documentation for app x<br>
|
||||
A: No, currently during TrueNAS SCALE ALPHA/BETA we focus on the technical aspects.
|
||||
|
||||
- Q: Function x doesn't seem to be working, should it be working?<br>
|
||||
A: Maybe, please file an issue
|
||||
|
||||
- Q: I'm missing a lot of configuration opions in the install GUI.<br>
|
||||
A: We try to aim for a balance in the amount of options vs the simplicity of installation. Suggestions are always welcome
|
||||
|
||||
- Q: The portal button isn't working.<br>
|
||||
A: Portal buttons are current't not implemented very well and are considered "not supported" for the time being
|
||||
|
||||
- Q: I selected letsencrypt but still get a traefik certificate.<br>
|
||||
A: Cert Manager might take up to 10 minutes to fetch the right certificate and requires free access to 1.1.1.1:53. Until the right certificate is fetched, it will use the Traefik Default cert.
|
||||
|
||||
- Q: Is my data guaranteed to be secure?<br>
|
||||
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.
|
||||
|
||||
- Q: sabnzbd isn't starting.<br>
|
||||
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.
|
||||
|
||||
- Q: An app is asking for a password.<br>
|
||||
A: We almost allways use the defaults from the upstream project, if we are forced to use a password and not add the option to change it in the install GUI.
|
||||
|
||||
## 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.
|
||||
|
||||
The specifications of TrueNAS SCALE apps, is layed out in the [wiki](https://github.com/truecharts/truecharts/wiki/TrueNAS-SCALE-Chart-Structure)
|
||||
|
||||
|
||||
## Licence
|
||||
|
||||
`SPDX-License-Identifier: BSD-3-Clause`
|
||||
|
||||
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.
|
||||
|
||||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Ftruecharts%2Ftruecharts?ref=badge_large)
|
||||
Reference in New Issue
Block a user