Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

requited shorcode

pull/1896/head
Scott Anderson 2020-11-25 15:39:25 -07:00
parent f750e55e8d
commit 146f601d06
35 changed files with 132 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
CONTRIBUTING.md
View File

@ -333,6 +333,36 @@ WHERE time > now() - 15m
{{< /code-tabs-wrapper >}}
~~~
### Required elements
Use the `{{< req >}}` shortcode to identify required elements in documentation with
orange text and/or asterisks. By default, the shortcode outputs the text, "Required," but
you can customize the text by passing a string argument with the shortcode.
```md
{{< req >}}
```
**Output:** Required
```md
{{< req "This is Required" >}}
```
**Output:** This is required
#### Required elements in a list
When identifying required elements in a list, use `{{< req type="key" >}}` to generate
a "* Required" key before the list. For required elements in the list, include
{{< req "\*" >}} before the text of the list item. For example:
```md
{{< req type="key" >}}
- {{< req "\*" >}} **This element is required**
- {{< req "\*" >}} **This element is also required**
- **This element is NOT required**
```
### Keybinds
Use the `{{< keybind >}}` shortcode to include OS-specific keybindings/hotkeys.
The following parameters are available:

12
assets/styles/layouts/_article.scss
View File

@ -128,8 +128,18 @@
.required, .req {
color:#FF8564;
font-weight:700;
font-weight:$medium;
font-style: italic;
margin: 0 .15rem 0 .1rem;
&.asterisk {
margin: 0 -.1rem 0 -.5rem;
}
&.key {
font-size: .9rem;
font-weight: $medium;
}
}
a.q-link {

16
content/influxdb/cloud/query-data/influxql.md
View File

@ -41,8 +41,9 @@ Include the following:
- **Request method:** `GET`
- **Headers:**
- **Authorization:** `Token` schema with your InfluxDB [authentication token](/influxdb/cloud/security/tokens/)
- **Query parameters:**
- (<span class="req">Required</span>) **organization_id:** [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id)
- **Query parameters:**
{{< req type="key" >}}
- {{< req "\*" >}} **organization_id:** [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id)
- **bucket_id:** [bucket ID](/influxdb/cloud/organizations/buckets/view-buckets/) _(to list DBRP mappings for a specific bucket)_
- **database:** database name _(to list DBRP mappings with a specific database name)_
- **retention_policy:** retention policy name _(to list DBRP mappings with a specific retention policy name)_
@ -81,12 +82,13 @@ Include the following:
- **Headers:**
- **Authorization:** `Token` schema with your InfluxDB [authentication token](/influxdb/cloud/security/tokens/)
- **Content-type:** `application/json`
- **Request body:** JSON object with the following fields:
- (<span class="req">Required</span>) **bucket_id:** [bucket ID](/influxdb/cloud/organizations/buckets/view-buckets/)
- (<span class="req">Required</span>) **database:** database name
- **Request body:** JSON object with the following fields:
{{< req type="key" >}}
- {{< req "\*" >}} **bucket_id:** [bucket ID](/influxdb/cloud/organizations/buckets/view-buckets/)
- {{< req "\*" >}} **database:** database name
- **default:** set the provided retention policy as the default retention policy for the database
- (<span class="req">Required</span>) **organization** or **organization_id:** organization name or [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id)
- (<span class="req">Required</span>) **retention_policy:** retention policy name
- {{< req "\*" >}} **organization** or **organization_id:** organization name or [organization ID](/influxdb/cloud/organizations/view-orgs/#view-your-organization-id)
- {{< req "\*" >}} **retention_policy:** retention policy name
<!-- -->
```sh

2
content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/covariance.md
View File

@ -24,7 +24,7 @@ covariance(columns: ["column_x", "column_y"], pearsonr: false, valueDst: "_value
## Parameters
### columns
A list of **two columns** on which to operate. <span class="required">Required</span>
({{< req >}}) A list of **two columns** on which to operate.
_**Data type:** Array of strings_

4
content/influxdb/cloud/reference/flux/stdlib/built-in/transformations/join.md
View File

@ -50,7 +50,7 @@ The resulting group keys for all tables will be: `[_time, _field_d1, _field_d2]`
## Parameters
### tables
The map of streams to be joined. <span class="required">Required</span>
({{< req >}}) The map of streams to be joined.
_**Data type:** Record_
@ -59,7 +59,7 @@ _**Data type:** Record_
{{% /note %}}
### on
The list of columns on which to join. <span class="required">Required</span>
({{< req >}}) The list of columns on which to join.
_**Data type:** Array of strings_

6
content/influxdb/cloud/reference/flux/stdlib/contrib/influxdb/select.md
View File

@ -48,12 +48,12 @@ querying data from a **different organization** or a **remote InfluxDB instance*
{{% /note %}}
### from
<span class="req">Required</span> Name of the bucket to query.
({{< req >}}) Name of the bucket to query.
_**Data type:** String_
### start
<span class="req">Required</span> Earliest time to include in results.
({{< req >}}) Earliest time to include in results.
Results **include** points that match the specified start time.
Use a relative duration, absolute time, or integer (Unix timestamp in seconds).
For example, `-1h`, `2019-08-28T22:00:00Z`, or `1567029600`.
@ -73,7 +73,7 @@ Defaults to `now()`.
_**Data type:** Duration | Time | Integer_
### m
<span class="req">Required</span> Name of the measurement to query.
({{< req >}}) Name of the measurement to query.
_**Data type:** String_

2
content/influxdb/cloud/reference/flux/stdlib/contrib/opsgenie/endpoint.md
View File

@ -32,7 +32,7 @@ Defaults to `https://api.opsgenie.com/v2/alerts`.
_**Data type:** String_
### apiKey
<span class="req">Required</span>
({{< req >}})
Opsgenie API authorization key.
_**Data type:** String_

4
content/influxdb/cloud/reference/flux/stdlib/contrib/opsgenie/sendalert.md
View File

@ -41,13 +41,13 @@ Defaults to `https://api.opsgenie.com/v2/alerts`.
_**Data type:** String_
### apiKey
<span class="req">Required</span>
({{< req >}})
Opsgenie API authorization key.
_**Data type:** String_
### message
<span class="req">Required</span>
({{< req >}})
Alert message text.
130 characters or less.

4
content/influxdb/cloud/reference/flux/stdlib/contrib/sensu/endpoint.md
View File

@ -36,14 +36,14 @@ sensu.endpoint(
## Parameters
### url
<span class="req">Required</span>
({{< req >}})
Base URL of [Sensu API](https://docs.sensu.io/sensu-go/latest/migrate/#architecture)
**without a trailing slash**. Example: `http://localhost:8080`.
_**Data type:** String_
### apiKey
<span class="req">Required</span>
({{< req >}})
Sensu [API Key](https://docs.sensu.io/sensu-go/latest/operations/control-access/).
_**Data type:** String_

8
content/influxdb/cloud/reference/flux/stdlib/contrib/sensu/event.md
View File

@ -38,20 +38,20 @@ sensu.event(
## Parameters
### url
<span class="req">Required</span>
({{< req >}})
Base URL of [Sensu API](https://docs.sensu.io/sensu-go/latest/migrate/#architecture)
**without a trailing slash**. Example: `http://localhost:8080`.
_**Data type:** String_
### apiKey
<span class="req">Required</span>
({{< req >}})
Sensu [API Key](https://docs.sensu.io/sensu-go/latest/operations/control-access/).
_**Data type:** String_
### checkName
<span class="req">Required</span>
({{< req >}})
Check name.
Use alphanumeric characters, underscores (`_`), periods (`.`), and hyphens (`-`).
All other characters are replaced with an underscore.
@ -59,7 +59,7 @@ All other characters are replaced with an underscore.
_**Data type:** String_
### text
<span class="req">Required</span>
({{< req >}})
Event text.
Mapped to `output` in the Sensu Events API request.

2
content/influxdb/cloud/reference/flux/stdlib/contrib/telegram/endpoint.md
View File

@ -40,7 +40,7 @@ Default is `https://api.telegram.org/bot`.
_**Data type:** String_
### token
<span class="req">Required</span>
({{< req >}})
Telegram bot token.
_**Data type:** String_

4
content/influxdb/cloud/reference/flux/stdlib/contrib/telegram/message.md
View File

@ -43,13 +43,13 @@ Default is `https://api.telegram.org/bot`.
_**Data type:** String_
### token
<span class="req">Required</span>
({{< req >}})
Telegram bot token.
_**Data type:** String_
### channel
<span class="req">Required</span>
({{< req >}})
Telegram channel ID.
_**Data type:** String_

2
content/influxdb/cloud/reference/flux/stdlib/pushbullet/pushdata.md
View File

@ -45,7 +45,7 @@ Defaults to `""`.
_**Data type:** String_
### data
<span class="req">Required</span>
({{< req >}})
Data to send to the Pushbullet API.
The function JSON-encodes data before sending it to Pushbullet.

4
content/influxdb/cloud/reference/flux/stdlib/pushbullet/pushnote.md
View File

@ -42,13 +42,13 @@ Defaults to `""`.
_**Data type:** String_
### title
<span class="req">Required</span>
({{< req >}})
Title of the notification.
_**Data type:** String_
### text
<span class="req">Required</span>
({{< req >}})
Text to display in the notification.
_**Data type:** String_

8
content/influxdb/cloud/reference/flux/stdlib/slack/message.md
View File

@ -55,18 +55,20 @@ A token is only required if using the Slack chat.postMessage API.
_**Data type:** String_
### channel
The name of channel to post the message to. <span class="required">Required</span>
({{< req >}})
The name of channel to post the message to.
_**Data type:** String_
### text
The text to display in the Slack message. <span class="required">Required</span>
({{< req >}})
The text to display in the Slack message.
_**Data type:** String_
### color
({{< req >}})
The color to include with the message.
<span class="required">Required</span>
**Valid values include:**

8
content/influxdb/cloud/reference/flux/stdlib/sql/from.md
View File

@ -185,11 +185,11 @@ sql.from(
To query an Amazon Athena database, use the following query parameters in your Athena
S3 connection string (DSN):
<span class="req">\* Required</span>
{{< req type="key" >}}
- **region** - AWS region <span class="req">\*</span>
- **accessID** - AWS IAM access ID <span class="req">\*</span>
- **secretAccessKey** - AWS IAM secret key <span class="req">\*</span>
- {{< req "\*" >}} **region** - AWS region
- {{< req "\*" >}} **accessID** - AWS IAM access ID
- {{< req "\*" >}} **secretAccessKey** - AWS IAM secret key
- **db** - database name
- **WGRemoteCreation** - controls workgroup and tag creation
- **missingAsDefault** - replace missing data with default values

24
content/influxdb/v2.0/query-data/influxql.md
View File

@ -76,8 +76,9 @@ Include the following:
- **Request method:** `GET`
- **Headers:**
- **Authorization:** `Token` schema with your InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
- **Query parameters:**
- (<span class="req">Required</span>) **orgID:** [organization ID](/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id)
- **Query parameters:**
{{< req type="key" >}}
- {{< req "\*" >}} **orgID:** [organization ID](/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id)
- **bucketID:** [bucket ID](/influxdb/v2.0/organizations/buckets/view-buckets/) _(to list DBRP mappings for a specific bucket)_
- **database:** database name _(to list DBRP mappings with a specific database name)_
- **rp:** retention policy name _(to list DBRP mappings with a specific retention policy name)_
@ -124,9 +125,11 @@ Use the [`influx v1 dbrp create` command](/influxdb/v2.0/reference/cli/influx/v1
to map an unmapped bucket to a database and retention policy.
Include the following:
- (<span class="req">Required</span>) **database name** to map
- (<span class="req">Required</span>) **retention policy** name to map
- (<span class="req">Required</span>) [Bucket ID](/influxdb/v2.0/organizations/buckets/view-buckets/#view-buckets-in-the-influxdb-ui) to map to
{{< req type="key" >}}
- {{< req "\*" >}} **database name** to map
- {{< req "\*" >}} **retention policy** name to map
- {{< req "\*" >}} [Bucket ID](/influxdb/v2.0/organizations/buckets/view-buckets/#view-buckets-in-the-influxdb-ui) to map to
- **Default flag** to set the provided retention policy as the default retention policy for the database
```sh
@ -147,12 +150,13 @@ Include the following:
- **Headers:**
- **Authorization:** `Token` schema with your InfluxDB [authentication token](/influxdb/v2.0/security/tokens/)
- **Content-type:** `application/json`
- **Request body:** JSON object with the following fields:
- (<span class="req">Required</span>) **bucketID:** [bucket ID](/influxdb/v2.0/organizations/buckets/view-buckets/)
- (<span class="req">Required</span>) **database:** database name
- **Request body:** JSON object with the following fields:
{{< req type="key" >}}
- {{< req "\*" >}} **bucketID:** [bucket ID](/influxdb/v2.0/organizations/buckets/view-buckets/)
- {{< req "\*" >}} **database:** database name
- **default:** set the provided retention policy as the default retention policy for the database
- (<span class="req">Required</span>) **org** or **orgID:** organization name or [organization ID](/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id)
- (<span class="req">Required</span>) **retention_policy:** retention policy name
- {{< req "\*" >}} **org** or **orgID:** organization name or [organization ID](/influxdb/v2.0/organizations/view-orgs/#view-your-organization-id)
- {{< req "\*" >}} **retention_policy:** retention policy name
<!-- -->
```sh

4
content/influxdb/v2.0/reference/api/influxdb-1x/query.md
View File

@ -45,7 +45,7 @@ _For more information, see [Authentication](/influxdb/v2.0/reference/api/influxd
{{% /note %}}
### db
<span class="req">Required</span> – The **database** to query data from.
({{< req >}}) The **database** to query data from.
This is mapped to an InfluxDB [bucket](/influxdb/v2.0/reference/glossary/#bucket).
_See [Database and retention policy mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/)._
@ -55,7 +55,7 @@ This is mapped to an InfluxDB [bucket](/influxdb/v2.0/reference/glossary/#bucket
_See [Database and retention policy mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/)._
### q
<span class="req">Required</span> – The **InfluxQL** query to execute.
({{< req >}}) The **InfluxQL** query to execute.
To execute multiple queries, delimit queries with a semicolon (`;`).
### epoch

2
content/influxdb/v2.0/reference/api/influxdb-1x/write.md
View File

@ -40,7 +40,7 @@ encode the line protocol.
## Query string parameters
### db
<span class="req">Required</span> – The **database** to write data to.
({{< req >}}) The **database** to write data to.
This is mapped to an InfluxDB [bucket](/influxdb/v2.0/reference/glossary/#bucket).
_See [Database and retention policy mapping](/influxdb/v2.0/reference/api/influxdb-1x/dbrp/)._

2
content/influxdb/v2.0/reference/cli/influx/v1/dbrp/update.md
View File

@ -26,7 +26,7 @@ influx v1 dbrp update [flags]
| `-h` | `--help` | Help for the `update` command | | |
| | `--hide-headers` | Hide the table headers (default: `false`) | | `$INFLUX_HIDE_HEADERS` |
| | `--host` | HTTP address of InfluxDB | string | `$INFLUX_HOST` |
| | `--id` | DBRP ID <span class="req">Required</span> | string | |
| | `--id` | ({{< req >}}) DBRP ID | string | |
| | `--json` | Output data as JSON (default: `false`) | | `$INFLUX_OUTPUT_JSON` |
| `-o` | `--org` | Organization name | string | `$INFLUX_ORG` |
| | `--org-id` | Organization ID | string | `$INFLUX_ORG_ID` |

2
content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/covariance.md
View File

@ -24,7 +24,7 @@ covariance(columns: ["column_x", "column_y"], pearsonr: false, valueDst: "_value
## Parameters
### columns
A list of **two columns** on which to operate. <span class="required">Required</span>
({{< req >}}) A list of **two columns** on which to operate.
_**Data type:** Array of strings_

4
content/influxdb/v2.0/reference/flux/stdlib/built-in/transformations/join.md
View File

@ -50,7 +50,7 @@ The resulting group keys for all tables will be: `[_time, _field_d1, _field_d2]`
## Parameters
### tables
The map of streams to be joined. <span class="required">Required</span>
({{< req >}}) The map of streams to be joined.
_**Data type:** Record_
@ -59,7 +59,7 @@ _**Data type:** Record_
{{% /note %}}
### on
The list of columns on which to join. <span class="required">Required</span>
({{< req >}}) The list of columns on which to join.
_**Data type:** Array of strings_

6
content/influxdb/v2.0/reference/flux/stdlib/contrib/influxdb/select.md
View File

@ -48,12 +48,12 @@ querying data from a **different organization** or a **remote InfluxDB instance*
{{% /note %}}
### from
<span class="req">Required</span> Name of the bucket to query.
({{< req >}}) Name of the bucket to query.
_**Data type:** String_
### start
<span class="req">Required</span> Earliest time to include in results.
({{< req >}}) Earliest time to include in results.
Results **include** points that match the specified start time.
Use a relative duration, absolute time, or integer (Unix timestamp in seconds).
For example, `-1h`, `2019-08-28T22:00:00Z`, or `1567029600`.
@ -73,7 +73,7 @@ Defaults to `now()`.
_**Data type:** Duration | Time | Integer_
### m
<span class="req">Required</span> Name of the measurement to query.
({{< req >}}) Name of the measurement to query.
_**Data type:** String_

2
content/influxdb/v2.0/reference/flux/stdlib/contrib/opsgenie/endpoint.md
View File

@ -32,7 +32,7 @@ Defaults to `https://api.opsgenie.com/v2/alerts`.
_**Data type:** String_
### apiKey
<span class="req">Required</span>
({{< req >}})
Opsgenie API authorization key.
_**Data type:** String_

4
content/influxdb/v2.0/reference/flux/stdlib/contrib/opsgenie/sendalert.md
View File

@ -41,13 +41,13 @@ Defaults to `https://api.opsgenie.com/v2/alerts`.
_**Data type:** String_
### apiKey
<span class="req">Required</span>
({{< req >}})
Opsgenie API authorization key.
_**Data type:** String_
### message
<span class="req">Required</span>
({{< req >}})
Alert message text.
130 characters or less.

4
content/influxdb/v2.0/reference/flux/stdlib/contrib/sensu/endpoint.md
View File

@ -36,14 +36,14 @@ sensu.endpoint(
## Parameters
### url
<span class="req">Required</span>
({{< req >}})
Base URL of [Sensu API](https://docs.sensu.io/sensu-go/latest/migrate/#architecture)
**without a trailing slash**. Example: `http://localhost:8080`.
_**Data type:** String_
### apiKey
<span class="req">Required</span>
({{< req >}})
Sensu [API Key](https://docs.sensu.io/sensu-go/latest/operations/control-access/).
_**Data type:** String_

8
content/influxdb/v2.0/reference/flux/stdlib/contrib/sensu/event.md
View File

@ -38,20 +38,20 @@ sensu.event(
## Parameters
### url
<span class="req">Required</span>
({{< req >}})
Base URL of [Sensu API](https://docs.sensu.io/sensu-go/latest/migrate/#architecture)
**without a trailing slash**. Example: `http://localhost:8080`.
_**Data type:** String_
### apiKey
<span class="req">Required</span>
({{< req >}})
Sensu [API Key](https://docs.sensu.io/sensu-go/latest/operations/control-access/).
_**Data type:** String_
### checkName
<span class="req">Required</span>
({{< req >}})
Check name.
Use alphanumeric characters, underscores (`_`), periods (`.`), and hyphens (`-`).
All other characters are replaced with an underscore.
@ -59,7 +59,7 @@ All other characters are replaced with an underscore.
_**Data type:** String_
### text
<span class="req">Required</span>
({{< req >}})
Event text.
Mapped to `output` in the Sensu Events API request.

2
content/influxdb/v2.0/reference/flux/stdlib/contrib/telegram/endpoint.md
View File

@ -40,7 +40,7 @@ Default is `https://api.telegram.org/bot`.
_**Data type:** String_
### token
<span class="req">Required</span>
({{< req >}})
Telegram bot token.
_**Data type:** String_

4
content/influxdb/v2.0/reference/flux/stdlib/contrib/telegram/message.md
View File

@ -43,13 +43,13 @@ Default is `https://api.telegram.org/bot`.
_**Data type:** String_
### token
<span class="req">Required</span>
({{< req >}})
Telegram bot token.
_**Data type:** String_
### channel
<span class="req">Required</span>
({{< req >}})
Telegram channel ID.
_**Data type:** String_

2
content/influxdb/v2.0/reference/flux/stdlib/pushbullet/pushdata.md
View File

@ -45,7 +45,7 @@ Defaults to `""`.
_**Data type:** String_
### data
<span class="req">Required</span>
({{< req >}})
Data to send to the Pushbullet API.
The function JSON-encodes data before sending it to Pushbullet.

4
content/influxdb/v2.0/reference/flux/stdlib/pushbullet/pushnote.md
View File

@ -42,13 +42,13 @@ Defaults to `""`.
_**Data type:** String_
### title
<span class="req">Required</span>
({{< req >}})
Title of the notification.
_**Data type:** String_
### text
<span class="req">Required</span>
({{< req >}})
Text to display in the notification.
_**Data type:** String_

7
content/influxdb/v2.0/reference/flux/stdlib/slack/message.md
View File

@ -55,18 +55,17 @@ A token is only required if using the Slack chat.postMessage API.
_**Data type:** String_
### channel
The name of channel to post the message to. <span class="required">Required</span>
({{< req >}}) The name of channel to post the message to.
_**Data type:** String_
### text
The text to display in the Slack message. <span class="required">Required</span>
({{< req >}}) The text to display in the Slack message.
_**Data type:** String_
### color
The color to include with the message.
<span class="required">Required</span>
({{< req >}}) The color to include with the message.
**Valid values include:**

8
content/influxdb/v2.0/reference/flux/stdlib/sql/from.md
View File

@ -185,11 +185,11 @@ sql.from(
To query an Amazon Athena database, use the following query parameters in your Athena
S3 connection string (DSN):
<span class="req">\* Required</span>
{{< req type="key" >}}
- **region** - AWS region <span class="req">\*</span>
- **accessID** - AWS IAM access ID <span class="req">\*</span>
- **secretAccessKey** - AWS IAM secret key <span class="req">\*</span>
- {{< req "\*" >}} **region** - AWS region
- {{< req "\*" >}} **accessID** - AWS IAM access ID
- {{< req "\*" >}} **secretAccessKey** - AWS IAM secret key
- **db** - database name
- **WGRemoteCreation** - controls workgroup and tag creation
- **missingAsDefault** - replace missing data with default values

4
content/influxdb/v2.0/reference/syntax/line-protocol.md
View File

@ -50,7 +50,7 @@ measurementName,tagKey=tagValue fieldKey="fieldValue" 1465839830100400200
```
### Measurement
<span class="required">Required</span> –
({{< req >}})
The measurement name.
InfluxDB accepts one measurement per point.
_Measurement names are case-sensitive and subject to [naming restrictions](#naming-restrictions)._
@ -70,7 +70,7 @@ _**Key data type:** [String](#string)_
_**Value data type:** [String](#string)_
### Field set
<span class="required">Required</span> –
({{< req >}})
All field key-value pairs for the point.
Points must have at least one field.
_Field keys and string values are case-sensitive.

4
layouts/shortcodes/req.html Normal file
View File

@ -0,0 +1,4 @@
{{- $text := .Get 0 | default "Required" -}}
{{- $type := .Get "type" | default "text" -}}
{{- $class := cond (le (len $text) 2) "asterisk" "" -}}
{{- if ne $type "key" -}}<span class="req {{ $class }}">{{ $text | markdownify }}</span>{{ else }}<span class="req key">* Required</span>{{ end }}