From 34c76d6ba4d9de86647b3a1be14add906d9bd12b Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 15 Jan 2020 15:42:49 -0700 Subject: [PATCH] changes to address PR feedback --- content/v2.0/organizations/buckets/create-bucket.md | 2 +- content/v2.0/organizations/buckets/delete-bucket.md | 2 +- content/v2.0/organizations/buckets/update-bucket.md | 4 ++-- content/v2.0/organizations/create-org.md | 2 +- content/v2.0/organizations/delete-org.md | 2 +- content/v2.0/organizations/members/remove-member.md | 2 +- content/v2.0/organizations/members/view-members.md | 2 +- content/v2.0/organizations/update-org.md | 2 +- content/v2.0/process-data/manage-tasks/create-task.md | 2 +- content/v2.0/process-data/manage-tasks/delete-task.md | 2 +- content/v2.0/process-data/manage-tasks/update-task.md | 4 ++-- content/v2.0/reference/cli/influx/user/password.md | 10 +++++----- content/v2.0/security/tokens/create-token.md | 2 +- content/v2.0/security/tokens/delete-token.md | 2 +- content/v2.0/users/change-password.md | 9 +++------ content/v2.0/users/create-user.md | 4 ++-- content/v2.0/users/delete-user.md | 2 +- content/v2.0/users/update-user.md | 2 +- 18 files changed, 27 insertions(+), 30 deletions(-) diff --git a/content/v2.0/organizations/buckets/create-bucket.md b/content/v2.0/organizations/buckets/create-bucket.md index 6616e838a..87790d539 100644 --- a/content/v2.0/organizations/buckets/create-bucket.md +++ b/content/v2.0/organizations/buckets/create-bucket.md @@ -36,7 +36,7 @@ to create a new bucket. A bucket requires the following: - A retention period in nanoseconds ```sh -# Pattern +# Syntax influx bucket create -n -o -r # Example diff --git a/content/v2.0/organizations/buckets/delete-bucket.md b/content/v2.0/organizations/buckets/delete-bucket.md index 8c25b4948..db45745fa 100644 --- a/content/v2.0/organizations/buckets/delete-bucket.md +++ b/content/v2.0/organizations/buckets/delete-bucket.md @@ -31,7 +31,7 @@ to delete a bucket. Deleting a bucket requires the following: - The name or ID of the organization to which the bucket belongs ```sh -# Pattern +# Syntax influx bucket delete -i # Example diff --git a/content/v2.0/organizations/buckets/update-bucket.md b/content/v2.0/organizations/buckets/update-bucket.md index 0bbfef353..15cef3f05 100644 --- a/content/v2.0/organizations/buckets/update-bucket.md +++ b/content/v2.0/organizations/buckets/update-bucket.md @@ -54,7 +54,7 @@ to update a bucket. Updating a bucket requires the following: ##### Update the name of a bucket ```sh -# Pattern +# Syntax influx bucket update -i -o -n # Example @@ -63,7 +63,7 @@ influx bucket update -i 034ad714fdd6f000 -o my-org -n my-new-bucket ##### Update a bucket's retention policy ```sh -# Pattern +# Syntax influx bucket update -i -o -r # Example diff --git a/content/v2.0/organizations/create-org.md b/content/v2.0/organizations/create-org.md index 96f96973f..b4131e978 100644 --- a/content/v2.0/organizations/create-org.md +++ b/content/v2.0/organizations/create-org.md @@ -33,7 +33,7 @@ to create a new organization. A new organization requires the following: - A name for the organization ```sh -# Pattern +# Syntax influx org create -n # Example diff --git a/content/v2.0/organizations/delete-org.md b/content/v2.0/organizations/delete-org.md index 75f574b66..7776c98dd 100644 --- a/content/v2.0/organizations/delete-org.md +++ b/content/v2.0/organizations/delete-org.md @@ -32,7 +32,7 @@ to delete an organization. Deleting an organization requires the following: - The organization ID _(provided in the output of `influx org find`)_ ```sh -# Pattern +# Syntax influx org delete -i # Example diff --git a/content/v2.0/organizations/members/remove-member.md b/content/v2.0/organizations/members/remove-member.md index 87fa6b0f3..2e74f76d0 100644 --- a/content/v2.0/organizations/members/remove-member.md +++ b/content/v2.0/organizations/members/remove-member.md @@ -37,7 +37,7 @@ to remove a member from an organization. Removing a member requires the followin - The member ID _(provided in the output of [`influx org members list`](/v2.0/reference/cli/influx/org/members/list/))_ ```sh -# Pattern +# Syntax influx org members remove -o -i # Example diff --git a/content/v2.0/organizations/members/view-members.md b/content/v2.0/organizations/members/view-members.md index def11ca31..6752a8ea1 100644 --- a/content/v2.0/organizations/members/view-members.md +++ b/content/v2.0/organizations/members/view-members.md @@ -29,7 +29,7 @@ to list members of an organization. Listing an organization's members requires t - The name or ID of the organization ```sh -# Pattern +# Syntax influx org members list -n # Example diff --git a/content/v2.0/organizations/update-org.md b/content/v2.0/organizations/update-org.md index 6b3a2a8c6..2c3e14f11 100644 --- a/content/v2.0/organizations/update-org.md +++ b/content/v2.0/organizations/update-org.md @@ -42,7 +42,7 @@ to update an organization. Updating an organization requires the following: ##### Update the name of a organization ```sh -# Pattern +# Syntax influx org update -i -n # Example diff --git a/content/v2.0/process-data/manage-tasks/create-task.md b/content/v2.0/process-data/manage-tasks/create-task.md index 270a0d1c2..dae3e5f1a 100644 --- a/content/v2.0/process-data/manage-tasks/create-task.md +++ b/content/v2.0/process-data/manage-tasks/create-task.md @@ -91,7 +91,7 @@ It accepts either a file path or raw Flux. ###### Create a task using a file ```sh -# Pattern +# Syntax influx task create --org @ # Example diff --git a/content/v2.0/process-data/manage-tasks/delete-task.md b/content/v2.0/process-data/manage-tasks/delete-task.md index eab5c0a54..1ae4dbd05 100644 --- a/content/v2.0/process-data/manage-tasks/delete-task.md +++ b/content/v2.0/process-data/manage-tasks/delete-task.md @@ -28,7 +28,7 @@ Use the `influx task delete` command to delete a task. _This command requires a task ID, which is available in the output of `influx task find`._ ```sh -# Pattern +# Syntax influx task delete -i # Example diff --git a/content/v2.0/process-data/manage-tasks/update-task.md b/content/v2.0/process-data/manage-tasks/update-task.md index 5e152b355..0a2ae7a54 100644 --- a/content/v2.0/process-data/manage-tasks/update-task.md +++ b/content/v2.0/process-data/manage-tasks/update-task.md @@ -47,7 +47,7 @@ Modified [task options](/v2.0/process-data/task-options) defined in the Flux script are also updated. ```sh -# Pattern +# Syntax influx task update -i @/path/to/updated-task-script # Example @@ -61,7 +61,7 @@ command with the `--status` flag. _Possible arguments of the `--status` flag are `active` or `inactive`._ ```sh -# Pattern +# Syntax influx task update -i --status < active | inactive > # Example diff --git a/content/v2.0/reference/cli/influx/user/password.md b/content/v2.0/reference/cli/influx/user/password.md index 1fc7ff448..601b9bae3 100644 --- a/content/v2.0/reference/cli/influx/user/password.md +++ b/content/v2.0/reference/cli/influx/user/password.md @@ -18,10 +18,10 @@ influx user password [flags] ``` ## Flags -| Flag | Description | Input type | -|:---- |:----------- |:----------: | -| `-h`, `--help` | Help for `find` | | -| `-i`, `--id` | The user ID | string | -| `-n`, `--name` | The username | string | +| Flag | Description | Input type | +|:---- |:----------- |:----------: | +| `-h`, `--help` | Help for `password` | | +| `-i`, `--id` | The user ID | string | +| `-n`, `--name` | The username | string | {{% influx-cli-global-flags %}} diff --git a/content/v2.0/security/tokens/create-token.md b/content/v2.0/security/tokens/create-token.md index 0352c5a6c..683e830dd 100644 --- a/content/v2.0/security/tokens/create-token.md +++ b/content/v2.0/security/tokens/create-token.md @@ -35,7 +35,7 @@ Include flags with the command to grant specific permissions to the token. See the [available flags](/v2.0/reference/cli/influx/auth/create#flags). ```sh -# Pattern +# Syntax influx auth create -o [permission-flags] # Example diff --git a/content/v2.0/security/tokens/delete-token.md b/content/v2.0/security/tokens/delete-token.md index b96e308af..e7ea5fb89 100644 --- a/content/v2.0/security/tokens/delete-token.md +++ b/content/v2.0/security/tokens/delete-token.md @@ -32,7 +32,7 @@ to delete a token. _This command requires an auth ID, which is available in the output of `influx auth find`._ ```sh -# Pattern +# Syntax influx auth delete -i # Example diff --git a/content/v2.0/users/change-password.md b/content/v2.0/users/change-password.md index 853e87ffc..374f6554f 100644 --- a/content/v2.0/users/change-password.md +++ b/content/v2.0/users/change-password.md @@ -1,7 +1,7 @@ --- title: Change your password seotitle: Change your password in InfluxDB -description: Change your password in InfluxDB using the InfluxDB UI or the influx CLI. +description: Change your password in InfluxDB using the influx CLI. menu: v2_0: name: Change your password @@ -9,10 +9,7 @@ menu: weight: 105 --- -Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI) -to update your password. - -## Change your password in the InfluxDB UI +Use `influx` command line interface (CLI) to update your password. {{% note %}} User passwords cannot be updated in the InfluxDB UI. @@ -28,7 +25,7 @@ to update a password for a user. To update a password, you need the following: ##### Update a password ```sh -# Pattern +# Syntax influx user password -n # Example diff --git a/content/v2.0/users/create-user.md b/content/v2.0/users/create-user.md index 2343be7ad..04bfbc708 100644 --- a/content/v2.0/users/create-user.md +++ b/content/v2.0/users/create-user.md @@ -28,7 +28,7 @@ and include the following: [`influx org find`](/v2.0/reference/cli/influx/org/find/))_ ```sh -# Pattern +# Syntax influx user create -n -o # Example @@ -45,7 +45,7 @@ include a password and organization ID with the `influx user create` command. - Password ```sh -# Pattern +# Syntax influx user create -n -p -o # Example diff --git a/content/v2.0/users/delete-user.md b/content/v2.0/users/delete-user.md index 8aad48dc4..ea05e6b81 100644 --- a/content/v2.0/users/delete-user.md +++ b/content/v2.0/users/delete-user.md @@ -32,7 +32,7 @@ to delete a user. Deleting a user requires the following: - The user ID _(provided in the output of `influx user find`)_ ```sh -# Pattern +# Syntax influx user delete -i # Example diff --git a/content/v2.0/users/update-user.md b/content/v2.0/users/update-user.md index 2d696b099..83927a7f9 100644 --- a/content/v2.0/users/update-user.md +++ b/content/v2.0/users/update-user.md @@ -27,7 +27,7 @@ to update a user. Updating a user requires the following: ##### Update the name of a user ```sh -# Pattern +# Syntax influx user update -i -n # Example