From 09ece2826eb80bdb1c1cff0a9a61c28252098281 Mon Sep 17 00:00:00 2001 From: Jason Harley Date: Mon, 9 Oct 2023 15:14:21 -0400 Subject: [PATCH] [docs] add environment-wide '__all__' note where supported I had thought this was already done, but it clearly was not. --- docs/data-sources/query_result.md | 2 +- docs/resources/derived_column.md | 2 +- docs/resources/marker.md | 2 +- docs/resources/marker_setting.md | 2 +- docs/resources/query.md | 2 +- docs/resources/query_annotation.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/data-sources/query_result.md b/docs/data-sources/query_result.md index d0335861..bda593b0 100644 --- a/docs/data-sources/query_result.md +++ b/docs/data-sources/query_result.md @@ -36,7 +36,7 @@ output "event_count" { The following arguments are supported: -* `dataset` - (Required) The dataset this query is associated with. +* `dataset` - (Required) The dataset this query is associated with. Use `__all__` for Environment-wide queries. * `query_json` - (Required) A JSON object describing the query according to the Query Specification. While the JSON can be constructed manually, it is easiest to use the honeycombio_query_specification data source. ## Attribute Reference diff --git a/docs/resources/derived_column.md b/docs/resources/derived_column.md index 6d94173f..587b2b04 100644 --- a/docs/resources/derived_column.md +++ b/docs/resources/derived_column.md @@ -22,7 +22,7 @@ resource "honeycombio_derived_column" "duration_ms_log" { The following arguments are supported: -* `dataset` - (Required) The dataset this derived column is added to. +* `dataset` - (Required) The dataset this derived column is added to. Use `__all__` for Environment-wide derived columns. * `alias` - (Required) The name of the derived column. Must be unique per dataset. * `expression` - (Required) The function of the derived column. See [Derived Column Syntax](https://docs.honeycomb.io/working-with-your-data/customizing-your-query/derived-columns/#derived-column-syntax). * `description` - (Optional) A description that is shown in the UI. diff --git a/docs/resources/marker.md b/docs/resources/marker.md index 024ed6ac..a7fdf037 100644 --- a/docs/resources/marker.md +++ b/docs/resources/marker.md @@ -28,7 +28,7 @@ resource "honeycombio_marker" "marker" { The following arguments are supported: -* `dataset` - (Required) The dataset this marker is placed on. +* `dataset` - (Required) The dataset this marker is placed on. Use `__all__` for Environment-wide markers. * `message` - (Optional) The message on the marker. * `type` - (Optional) The type of the marker, Honeycomb.io can display markers in different colors depending on their type. * `url` - (Optional) A target for the Marker. If you click on the Marker text, it will take you to this URL. diff --git a/docs/resources/marker_setting.md b/docs/resources/marker_setting.md index 47aeac53..f7b22b3f 100644 --- a/docs/resources/marker_setting.md +++ b/docs/resources/marker_setting.md @@ -24,7 +24,7 @@ resource "honeycombio_marker_setting" "markerSetting" { The following arguments are supported: -* `dataset` - (Required) The dataset this marker setting is placed on. +* `dataset` - (Required) The dataset this marker setting is placed on. Use `__all__` for Environment-wide marker settings. * `type` - (Required) The type of the marker setting, Honeycomb.io can display markers in different colors depending on their type. * `color` - (Required) The color set for the marker as a hex color code (e.g. `#DF4661`) diff --git a/docs/resources/query.md b/docs/resources/query.md index e70ffc31..7d038816 100644 --- a/docs/resources/query.md +++ b/docs/resources/query.md @@ -36,7 +36,7 @@ resource "honeycombio_query" "test_query" { The following arguments are supported: -* `dataset` - (Required) The dataset this query is added to. +* `dataset` - (Required) The dataset this query is added to. Use `__all__` for Environment-wide queries. * `query_json` - (Required) A JSON object describing the query according to the [Query Specification](https://docs.honeycomb.io/api/query-specification/#fields-on-a-query-specification). While the JSON can be constructed manually, it is easiest to use the [`honeycombio_query_specification`](../data-sources/query_specification.md) data source. ## Attribute Reference diff --git a/docs/resources/query_annotation.md b/docs/resources/query_annotation.md index 9bd48414..9eb70951 100644 --- a/docs/resources/query_annotation.md +++ b/docs/resources/query_annotation.md @@ -43,7 +43,7 @@ resource "honeycombio_query_annotation" "test_annotation" { The following arguments are supported: -* `dataset` - (Required) The dataset this query is added to. +* `dataset` - (Required) The dataset this query annotation is added to. Use `__all__` for Environment-wide query annotations. * `query_id` - (Required) The ID of the query that the annotation will be created on. Note that a query can have more than one annotation. * `name` - (Required) The name of the query annotation that will display in the Honeycomb UI. * `description` - (Optional) The description for the query annotation.