added link to influx cli conventions and patters to all cli docs, closes #1992

pull/2001/head
Scott Anderson 2020-12-17 22:54:42 -07:00
parent 93f59a29ad
commit a1a658678e
57 changed files with 151 additions and 17 deletions

View File

@ -9,6 +9,8 @@ weight: 101
aliases:
- /influxdb/cloud/reference/cli/influx/pkg/
influxdb/cloud/tags: [templates]
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -7,6 +7,9 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [authentication]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -7,6 +7,8 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [backup]
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{% cloud %}}

View File

@ -7,6 +7,10 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [buckets]
cascade:
related:
- /influxdb/cloud/organizations/buckets/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -8,6 +8,9 @@ menu:
weight: 201
aliases:
- /influxdb/cloud/reference/cli/influx/bucket/create/
related:
- /influxdb/cloud/organizations/buckets/create-buckets/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -8,6 +8,7 @@ menu:
weight: 201
related:
- /influxdb/cloud/organizations/buckets/delete-bucket/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -9,6 +9,8 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [cli, tools]
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -7,6 +7,9 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [config]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -8,6 +8,8 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [telegraf]
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -10,6 +10,7 @@ influxdb/cloud/tags: [delete]
related:
- /influxdb/cloud/write-data/delete-data
- /influxdb/cloud/reference/syntax/delete-predicate
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -5,8 +5,10 @@ menu:
influxdb_cloud_ref:
parent: influx
weight: 101
related:
- /influxdb/cloud/influxdb-templates/create/
cascade:
related:
- /influxdb/cloud/influxdb-templates/create/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -6,6 +6,8 @@ menu:
name: influx help
parent: influx
weight: 101
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -7,6 +7,9 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [organizations]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -6,7 +6,6 @@ menu:
name: influx org members
parent: influx org
weight: 201
influxdb/cloud/tags: [members, organizations]
---
{{% cloud %}}

View File

@ -9,6 +9,8 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [ping, health]
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -9,6 +9,9 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [query]
related:
- /influxdb/cloud/query-data/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -7,7 +7,7 @@ menu:
parent: influx
weight: 101
related:
- /influxdb/cloud/backup-restore/restore/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{% cloud %}}

View File

@ -7,6 +7,10 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [secrets]
cascade:
related:
- /influxdb/cloud/security/secrets/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -9,6 +9,8 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [get-started]
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/
---

View File

@ -9,6 +9,9 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [templates]
related:
- /influxdb/cloud/influxdb-templates/stacks/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -7,6 +7,10 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [tasks]
cascade:
related:
- /influxdb/cloud/process-data/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -9,6 +9,10 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [telegraf]
cascade:
related:
- /influxdb/cloud/telegraf-configs/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -7,6 +7,10 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [templates]
cascade:
related:
- /influxdb/cloud/influxdb-templates/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -8,6 +8,8 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [influxql, flux]
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -7,6 +7,9 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [users]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/
---

View File

@ -8,6 +8,7 @@ menu:
weight: 201
related:
- /influxdb/cloud/account-management/change-password/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/password/
---

View File

@ -7,6 +7,9 @@ menu:
name: influx v1
parent: influx
weight: 101
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -9,12 +9,14 @@ menu:
parent: influx
weight: 101
influxdb/cloud/tags: [write]
related:
- /influxdb/cloud/write-data/
- /influxdb/cloud/write-data/developer-tools/csv/
- /influxdb/cloud/reference/syntax/line-protocol/
- /influxdb/cloud/reference/syntax/annotated-csv/
- /influxdb/cloud/reference/syntax/annotated-csv/extended/
cascade:
related:
- /influxdb/cloud/write-data/
- /influxdb/cloud/write-data/developer-tools/csv/
- /influxdb/cloud/reference/syntax/line-protocol/
- /influxdb/cloud/reference/syntax/annotated-csv/
- /influxdb/cloud/reference/syntax/annotated-csv/extended/
- /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{< duplicate-oss >}}

View File

@ -9,6 +9,8 @@ weight: 101
aliases:
- /influxdb/v2.0/reference/cli/influx/pkg/
influxdb/v2.0/tags: [templates]
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx apply` command applies InfluxDB templates.

View File

@ -7,6 +7,9 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [authentication]
cascade:
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx auth` command and its subcommands manage authentication tokens in InfluxDB.

View File

@ -9,6 +9,7 @@ weight: 101
influxdb/v2.0/tags: [backup]
related:
- /influxdb/v2.0/backup-restore/backup/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx backup` command backs up data stored in InfluxDB to a specified directory.

View File

@ -7,6 +7,9 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [buckets]
cascade:
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx bucket` command and its subcommands manage buckets in InfluxDB.

View File

@ -10,6 +10,7 @@ aliases:
- /influxdb/v2.0/reference/cli/influx/bucket/create/
related:
- /influxdb/v2.0/organizations/buckets/create-bucket/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx bucket create` command creates a new bucket in InfluxDB.

View File

@ -10,6 +10,7 @@ aliases:
- /influxdb/v2.0/reference/cli/influx/bucket/delete/
related:
- /influxdb/v2.0/organizations/buckets/delete-bucket/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx bucket delete` command deletes a bucket from InfluxDB and all the data it contains.

