Skip to content

Commit

Permalink
[docs] add environment-wide '__all__' note where supported
Browse files Browse the repository at this point in the history
I had thought this was already done, but it clearly was not.
  • Loading branch information
jharley committed Oct 9, 2023
1 parent 59476c0 commit 09ece28
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/data-sources/query_result.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/derived_column.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/marker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/marker_setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`)

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/query_annotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 09ece28

Please sign in to comment.