From bad6817bf4e83063302424280aa57a657da17864 Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 23 Dec 2020 13:54:08 -0700 Subject: [PATCH] address more PR feedback --- CONTRIBUTING.md | 163 +++++++++--------- .../reference/cli/influx/apply/_index.md | 3 +- .../cloud/reference/cli/influx/auth/_index.md | 3 +- .../reference/cli/influx/backup/_index.md | 3 +- .../reference/cli/influx/bucket/_index.md | 3 +- .../reference/cli/influx/bucket/create.md | 3 +- .../reference/cli/influx/bucket/delete.md | 3 +- .../reference/cli/influx/completion/_index.md | 3 +- .../reference/cli/influx/config/_index.md | 3 +- .../reference/cli/influx/dashboards/_index.md | 3 +- .../reference/cli/influx/delete/_index.md | 3 +- .../reference/cli/influx/export/_index.md | 3 +- .../cloud/reference/cli/influx/help/_index.md | 3 +- .../cloud/reference/cli/influx/org/_index.md | 3 +- .../cloud/reference/cli/influx/ping/_index.md | 3 +- .../reference/cli/influx/query/_index.md | 3 +- .../reference/cli/influx/restore/index.md | 3 +- .../reference/cli/influx/secret/_index.md | 3 +- .../reference/cli/influx/setup/_index.md | 3 +- .../reference/cli/influx/stacks/_index.md | 8 +- .../cloud/reference/cli/influx/task/_index.md | 3 +- .../reference/cli/influx/telegrafs/_index.md | 3 +- .../reference/cli/influx/template/_index.md | 3 +- .../reference/cli/influx/transpile/_index.md | 3 +- .../cloud/reference/cli/influx/user/_index.md | 3 +- .../reference/cli/influx/user/password.md | 3 +- .../cloud/reference/cli/influx/v1/_index.md | 3 +- .../reference/cli/influx/write/_index.md | 3 +- .../v2.0/reference/cli/influx/_index.md | 60 +++---- .../v2.0/reference/cli/influx/apply/_index.md | 3 +- .../v2.0/reference/cli/influx/auth/_index.md | 3 +- .../reference/cli/influx/auth/inactive.md | 7 + .../reference/cli/influx/backup/_index.md | 3 +- .../reference/cli/influx/bucket/_index.md | 3 +- .../reference/cli/influx/bucket/create.md | 3 +- .../reference/cli/influx/bucket/delete.md | 3 +- .../reference/cli/influx/completion/_index.md | 3 +- .../reference/cli/influx/config/_index.md | 3 +- .../reference/cli/influx/dashboards/_index.md | 3 +- .../reference/cli/influx/delete/_index.md | 3 +- .../reference/cli/influx/export/_index.md | 3 +- .../v2.0/reference/cli/influx/export/all.md | 3 +- .../v2.0/reference/cli/influx/export/stack.md | 3 +- .../v2.0/reference/cli/influx/help/_index.md | 3 +- .../v2.0/reference/cli/influx/org/_index.md | 3 +- .../v2.0/reference/cli/influx/ping/_index.md | 3 +- .../v2.0/reference/cli/influx/query/_index.md | 3 +- .../v2.0/reference/cli/influx/repl/_index.md | 3 +- .../reference/cli/influx/restore/index.md | 3 +- .../reference/cli/influx/secret/_index.md | 3 +- .../v2.0/reference/cli/influx/setup/_index.md | 3 +- .../reference/cli/influx/stacks/_index.md | 3 +- .../v2.0/reference/cli/influx/task/_index.md | 3 +- .../reference/cli/influx/telegrafs/_index.md | 3 +- .../reference/cli/influx/template/_index.md | 3 +- .../reference/cli/influx/transpile/_index.md | 3 +- .../v2.0/reference/cli/influx/user/_index.md | 3 +- .../v2.0/reference/cli/influx/v1/_index.md | 3 +- .../v2.0/reference/cli/influx/write/_index.md | 3 +- 59 files changed, 234 insertions(+), 169 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61865216d..14ae0a0b3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -51,7 +51,17 @@ You need a database that specializes in time series. +You need InfluxDB. ``` -### Page frontmatter +### Article headings +Use only h2-h6 headings in markdown content. +h1 headings act as the page title and are populated automatically from the `title` frontmatter. +h2-h6 headings act as section headings. + +### Image naming conventions +Save images using the following naming format: `project/version-context-description.png`. +For example, `influxdb/2-0-visualizations-line-graph.png` or `influxdb/2-0-tasks-add-new.png`. +Specify a version other than 2.0 only if the image is specific to that version. + +## Page frontmatter Every documentation page includes frontmatter which specifies information about the page. Frontmatter populates variables in page templates and the site's navigation menu. @@ -66,7 +76,7 @@ menu: parent: # Specifies a parent group and nests navigation items weight: # Determines sort order in both the nav tree and in article lists draft: # If true, will not render page on build -v2.x/tags: # Tags specific to each version (replace .x" with the appropriate minor version ) +product/v2.x/tags: # Tags specific to each version (replace product and .x" with the appropriate product and minor version ) related: # Creates links to specific internal and external content at the bottom of the page - /path/to/related/article - https://external-link.com, This is an external link @@ -81,7 +91,7 @@ canonical: # Path to canonical page, overrides auto-gen'd canonical URL v2: # Path to v2 equivalent page ``` -#### Title usage +### Title usage ##### `title` The `title` frontmatter populates each page's h1 header. @@ -108,10 +118,68 @@ Then 201-299 and so on. _**Note:** `_index.md` files should be weighted one level up from the other `.md` files in the same directory._ -### Article headings -Use only h2-h6 headings in markdown content. -h1 headings act as the page title and are populated automatically from the `title` frontmatter. -h2-h6 headings act as section headings. +### Related content +Use the `related` frontmatter to include links to specific articles at the bottom of an article. + +- If the page exists inside of this documentation, just include the path to the page. + It will automatically detect the title of the page. +- If the page exists inside of this documentation, but you want to customize the link text, + include the path to the page followed by a comma, and then the custom link text. + The path and custom text must be in that order and separated by a comma and a space. +- If the page exists outside of this documentation, include the full URL and a title for the link. + The link and title must be in that order and separated by a comma and a space. + +```yaml +related: + - /v2.0/write-data/quick-start + - /v2.0/write-data/quick-start, This is custom text for an internal link + - https://influxdata.com, This is an external link +``` + +### Canonical URLs +Search engines use canonical URLs to accurately rank pages with similar or identical content. +The `canonical` HTML meta tag identifies which page should be used as the source of truth. + +By default, canonical URLs are automatically generated for each page in the InfluxData +documentation using the latest version of the current product and the current path. + +Use the `canonical` frontmatter to override the auto-generated canonical URL. + +_**Note:** The `canonical` frontmatter supports the [`{{< latest >}}` shortcode](#latest-links)._ + +```yaml +canonical: /path/to/canonical/doc/ + +# OR + +canonical: /{{< latest "influxdb" "v2" >}}/path/to/canonical/doc/ +``` + +## v2 equivalent documentation +To display a notice on a 1.x page that links to an equivalent 2.0 page, +add the following frontmatter to the 1.x page: + +```yaml +v2: /influxdb/v2.0/get-started/ +``` + +### Cascade +To automatically apply frontmatter to a page and all of its children, use the +[`cascade` frontmatter](https://gohugo.io/content-management/front-matter/#front-matter-cascade) +built in into Hugo. + +```yaml +title: Example page +description: Example description +cascade: + layout: custom-layout +``` + +`cascade` applies the frontmatter to all children unless the child already includes +those frontmatter keys. Frontmaatter defined on the page overrides fronmattered +"cascaded" from a parent. + +## Shortcodes ### Notes and warnings Shortcodes are available for formatting notes and warnings in each article: @@ -135,13 +203,6 @@ Insert enterprise-specific markdown content here. {{% /enterprise %}} ``` -#### All content is Enterprise-specific -If all content in an article is Enterprise-specific, include `enterprise`in the `products` frontmatter. - -```yaml -products: [enterprise] -``` - #### Enterprise name The name used to refer to InfluxData's enterprise offering is subject to change. To facilitate easy updates in the future, use the `enterprise-name` shortcode @@ -175,13 +236,6 @@ Insert cloud-specific markdown content here. {{% /cloud %}} ``` -#### All content is cloud-specific -If all content in an article is cloud-specific, include `cloud` in the `products` frontmatter. - -```yaml -products: [cloud] -``` - #### InfluxDB Cloud name The name used to refer to InfluxData's cloud offering is subject to change. To facilitate easy updates in the future, use the `cloud-name` short-code when @@ -206,13 +260,6 @@ InfluxDB Cloud. Find more info [here][{{< cloud-link >}}] ``` -### InfluxDB OSS Content -If all content in an article is OSS-specific, include `oss` in the `products` frontmatter. - -```yaml -products: [oss] -``` - ### Latest links Each of the InfluxData projects have different "latest" versions. Use the `{{< latest >}}` shortcode to populate link paths with the latest version @@ -384,20 +431,6 @@ The following parameters are available: {{< keybind mac="⇧⌘P" linux="Ctrl+Shift+P" win="Ctrl+Shift+Alt+P" >}} ``` -### Related content -Use the `related` frontmatter to include links to specific articles at the bottom of an article. - -- If the page exists inside of this documentation, just include the path to the page. - It will automatically detect the title of the page. -- If the page exists outside of this documentation, include the full URL and a title for the link. - The link and title must be in that order and must be separated by a comma and a space. - -```yaml -related: - - /v2.0/write-data/quick-start - - https://influxdata.com, This is an external link -``` - ### High-resolution images In many cases, screenshots included in the docs are taken from high-resolution (retina) screens. Because of this, the actual pixel dimension is 2x larger than it needs to be and is rendered 2x bigger than it should be. @@ -690,44 +723,6 @@ menu: influxdb_2_0_ref: # ... ``` -### Image naming conventions -Save images using the following naming format: `project/version-context-description.png`. -For example, `influxdb/2-0-visualizations-line-graph.png` or `influxdb/2-0-tasks-add-new.png`. -Specify a version other than 2.0 only if the image is specific to that version. - -## InfluxDB API documentation -InfluxData uses [Redoc](https://github.com/Redocly/redoc) to generate the full -InfluxDB API documentation when documentation is deployed. -Redoc generates HTML documentation using the InfluxDB `swagger.yml`. -For more information about generating InfluxDB API documentation, see the -[API Documentation README](https://github.com/influxdata/docs-v2/tree/master/api-docs#readme). - -## Canonical URLs -Search engines use canonical URLs to accurately rank pages with similar or identical content. -The `canonical` HTML meta tag identifies which page should be used as the source of truth. - -By default, canonical URLs are automatically generated for each page in the InfluxData -documentation using the latest version of the current product and the current path. - -Use the `canonical` frontmatter to override the auto-generated canonical URL. - -_**Note:** The `canonical` frontmatter supports the [`{{< latest >}}` shortcode](#latest-links)._ - -```yaml -canonical: /path/to/canonical/doc/ - -# OR - -canonical: /{{< latest "influxdb" "v2" >}}/path/to/canonical/doc/ -``` - -## v2 equivalent documentation -To display a notice on a 1.x page that links to an equivalent 2.0 page, -add the following frontmatter to the 1.x page: - -```yaml -v2: /influxdb/v2.0/get-started/ -``` ## InfluxDB URLs When a user selects an InfluxDB product and region, example URLs in code blocks @@ -829,8 +824,14 @@ _This example assumes v2.0 is the most recent version and v2.1 is the new versio 8. Commit the changes and push the new branch to Github. - These changes lay the foundation for the new version. All other changes specific to the new version should be merged into this branch. Once the necessary changes are in place and the new version is released, merge the new branch into `master`. + +## InfluxDB API documentation +InfluxData uses [Redoc](https://github.com/Redocly/redoc) to generate the full +InfluxDB API documentation when documentation is deployed. +Redoc generates HTML documentation using the InfluxDB `swagger.yml`. +For more information about generating InfluxDB API documentation, see the +[API Documentation README](https://github.com/influxdata/docs-v2/tree/master/api-docs#readme). diff --git a/content/influxdb/cloud/reference/cli/influx/apply/_index.md b/content/influxdb/cloud/reference/cli/influx/apply/_index.md index 2721fbc1e..87ca9bd1c 100644 --- a/content/influxdb/cloud/reference/cli/influx/apply/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/apply/_index.md @@ -10,7 +10,8 @@ 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 + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/auth/_index.md b/content/influxdb/cloud/reference/cli/influx/auth/_index.md index 7df5cc324..e54610359 100644 --- a/content/influxdb/cloud/reference/cli/influx/auth/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/auth/_index.md @@ -9,7 +9,8 @@ weight: 101 influxdb/cloud/tags: [authentication] cascade: related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/backup/_index.md b/content/influxdb/cloud/reference/cli/influx/backup/_index.md index cf99e94e0..83bddbc86 100644 --- a/content/influxdb/cloud/reference/cli/influx/backup/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/backup/_index.md @@ -8,7 +8,8 @@ menu: weight: 101 influxdb/cloud/tags: [backup] related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{% note %}} diff --git a/content/influxdb/cloud/reference/cli/influx/bucket/_index.md b/content/influxdb/cloud/reference/cli/influx/bucket/_index.md index 9113b3f2e..07b56f64a 100644 --- a/content/influxdb/cloud/reference/cli/influx/bucket/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/bucket/_index.md @@ -10,7 +10,8 @@ influxdb/cloud/tags: [buckets] cascade: related: - /influxdb/cloud/organizations/buckets/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/bucket/create.md b/content/influxdb/cloud/reference/cli/influx/bucket/create.md index e78e7bdde..c4196b397 100644 --- a/content/influxdb/cloud/reference/cli/influx/bucket/create.md +++ b/content/influxdb/cloud/reference/cli/influx/bucket/create.md @@ -10,7 +10,8 @@ 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 + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/bucket/delete.md b/content/influxdb/cloud/reference/cli/influx/bucket/delete.md index b1bfa64b8..9d25a6af2 100644 --- a/content/influxdb/cloud/reference/cli/influx/bucket/delete.md +++ b/content/influxdb/cloud/reference/cli/influx/bucket/delete.md @@ -8,7 +8,8 @@ menu: weight: 201 related: - /influxdb/cloud/organizations/buckets/delete-bucket/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/completion/_index.md b/content/influxdb/cloud/reference/cli/influx/completion/_index.md index 4555ad980..833bda2f0 100644 --- a/content/influxdb/cloud/reference/cli/influx/completion/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/completion/_index.md @@ -10,7 +10,8 @@ menu: weight: 101 influxdb/cloud/tags: [cli, tools] related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/config/_index.md b/content/influxdb/cloud/reference/cli/influx/config/_index.md index f1bdca31a..8841aa665 100644 --- a/content/influxdb/cloud/reference/cli/influx/config/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/config/_index.md @@ -9,7 +9,8 @@ weight: 101 influxdb/cloud/tags: [config] cascade: related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/dashboards/_index.md b/content/influxdb/cloud/reference/cli/influx/dashboards/_index.md index c04463a4c..1a0bb071d 100644 --- a/content/influxdb/cloud/reference/cli/influx/dashboards/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/dashboards/_index.md @@ -9,7 +9,8 @@ menu: weight: 101 influxdb/cloud/tags: [telegraf] related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/delete/_index.md b/content/influxdb/cloud/reference/cli/influx/delete/_index.md index e606d1c87..4153fe835 100644 --- a/content/influxdb/cloud/reference/cli/influx/delete/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/delete/_index.md @@ -10,7 +10,8 @@ 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 + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/export/_index.md b/content/influxdb/cloud/reference/cli/influx/export/_index.md index 290d66ad9..759400ecf 100644 --- a/content/influxdb/cloud/reference/cli/influx/export/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/export/_index.md @@ -8,7 +8,8 @@ weight: 101 cascade: related: - /influxdb/cloud/influxdb-templates/create/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/help/_index.md b/content/influxdb/cloud/reference/cli/influx/help/_index.md index fe41c7b5a..9d7a4509e 100644 --- a/content/influxdb/cloud/reference/cli/influx/help/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/help/_index.md @@ -7,7 +7,8 @@ menu: parent: influx weight: 101 related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/org/_index.md b/content/influxdb/cloud/reference/cli/influx/org/_index.md index 71f9036a3..ef948752c 100644 --- a/content/influxdb/cloud/reference/cli/influx/org/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/org/_index.md @@ -9,7 +9,8 @@ weight: 101 influxdb/cloud/tags: [organizations] cascade: related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/ping/_index.md b/content/influxdb/cloud/reference/cli/influx/ping/_index.md index 9aad124f3..a2311a6d1 100644 --- a/content/influxdb/cloud/reference/cli/influx/ping/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/ping/_index.md @@ -10,7 +10,8 @@ menu: weight: 101 influxdb/cloud/tags: [ping, health] related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/query/_index.md b/content/influxdb/cloud/reference/cli/influx/query/_index.md index 48fe306eb..1df604a2c 100644 --- a/content/influxdb/cloud/reference/cli/influx/query/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/query/_index.md @@ -11,7 +11,8 @@ weight: 101 influxdb/cloud/tags: [query] related: - /influxdb/cloud/query-data/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/restore/index.md b/content/influxdb/cloud/reference/cli/influx/restore/index.md index 51f9b8e28..6714246b0 100644 --- a/content/influxdb/cloud/reference/cli/influx/restore/index.md +++ b/content/influxdb/cloud/reference/cli/influx/restore/index.md @@ -7,7 +7,8 @@ menu: parent: influx weight: 101 related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{% note %}} diff --git a/content/influxdb/cloud/reference/cli/influx/secret/_index.md b/content/influxdb/cloud/reference/cli/influx/secret/_index.md index 64385b026..2e5c1110b 100644 --- a/content/influxdb/cloud/reference/cli/influx/secret/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/secret/_index.md @@ -10,7 +10,8 @@ influxdb/cloud/tags: [secrets] cascade: related: - /influxdb/cloud/security/secrets/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/setup/_index.md b/content/influxdb/cloud/reference/cli/influx/setup/_index.md index 6025cc4ee..4c9ed368b 100644 --- a/content/influxdb/cloud/reference/cli/influx/setup/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/setup/_index.md @@ -10,7 +10,8 @@ menu: weight: 101 influxdb/cloud/tags: [get-started] related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/ --- diff --git a/content/influxdb/cloud/reference/cli/influx/stacks/_index.md b/content/influxdb/cloud/reference/cli/influx/stacks/_index.md index 432b4f03c..c80533c78 100644 --- a/content/influxdb/cloud/reference/cli/influx/stacks/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/stacks/_index.md @@ -9,9 +9,11 @@ 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 +cascade: + related: + - /influxdb/cloud/influxdb-templates/stacks/ + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/task/_index.md b/content/influxdb/cloud/reference/cli/influx/task/_index.md index acba0ae84..546b5e1ed 100644 --- a/content/influxdb/cloud/reference/cli/influx/task/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/task/_index.md @@ -10,7 +10,8 @@ influxdb/cloud/tags: [tasks] cascade: related: - /influxdb/cloud/process-data/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/telegrafs/_index.md b/content/influxdb/cloud/reference/cli/influx/telegrafs/_index.md index 37b10fcab..0a74ca3c7 100644 --- a/content/influxdb/cloud/reference/cli/influx/telegrafs/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/telegrafs/_index.md @@ -12,7 +12,8 @@ influxdb/cloud/tags: [telegraf] cascade: related: - /influxdb/cloud/telegraf-configs/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/template/_index.md b/content/influxdb/cloud/reference/cli/influx/template/_index.md index 80a1f35b2..31e267cb1 100644 --- a/content/influxdb/cloud/reference/cli/influx/template/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/template/_index.md @@ -10,7 +10,8 @@ influxdb/cloud/tags: [templates] cascade: related: - /influxdb/cloud/influxdb-templates/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/transpile/_index.md b/content/influxdb/cloud/reference/cli/influx/transpile/_index.md index 43e167855..f42930f93 100644 --- a/content/influxdb/cloud/reference/cli/influx/transpile/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/transpile/_index.md @@ -9,7 +9,8 @@ menu: weight: 101 influxdb/cloud/tags: [influxql, flux] related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/user/_index.md b/content/influxdb/cloud/reference/cli/influx/user/_index.md index 1dd08d6ef..05b27e1cd 100644 --- a/content/influxdb/cloud/reference/cli/influx/user/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/user/_index.md @@ -9,7 +9,8 @@ weight: 101 influxdb/cloud/tags: [users] cascade: related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/ --- diff --git a/content/influxdb/cloud/reference/cli/influx/user/password.md b/content/influxdb/cloud/reference/cli/influx/user/password.md index 5d8873423..3ec63da83 100644 --- a/content/influxdb/cloud/reference/cli/influx/user/password.md +++ b/content/influxdb/cloud/reference/cli/influx/user/password.md @@ -8,7 +8,8 @@ menu: weight: 201 related: - /influxdb/cloud/account-management/change-password/ - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/password/ --- diff --git a/content/influxdb/cloud/reference/cli/influx/v1/_index.md b/content/influxdb/cloud/reference/cli/influx/v1/_index.md index 03af39e52..d417b6dd5 100644 --- a/content/influxdb/cloud/reference/cli/influx/v1/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/v1/_index.md @@ -9,7 +9,8 @@ menu: weight: 101 cascade: related: - - /influxdb/cloud/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/cloud/reference/cli/influx/write/_index.md b/content/influxdb/cloud/reference/cli/influx/write/_index.md index 1539c4695..38641db99 100644 --- a/content/influxdb/cloud/reference/cli/influx/write/_index.md +++ b/content/influxdb/cloud/reference/cli/influx/write/_index.md @@ -16,7 +16,8 @@ cascade: - /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 + - /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{< duplicate-oss >}} diff --git a/content/influxdb/v2.0/reference/cli/influx/_index.md b/content/influxdb/v2.0/reference/cli/influx/_index.md index 3c1bc17a8..f1028427a 100644 --- a/content/influxdb/v2.0/reference/cli/influx/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/_index.md @@ -22,6 +22,26 @@ influx [flags] influx [command] ``` +### Provide required authentication credentials +To avoid having to pass your InfluxDB **host**, **authentication token**, and **organization** +with each command, store them in an `influx` CLI configuration (config). +`influx` commands that require these credentials automatically retrieve these +credentials from the active config. + +Use the [`influx config create` command](/influxdb/v2.0/reference/cli/influx/config/create/) +to create an `influx` CLI config and set it as active: + +```sh +influx config create --config-name \ + --host-url http://localhost:8086 \ + --org \ + --token \ - --host-url http://localhost:8086 \ - --org \ - --token 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 + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- {{% warn %}} diff --git a/content/influxdb/v2.0/reference/cli/influx/restore/index.md b/content/influxdb/v2.0/reference/cli/influx/restore/index.md index 8e49d98d0..71c21af98 100644 --- a/content/influxdb/v2.0/reference/cli/influx/restore/index.md +++ b/content/influxdb/v2.0/reference/cli/influx/restore/index.md @@ -10,7 +10,8 @@ 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 + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- The `influx restore` command restores backup data and metadata from an InfluxDB backup directory. diff --git a/content/influxdb/v2.0/reference/cli/influx/secret/_index.md b/content/influxdb/v2.0/reference/cli/influx/secret/_index.md index e6c48f3df..c3db5672e 100644 --- a/content/influxdb/v2.0/reference/cli/influx/secret/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/secret/_index.md @@ -10,7 +10,8 @@ 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 + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- The `influx secret` command manages [secrets](/influxdb/v2.0/reference/glossary/#secret). diff --git a/content/influxdb/v2.0/reference/cli/influx/setup/_index.md b/content/influxdb/v2.0/reference/cli/influx/setup/_index.md index 188fa64a4..25e5f5c55 100644 --- a/content/influxdb/v2.0/reference/cli/influx/setup/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/setup/_index.md @@ -10,7 +10,8 @@ menu: weight: 101 influxdb/v2.0/tags: [get-started] related: - - /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/ --- diff --git a/content/influxdb/v2.0/reference/cli/influx/stacks/_index.md b/content/influxdb/v2.0/reference/cli/influx/stacks/_index.md index ff074c0bf..4beb76844 100644 --- a/content/influxdb/v2.0/reference/cli/influx/stacks/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/stacks/_index.md @@ -14,7 +14,8 @@ 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 + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- The `influx stacks` command and its subcommands list and manage InfluxDB stacks diff --git a/content/influxdb/v2.0/reference/cli/influx/task/_index.md b/content/influxdb/v2.0/reference/cli/influx/task/_index.md index 64999a216..118d83e43 100644 --- a/content/influxdb/v2.0/reference/cli/influx/task/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/task/_index.md @@ -10,7 +10,8 @@ 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 + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- The `influx task` command and its subcommands manage tasks in InfluxDB. diff --git a/content/influxdb/v2.0/reference/cli/influx/telegrafs/_index.md b/content/influxdb/v2.0/reference/cli/influx/telegrafs/_index.md index e243d6711..4a777a40a 100644 --- a/content/influxdb/v2.0/reference/cli/influx/telegrafs/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/telegrafs/_index.md @@ -12,7 +12,8 @@ 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 + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- The `influx telegrafs` command lists Telegraf configurations. diff --git a/content/influxdb/v2.0/reference/cli/influx/template/_index.md b/content/influxdb/v2.0/reference/cli/influx/template/_index.md index afca97f64..8152b5934 100644 --- a/content/influxdb/v2.0/reference/cli/influx/template/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/template/_index.md @@ -12,7 +12,8 @@ aliases: cascade: related: - /influxdb/v2.0/influxdb-templates/ - - /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- The `influx template` command summarizes the specified InfluxDB template. diff --git a/content/influxdb/v2.0/reference/cli/influx/transpile/_index.md b/content/influxdb/v2.0/reference/cli/influx/transpile/_index.md index 57f590344..be611dbaf 100644 --- a/content/influxdb/v2.0/reference/cli/influx/transpile/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/transpile/_index.md @@ -9,7 +9,8 @@ menu: weight: 101 influxdb/v2.0/tags: [influxql, flux] related: - - /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- The `influx transpile` command transpiles an InfluxQL query to Flux source code. diff --git a/content/influxdb/v2.0/reference/cli/influx/user/_index.md b/content/influxdb/v2.0/reference/cli/influx/user/_index.md index a5cc44286..ba1a5d88e 100644 --- a/content/influxdb/v2.0/reference/cli/influx/user/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/user/_index.md @@ -10,7 +10,8 @@ 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 + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/ --- diff --git a/content/influxdb/v2.0/reference/cli/influx/v1/_index.md b/content/influxdb/v2.0/reference/cli/influx/v1/_index.md index 6bcc59c44..7b56b0213 100644 --- a/content/influxdb/v2.0/reference/cli/influx/v1/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/v1/_index.md @@ -9,7 +9,8 @@ menu: weight: 101 cascade: related: - - /influxdb/v2.0/reference/cli/influx/#patterns-and-conventions, influx CLI patterns and conventions + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag 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. diff --git a/content/influxdb/v2.0/reference/cli/influx/write/_index.md b/content/influxdb/v2.0/reference/cli/influx/write/_index.md index 8c6bd7f64..eaf3adab8 100644 --- a/content/influxdb/v2.0/reference/cli/influx/write/_index.md +++ b/content/influxdb/v2.0/reference/cli/influx/write/_index.md @@ -16,7 +16,8 @@ cascade: - /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 + - /influxdb/v2.0/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials + - /influxdb/v2.0/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions --- The `influx write` command writes data to InfluxDB via stdin or from a specified file.