diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6e724f0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to Heracles + +If you would like to help out with Heracles development then this document +outlines what you can expect. + +Heracles is licensed under the Apache 2.0 license. You are welcome to clone or +copy this source and make any modifications you like with no obligations other +than what is in the License. If you wish to contribute those changes back then +you should follow the below steps. + +1. Create or identify an existing Github Issue outlining what you wish to add to the project. + This will allow you to get feedback on whether your proposed changes fit with + the direction I want to take Heracles in. +2. Submit a PR to the project referencing the Issue from above for review. + At this time I have no defined SLA on responses to PRs or Issues since this + is effectively a hobby project for personal use. Don't let that discourage + you though. If you are patient I will eventually get back to you. +3. If all goes well with the above then your PR will get merged. + +## Notes on acceptable contributions + +* We are not interested in adding a database for configuration at this time. +* Alternative sources of metrics or log queries are of interest to us. + But note that if the system is not one I use regularly or have access to then + my capacity to maintain that integration will be limited. It's continued + existence in Heracles will be dependent on your support of it. If that support + is beyond you it may get removed in future versions. +* We wish to preserve the single binary deploy nature of Heracles. So changes that + violate that will be rejected. + +# Code of Conduct + +Mostly I just want you to be respectful and professional, but the arbiter of +that is me. I'm not interested in getting super legal about what is allowed and +what isn't at this time. If you act like a bully then you'll be persona non +grata. Otherwise have fun with the project. diff --git a/README.md b/README.md index c076593..5f04b5f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,15 @@ # Heracles -An alternative dashboard viewer and manager for prometheus style metrics + +An alternative dashboard viewer and manager for prometheus style metrics. + +* Stateless. There is no persistent storage for this dashboard. +* File based configuration. Just YAML to define your dashbaords. +* Single binary install + +Basically this is a small handmade simple to deploy dashboard viewer for prometheus metrics +and loki log queries. + +We aren't looking to make it a full on replacement for Grafana/New Relic/Honeycomb or any +of those things. But if you want an easy to deploy and use dashboard viewer for your homelab +then this might be make your life just a little bit simpler. +