[Docs]: Update Docs for `grafana_machine_learning_alert`

SeamusGrafana commented 3 months ago

Update the Docs for grafana_machine_learning_alert to clarify usage.

Specify that one of job_id or outlier_id is required
Specify that anomaly_condition can only be used with job_id
Specify the acceptable values for anomaly_condition one of any, high, low and what each does.
Specify the acceptable values for no_data_state one of Alerting, NoData or OK
Correct Import Example to show Format: Import ID must be in the format '/(jobs|outliers)/<jobID>/alerts/<alertID>'
Correct outlier_id (String) The forecast this alert belongs to. to outlier_id (String) The outlier this alert belongs to.

SeamusGrafana commented 3 months ago

Cc: @csmarchbanks

csmarchbanks commented 3 months ago

I'm honestly disappointed that terraform doc generation doesn't handle this for us. All of those are already specified in the code and writing extra docs seems tedious and bound to get out of sync. Regardless, feel free to open a PR, or else I'll get to it soon.

julienduchesne commented 3 months ago

I'm honestly disappointed that terraform doc generation doesn't handle this for us. All of those are already specified in the code and writing extra docs seems tedious and bound to get out of sync. Regardless, feel free to open a PR, or else I'll get to it soon.

Yeah, they definitely could've made this better with the new plugin framework. We have a helper for some of these: AllowedValuesDescription

grafana / terraform-provider-grafana

[Docs]: Update Docs for `grafana_machine_learning_alert` #1709