cncf / tag-observability

Technical Advisory Group for Observability 🔭⚙️
https://cncf.io/projects
Apache License 2.0
640 stars 83 forks source link

Move initial whitepaper draft from google docs to Github. #47

Closed ArthurSens closed 3 years ago

ArthurSens commented 3 years ago

A lot of places still need some improvements.

What to look for next:

  1. We've been discussing on slack a lot about "Lifecycle". An observable system goes through design, instrumentation and only then observation. How do we get this concept into the whitepaper?
  2. There are a couple of sections unwritten, we need to decide if we're going to remove those sections or not. If we keep them, we need to write :|
  3. Some sections were written without proper storytelling, just dumping content. We need to rephrase a lot of paragraphs to make it nice to read.
  4. References need to be properly referenced.
  5. We need to mention all our amazing contributors that made this whitepaper possible 🤗
bwplotka commented 3 years ago

Thanks a lot! Let's go through this tomorrow?

ArthurSens commented 3 years ago

A couple of things to add:

For myself: Move "To be written" to an "Open to contributions section" Rephrasing could also be "Open to contribution" Take a look at markdown linking examples on observability-charter