Open
Description
Description
The Getting Started Guide for Observabillity needs to be edited:
- Needs a better intro
- Some flawed syntax, punctuation
- Needs to conform to style guidelines we have defined
- Needs better xrefs to other docs for more information
- Getting started guides should provide a bridge into the main documentation
- Propose that links throughout the content could be distracting for some new users so, for Getting started guides only, propose that we deviate from our standard practice and instead add a "To learn more" subsection to each major section and add appropriate xrefs there.
DoD
- Intro makes sense for someone who comes to this page without much prior knowledge
- Syntax is good
- Conforms to style guidelines for capitalization of terms, links to k8s docs for major items
- Contains appropriate links to the Guides and reference pages and possibly Kubernetes docs
Metadata
Metadata
Assignees
Type
Projects
Status
🎟️ Refined