Ensure observability documentation is clear, accessible, and grammatically correct. This includes defining technical acronyms and ensuring proper sentence structure in configuration explanations.
Ensure observability documentation is clear, accessible, and grammatically correct. This includes defining technical acronyms and ensuring proper sentence structure in configuration explanations.
When documenting observability systems, always:
Example of good practice:
# Open Telemetry ALS with Loki
This sample demonstrates Access Log Service (ALS) integration with Loki for distributed tracing.
> **Warning**
> When the example `PodMonitor` is used with OpenShift Monitoring, it must be created in all namespaces where istio-proxies exist.
> This is because `namespaceSelector` is ignored for tenancy isolation.
Clear documentation prevents misconfigurations and reduces support overhead in observability deployments.
Enter the URL of a public GitHub repository