View File

@ -9,6 +9,8 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [cli, tools]
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx completion` command outputs `influx` shell completion scripts for a

View File

@ -7,6 +7,9 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [config]
cascade:
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx config` command displays the active InfluxDB connection configuration

View File

@ -8,6 +8,8 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [telegraf]
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx dashboards` command lists existing InfluxDB dashboards.

View File

@ -10,6 +10,7 @@ influxdb/v2.0/tags: [delete]
related:
- /influxdb/v2.0/write-data/delete-data
- /influxdb/v2.0/reference/syntax/delete-predicate
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx delete` command deletes [points](/influxdb/v2.0/reference/glossary/#point)

View File

@ -9,6 +9,7 @@ aliases:
- /influxdb/v2.0/reference/cli/influx/pkg/export/
related:
- /influxdb/v2.0/influxdb-templates/create/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx export` command exports existing resources as an InfluxDB template.

View File

@ -10,6 +10,7 @@ aliases:
- /influxdb/v2.0/reference/cli/influx/pkg/export/all/
related:
- /influxdb/v2.0/influxdb-templates/create/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx export all` command exports all resources in an

View File

@ -8,6 +8,8 @@ menu:
weight: 201
aliases:
- /influxdb/v2.0/reference/cli/influx/pkg/export/stack
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx export stack` command exports all resources associated with a stack as a template.

View File

@ -6,6 +6,8 @@ menu:
name: influx help
parent: influx
weight: 101
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx help` command provides help for any command in the `influx` command line interface.

View File

@ -7,6 +7,9 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [organizations]
cascade:
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx org` command and its subcommands manage organization information in InfluxDB.

View File

@ -9,6 +9,8 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [ping, health]
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx ping` command checks the health of a running InfluxDB instance by

View File

@ -9,6 +9,9 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [query]
related:
- /influxdb/v2.0/query-data/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx query` command executes a literal Flux query provided as a string

View File

@ -4,6 +4,8 @@ description: >
The `influx repl` command opens an interactive Read-Eval-Print Loop (REPL)
from which you can run Flux commands.
influxdb/v2.0/tags: [query]
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
{{% warn %}}

View File

@ -10,6 +10,7 @@ alias:
- /influxdb/v2.0/reference/cli/influxd/restore/
related:
- /influxdb/v2.0/backup-restore/restore/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx restore` command restores backup data and metadata from an InfluxDB backup directory.

View File

@ -7,6 +7,10 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [secrets]
cascade:
related:
- /influxdb/v2.0/security/secrets/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx secret` command manages secrets.

View File

@ -9,6 +9,8 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [get-started]
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/
---

View File

@ -11,6 +11,10 @@ weight: 101
aliases:
- /influxdb/v2.0/reference/cli/influx/pkg/stack/list/
influxdb/v2.0/tags: [templates]
cascade:
related:
- /influxdb/v2.0/influxdb-templates/stacks/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx stacks` command and its subcommands list and manage InfluxDB stacks

View File

@ -7,6 +7,10 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [tasks]
cascade:
related:
- /influxdb/v2.0/process-data/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx task` command and its subcommands manage tasks in InfluxDB.

View File

@ -9,6 +9,10 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [telegraf]
cascade:
related:
- /influxdb/v2.0/telegraf-configs/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx telegrafs` command lists Telegraf configurations.

View File

@ -9,6 +9,10 @@ weight: 101
influxdb/v2.0/tags: [templates]
aliases:
- /influxdb/v2.0/reference/cli/influx/pkg/summary/
cascade:
related:
- /influxdb/v2.0/influxdb-templates/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx template` command summarizes the specified InfluxDB template.

View File

@ -8,6 +8,8 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [influxql, flux]
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx transpile` command transpiles an InfluxQL query to Flux source code.

View File

@ -7,6 +7,10 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [users]
cascade:
related:
- /influxdb/v2.0/users/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/
---

View File

@ -7,7 +7,9 @@ menu:
name: influx v1
parent: influx
weight: 101
influxdb/v2.0/tags: []
cascade:
related:
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx v1` command provides commands for working with the [InfluxDB 1.x compatibility API](/influxdb/v2.0/reference/api/influxdb-1x/) in InfluxDB 2.0.

View File

@ -9,12 +9,14 @@ menu:
parent: influx
weight: 101
influxdb/v2.0/tags: [write]
related:
- /influxdb/v2.0/write-data/
- /influxdb/v2.0/write-data/developer-tools/csv/
- /influxdb/v2.0/reference/syntax/line-protocol/
- /influxdb/v2.0/reference/syntax/annotated-csv/
- /influxdb/v2.0/reference/syntax/annotated-csv/extended/
cascade:
related:
- /influxdb/v2.0/write-data/
- /influxdb/v2.0/write-data/developer-tools/csv/
- /influxdb/v2.0/reference/syntax/line-protocol/
- /influxdb/v2.0/reference/syntax/annotated-csv/
- /influxdb/v2.0/reference/syntax/annotated-csv/extended/
- /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions
---
The `influx write` command writes data to InfluxDB via stdin or from a specified file.