Observability knowledge entrypoint/index page.

cncf / tag-observability

Technical Advisory Group for Observability 🔭⚙️

https://cncf.io/projects

Apache License 2.0

646 stars 84 forks source link

Observability knowledge entrypoint/index page. #19

Open bwplotka opened 4 years ago

bwplotka commented 4 years ago

As per today's SIG CNCF meeting, it would be awesome if we could give an entry point to the observability projects we represent.

Overall the goal would be to improve the user world, especially new joiners. See https://github.com/cncf/sig-observability/issues/18 for example questions new users have when entering the observability world, this time from metrics angle.

Acceptance Criteria:

Friendly starting point, how to start learning about observability for cloud-native apps
Instead of repeating, link to project's docs, (some nice search as well?)
Establish a feedback channel in case of missing docs/answers with observability projects.

ArthurSens commented 4 years ago

Should that entrypoint focus on developers or anything that could be related to getting started with observability? e.g. , some organization that just wants to monitor its servers on a cloud provider and don't know how to start

I guess that both developers and end-users could get started by taking a look at existing tools at the Observability landscape and, if possible, some sort of observability tech radar.

Developers should want to dig deeper, like how does everything work internally, how their code impact scalability and user experience, but maybe that is too much for someone that wants to solve a small problem and don't need that much information

bwplotka commented 4 years ago

Should that entrypoint focus on developers or anything that could be related to getting started with observability? e.g. , some organization that just wants to monitor its servers on a cloud provider and don't know how to start

Yes, good question. Ideally it will be starting point with FAQ-like style (:

Proposed something we can iterate on here: https://github.com/cncf/sig-observability/pull/21 Some FAQ like approach looks nice, but feedback welcome.