Improve documentation #79
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zippolyte
requested changes
Jul 12, 2018
website/docs/r/monitor.html.markdown
Outdated
| @@ -57,7 +57,9 @@ The following arguments are supported: | |||
| * `composite` | |||
| * `name` - (Required) Name of Datadog monitor | |||
| * `query` - (Required) The monitor query to notify on with syntax varying depending on what type of monitor | |||
| you are creating. See [API Reference](http://docs.datadoghq.com/api) for options. | |||
| you are creating. Note this is not the same query you see in the UI, the format is different depending on the | |||
There was a problem hiding this comment.
I had a hard time reading this sentence. I'd split the sentence, something like:
The monitor query on which to notify. The syntax varies depending on the type of monitor you are creating.
website/docs/r/monitor.html.markdown
Outdated
| @@ -74,6 +76,10 @@ The following arguments are supported: | |||
| warning_recovery = 75 | |||
| } | |||
| ``` | |||
| **Warning:** the `critical` threshold value has to match the one contained in the `query` argument. For example, a | |||
There was a problem hiding this comment.
I'd replace has to with *must* to emphasize
website/docs/r/monitor.html.markdown
Outdated
| @@ -74,6 +76,10 @@ The following arguments are supported: | |||
| warning_recovery = 75 | |||
| } | |||
| ``` | |||
| **Warning:** the `critical` threshold value has to match the one contained in the `query` argument. For example, a | |||
| query like `avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 90` would be fine with the `threshold` above, | |||
There was a problem hiding this comment.
s/would be fine/is valid
website/docs/r/monitor.html.markdown
Outdated
| @@ -74,6 +76,10 @@ The following arguments are supported: | |||
| warning_recovery = 75 | |||
| } | |||
| ``` | |||
| **Warning:** the `critical` threshold value has to match the one contained in the `query` argument. For example, a | |||
| query like `avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 90` would be fine with the `threshold` above, | |||
| while `avg(last_1h):avg:system.disk.in_use{role:sqlserver} by {host} > 95` would be not, with the Datadog API returning | |||
There was a problem hiding this comment.
s/would be not/is invalid
|
|
||
| Nested `graph` `marker` blocks have the following structure: | ||
|
|
||
| * `type` - (Required) How the marker lines will look. Possible values are {"error", "warning", "info", "ok"} {"dashed", "solid", "bold"}. Example: "error dashed". | ||
| * `value` - (Required) Mathematical expression describing the marker. Examples: "y > 1", "-5 < y < 0", "y = 19". | ||
| * `label` - (Optional) A label for the line or range. | ||
| * `label` - (Optional) A label for the line or range. **Warning:** when a label is enabled but left empty through the UI, the Datadog API returns a boolean value, not a string, making `terraform plan` fail with a JSON decoding error. |
There was a problem hiding this comment.
Sentence seems long: we should maybe split ... not a string. This makes terraform ...
zippolyte
approved these changes
Jul 12, 2018
nitrocode
pushed a commit
to nitrocode/terraform-provider-datadog
that referenced
this pull request
Nov 3, 2018
Improve documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an attempt to improve docs as a way to mitigate a few recurring issues. In some cases, a better documentation is the only workaround we can provide in the short term to mitigate known pain points.