krkn-chaos / cerberus

Guardian of Kubernetes clusters. Tool to monitor clusters health and signal/alert on failures.
Apache License 2.0
92 stars 42 forks source link

Add doc index and improve installation with helm support #173

Open startxfr opened 2 years ago

startxfr commented 2 years ago

Adding example of tekton usage (consuming the signal as part of a tekton pipeline) Adding an index (inspired for kraken one) to the docs directory (not sure it's part of a website build like kraken) Complete the installation documentation with helm chart example

startxfr commented 2 years ago

Hy team, do you need any additionnal change to validate this PR. I don't know if it's add some value to this project. Feel free to tell me if it's not the case or if you need additionnal change to make it usable for the community.

startxfr commented 2 years ago

@paigerube14 @chaitanyaenr do you see anything to change or refactoring from my site. I now it's only documentation, but do you think it could help others ?

startxfr commented 2 years ago

@paigerube14 finish adding some more content according to your suggestions. If you need anything else, do not hesitate to tell me.

chaitanyaenr commented 2 years ago

@startxfr Great content, very useful! May be we can add a new section under docs called "Adopters" and have the content in there along with the use case in your environment as a separate document? Something along the lines of https://github.com/chaos-mesh/chaos-mesh/blob/master/ADOPTERS.md. Thoughts?

chaitanyaenr commented 2 years ago

Hi @startxfr, thoughts on restructuring on the content as described ^?

chaitanyaenr commented 2 years ago

Hi @startxfr, thoughts? Also the commit needs to be rebased.