From 20b76dea7678c7e014a042023f85f032cf285c9f Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Fri, 16 Aug 2024 07:09:01 -0600 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Jason Stirnaman --- .../cloud-dedicated/reference/cli/influxctl/auth/_index.md | 4 ++-- .../cloud-dedicated/reference/cli/influxctl/auth/login.md | 2 +- .../cloud-dedicated/reference/cli/influxctl/auth/logout.md | 6 ++++-- .../influxdb/clustered/reference/cli/influxctl/_index.md | 2 +- .../clustered/reference/cli/influxctl/auth/_index.md | 2 +- .../clustered/reference/cli/influxctl/auth/login.md | 7 ++----- .../clustered/reference/cli/influxctl/auth/logout.md | 7 ++++--- 7 files changed, 15 insertions(+), 15 deletions(-) diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/_index.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/_index.md index 0c87fb7e0..a0391815e 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/_index.md +++ b/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/_index.md @@ -22,8 +22,8 @@ influxctl auth [subcommand] [subcommand options] [arguments...] | Subcommand | Description | | :----------------------------------------------------------------------- | :------------------------------ | -| [login](/influxdb/cloud-dedicated/reference/cli/influxctl/auth/login/) | Log in using InfluxData Auth0 | -| [logout](/influxdb/cloud-dedicated/reference/cli/influxctl/auth/logout/) | Remove local authorization tokens to log out of an InfluxDB cluster | +| [login](/influxdb/cloud-dedicated/reference/cli/influxctl/auth/login/) | Log in to an InfluxDB cluster using InfluxData Auth0 | +| [logout](/influxdb/cloud-dedicated/reference/cli/influxctl/auth/logout/) | Log out of an InfluxDB cluster; remove local authorization tokens | | help, h | Output command help | ## Flags diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/login.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/login.md index ea3f60a0d..f457cd7ee 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/login.md +++ b/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/login.md @@ -9,7 +9,7 @@ menu: weight: 301 --- -The `influxctl auth login` command lets a user log in to an {{< product-name >}} +The `influxctl auth login` command lets a user log in to an {{< product-name omit="Clustered" >}} cluster using InfluxData Auth0. ## Usage diff --git a/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/logout.md b/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/logout.md index 28f47a6c1..00ef24e34 100644 --- a/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/logout.md +++ b/content/influxdb/cloud-dedicated/reference/cli/influxctl/auth/logout.md @@ -1,14 +1,16 @@ --- title: influxctl auth logout description: > - The `influxctl auth logout` command logs out a user by removing local authorization tokens + The `influxctl auth logout` command lets a user logout of an InfluxDB + cluster; removes the user's local authorization tokens. menu: influxdb_cloud_dedicated: parent: influxctl auth weight: 301 --- -The `influxctl auth logout` command logs out a user by removing local authorization tokens. +The `influxctl auth logout` command lets a user logout of an {{< product-name omit="Clustered" >}} +cluster; removes the user's local authorization tokens. ## Usage diff --git a/content/influxdb/clustered/reference/cli/influxctl/_index.md b/content/influxdb/clustered/reference/cli/influxctl/_index.md index e4ab6b575..a7c0bc8ee 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/_index.md +++ b/content/influxdb/clustered/reference/cli/influxctl/_index.md @@ -32,7 +32,7 @@ influxctl [flags] [command] | Command | Description | | :-------------------------------------------------------------------- | :------------------------------------- | -| [auth](/influxdb/clustered/reference/cli/influxctl/auth/) | Login or logout of InfluxDB v3 | +| [auth](/influxdb/clustered/reference/cli/influxctl/auth/) | Log in to or log out of InfluxDB v3 | | [cluster](/influxdb/clustered/reference/cli/influxctl/cluster/) | List InfluxDB v3 cluster information | | [database](/influxdb/clustered/reference/cli/influxctl/database/) | Manage InfluxDB v3 databases | | [help](/influxdb/clustered/reference/cli/influxctl/help/) | Output `influxctl` help information | diff --git a/content/influxdb/clustered/reference/cli/influxctl/auth/_index.md b/content/influxdb/clustered/reference/cli/influxctl/auth/_index.md index 618ac65d6..235073f95 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/auth/_index.md +++ b/content/influxdb/clustered/reference/cli/influxctl/auth/_index.md @@ -22,7 +22,7 @@ influxctl auth [subcommand] [subcommand options] [arguments...] | Subcommand | Description | | :----------------------------------------------------------------- | :------------------------------ | -| [login](/influxdb/clustered/reference/cli/influxctl/auth/login/) | Login with InfluxDB Clustered identity provider | +| [login](/influxdb/clustered/reference/cli/influxctl/auth/login/) | Log in to an InfluxDB cluster using the cluster's identity provider | | [logout](/influxdb/clustered/reference/cli/influxctl/auth/logout/) | Remove local tokens | | help, h | Output command help | diff --git a/content/influxdb/clustered/reference/cli/influxctl/auth/login.md b/content/influxdb/clustered/reference/cli/influxctl/auth/login.md index 3d0ce0dd9..a0a6a068c 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/auth/login.md +++ b/content/influxdb/clustered/reference/cli/influxctl/auth/login.md @@ -9,11 +9,8 @@ menu: weight: 301 --- -The `influxctl auth login` command logins with InfluxData Auth0 or InfluxDB -Clustered identity provider -The `influxctl auth login` command lets a user log in to an -{{< product-name omit="Clustered" >}} cluster using the cluster's configured -identity provider. +The `influxctl auth login` command lets a user log in to an {{< product-name omit="Clustered" >}} +cluster using the cluster's configured identity provider. ## Usage ```sh diff --git a/content/influxdb/clustered/reference/cli/influxctl/auth/logout.md b/content/influxdb/clustered/reference/cli/influxctl/auth/logout.md index 9ea73ee9d..8e12c0643 100644 --- a/content/influxdb/clustered/reference/cli/influxctl/auth/logout.md +++ b/content/influxdb/clustered/reference/cli/influxctl/auth/logout.md @@ -1,15 +1,16 @@ --- title: influxctl auth logout description: > - The `influxctl auth logout` command removes local tokens + The `influxctl auth logout` command lets a user logout of an InfluxDB + cluster; removes the user's local authorization tokens. menu: influxdb_clustered: parent: influxctl auth weight: 301 --- -The `influxctl auth logout` command removes local tokens - +The `influxctl auth logout` command lets a user logout of an {{< product-name omit="Clustered" >}} +cluster; removes the user's local authorization tokens. ## Usage ```sh