Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving the documentation of the observability package #356

Open
richardtief opened this issue Aug 28, 2024 · 0 comments
Open

Improving the documentation of the observability package #356

richardtief opened this issue Aug 28, 2024 · 0 comments
Assignees

Comments

@richardtief
Copy link
Member

richardtief commented Aug 28, 2024

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

1 participant