canonical / grafana-cloud-integrator

This charmed integrator automates the operational procedures of making Grafana Agent ship telemetry to the Grafana Cloud.
https://charmhub.io/grafana-cloud-integrator
Apache License 2.0
1 stars 1 forks source link

Add documentation for the grafana_cloud_integrator library #15

Open ca-scribner opened 1 month ago

ca-scribner commented 1 month ago

Enhancement Proposal

The provider and requirer sides of the grafana_cloud_integrator library have no documentation describing usage, intent, etc. We should add this documentation.

ca-scribner commented 1 month ago

Some of the public methods are also lacking docstrings, which will be an issue when #17 is fixed