cloudoperators / greenhouse-extensions

Extensions for Greenhouse, the cloud operations platform
Apache License 2.0
2 stars 3 forks source link

Improving the documentation of the observability package #356

Closed richardtief closed 2 weeks ago

richardtief commented 3 months ago

Context

For observability-related releases/plugins, there should be an accessible description that clearly describes the scope and value proposition of each release. For this purpose, business language should be used that emphasises less the technical specifications. All this in conjunction with a Quick Start Guide to use it standalone and/or in conjunction with Greenhouse.

Objectives

Why is it necessary? What is it for? What does it do? How can I use it? What are the dependencies? What is it not? How can it be expanded? Where can I contribute?

richardtief commented 2 weeks ago

Done. Foundation set to iterate over.