alloy icon indicating copy to clipboard operation
alloy copied to clipboard

Post release Alloy documentation cleanup

Open clayton-cornell opened this issue 9 months ago • 0 comments

Documentation across most of the Grafana stack contains references and content describing how to use the various modes of Grafana Agent. This documentation needs to be found, assessed, and either removed, updated, or completely rewritten for Alloy.

Challenges

  • Old content. There are sections of the documentation that were written only for Agent Static or Agent Operator. This content will require either a full rewrite or removal.
  • The Grafana UI hasn't been updated. If we update the documentation with Alloy-based content, we have to make sure that the UI has actually been updated. There are still cases where the UI only references Static or Operator.

Product areas that need to be assessed for Agent-->Alloy work

  • Grafana
    • Tracking issue
  • Cloud
    • Tracking issue
  • K8s
    • Tracking issue
  • AWS
    • Tracking issue
  • Asserts
    • Tracking issue
  • AppO11y
    • Tracking issue
  • K6
    • Only references Datadog Agent. Nothing to change here
  • Loki
    • Alloy issue: https://github.com/grafana/alloy/issues/884
  • Tempo
    • Tempo tracking issue: https://github.com/grafana/tempo/issues/3648
    • Alloy issue: https://github.com/grafana/alloy/issues/881
  • Pyroscope
    • Pyroscope tracking issue: https://github.com/grafana/pyroscope/issues/3271
    • Alloy issue: https://github.com/grafana/alloy/issues/883
  • Mimir
    • Alloy issue: https://github.com/grafana/alloy/issues/885
  • Alerting
    • Tracking issue
  • Incident
    • Tracking issue
  • OnCall
    • Tracking issue
  • Beyla
    • Tracking issue
  • Other?
    • Tracking issue

clayton-cornell avatar May 15 '24 19:05 clayton-cornell