Skip to content

fix: dedicated docs adjustments #6562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 21, 2025
Merged

fix: dedicated docs adjustments #6562

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
00f3411
docs: fix dedicated admin ui doc adjustments
wdoconnell Nov 21, 2025
e1511b0
merge identity version under one heading
wdoconnell Nov 21, 2025
f63c5ac
docs: fix links in one location shortcode does not work
wdoconnell Nov 21, 2025
8a4283d
chore: remove extra space from editor in admin ui access layout short…
wdoconnell Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions content/influxdb3/cloud-dedicated/admin/account/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,14 @@ influxdb3/cloud-dedicated/tags: [clusters]
Use the Admin UI for {{% product-name %}} to view information for your {{% product-name omit="InfluxDB " %}} account.
Your {{% product-name %}} account is a collection of {{% product-name omit="Clustered "%}} clusters and associated resources.

- [Access and Navigate the Admin UI](#access-and-navigate-the-admin-ui)
- [Access and navigate the Admin UI](#access-and-navigate-the-admin-ui)
Copy link
Contributor Author

@wdoconnell wdoconnell Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Use same capitalization as other headings.

- [Account and cluster management](#account-and-cluster-management)
- [Get help and support](#get-help-and-support)

## Access and Navigate the Admin UI
## Access and navigate the Admin UI

{{< admin-ui-access >}}
Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com).
Copy link
Contributor Author

@wdoconnell wdoconnell Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For some reason, this is the one place in the documentation where the shortcode template doesn't work: it renders the text of the link without the actual link content. I was not able to determine root cause, so I have recommended simply not using the shortcode under this heading.

Screenshot 2025-11-21 at 12 21 40 PM

If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).

The Admin UI features a collapsible sidebar navigation that provides quick access to all administrative functions:

Expand Down
4 changes: 2 additions & 2 deletions content/influxdb3/cloud-dedicated/admin/databases/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,10 @@ You can create a database with an optional retention period and custom partition
3. In the cluster list, find and click the cluster you want to create a database in. You
can sort on column headers or use the **Search** field to find a specific cluster.

4. Click the **New Database** button above the database list.
4. Click the **New Database** button above the database list.
The **Create Database** dialog displays.

<img src="/img/influxdb3/cloud-dedicated-admin-ui-create-database.png" alt="Create database dialog" />
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-create-database.png" alt="Create database dialog" />}}
Copy link
Contributor Author

@wdoconnell wdoconnell Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Use correct templating instead of img tag. No visual impact.


5. In the **Create Database** dialog, provide the following information:
- **Database name**: The name of the database to create. See [Database naming restrictions](#database-naming-restrictions).
Expand Down
11 changes: 6 additions & 5 deletions content/influxdb3/cloud-dedicated/admin/databases/delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,14 @@ managing databases.
</pre>
2. Use the credentials provided by InfluxData to log into the Admin UI.
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
3. In the cluster list, find the cluster you want to create a database in. You
can sort on column headers or use the **Search** field to find a specific cluster.
4. Click the options button (three vertical dots) to the right of the token you want to revoke.
3. In the database list, find the database you want to delete. You
can sort on column headers or use the **Search** field to find a specific database.
4. Click the options button (three vertical dots) to the right of the database you want to delete.
The options menu displays.
5. In the options menu, click **Delete Database**. The **Delete Database** dialog displays.
5. In the options menu, click **Delete Database**. The **Delete Database** dialog displays.
6. In the **Delete Database** dialog, check the box to confirm that you "understand the risk of this action".
7. Click the **Delete Database** button to delete the database.
7. In the **Enter Database Name to Delete** field, type the name of the database to confirm deletion.
Copy link
Contributor Author

@wdoconnell wdoconnell Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Substantive change here is just to add an instruction re: user must re-enter db name they wish to delete.

8. Click the **Delete Database** button to delete the database.

{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-delete-database.png" alt="Create database dialog" />}}
{{% /tab-content %}}
Expand Down
4 changes: 2 additions & 2 deletions content/influxdb3/cloud-dedicated/admin/identify-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ description: Learn how to identify your InfluxDB Cloud Dedicated cluster through
menu:
influxdb3_cloud_dedicated:
name: Identify version
parent: Administer InfluxDB
weight: 10
parent: Administer InfluxDB Cloud
Copy link
Contributor Author

@wdoconnell wdoconnell Nov 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this portion of the documentation the section labeled Administer InfluxDB is Administer InfluxDB Cloud. This has left the 'identify version' subheading orphaned under its own heading.

Before Fix:
Screenshot 2025-11-21 at 12 26 00 PM

After Fix:
Screenshot 2025-11-21 at 12 26 13 PM

weight: 1
source: /shared/identify-version.md
related:
- /influxdb3/cloud-dedicated/get-started/
Expand Down
4 changes: 2 additions & 2 deletions content/influxdb3/cloud-dedicated/admin/tokens/database/list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Use the Admin UI, the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
to list database tokens in your {{< product-name omit=" Clustered" >}} cluster.

[List database tokens](#list-database-tokens)
[Retrieve a database token by ID](#retrieve-a-database-token-by-id)
- [List database tokens](#list-database-tokens)
- [Retrieve a database token by ID](#retrieve-a-database-token-by-id)

## List database tokens

Expand Down
11 changes: 6 additions & 5 deletions content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,15 +59,16 @@ Administrators can use this portal to:
{{< admin-ui-access >}}

The Database Tokens portal displays the [list of database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/list/) associated with the cluster.
Use the sort and filter options above the list to find a specific token.
7. Click the **Options** button (three vertical dots) to the right of the token you want to revoke.
8. In the options menu, click **Revoke Token**.
Use the sort and filter options above the list to find a specific token.

1. Click the **Options** button (three vertical dots) to the right of the token you want to revoke.
Copy link
Contributor Author

@wdoconnell wdoconnell Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These numbers needed to be fixed after the text was updated.

2. In the options menu, click **Revoke Token**.
The **Revoke Database Token** dialog displays.

{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-revoke-database-token.png" alt="Revoke database token dialog" />}}

9. Check the box to confirm that you understand the risk.
10. Click the **Revoke Token** button.
3. Check the box to confirm that you understand the risk.
4. Click the **Revoke Token** button.
The token is revoked and filtered from the list of active tokens.
{{% /tab-content %}}
{{% tab-content %}}
Expand Down
11 changes: 6 additions & 5 deletions content/influxdb3/cloud-dedicated/admin/tokens/database/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,16 +77,17 @@ Through this portal, administrators can edit a token's permissions to:
{{< admin-ui-access >}}

The Database Tokens portal displays the [list of database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/list/) associated with the cluster.
Use the sort and filter options above the list to find a specific token.
7. Click the **Options** button (three vertical dots) to the right of the token you want to edit.

Use the sort and filter options above the list to find a specific token.

1. Click the **Options** button (three vertical dots) to the right of the token you want to edit.
Copy link
Contributor Author

@wdoconnell wdoconnell Nov 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same nit: update ordinal numbers. Also fixes issue where image link was displayed over image.


{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-database-token-options-menu.png" alt="Database token option menu" />}}

8. Click **Edit Token** in the dropdown menu. The **Edit Database Token** dialog displays.
2. Click **Edit Token** in the dropdown menu. The **Edit Database Token** dialog displays.

{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-edit-database-token.png" alt="Edit Database Token dialog" />}}

9. In the **Edit Database Token** dialog, you can edit the token's **Description** and permissions.
3. In the **Edit Database Token** dialog, you can edit the token's **Description** and permissions.

### Edit token permissions

Expand Down
5 changes: 3 additions & 2 deletions content/influxdb3/cloud-dedicated/admin/tokens/management/create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,9 @@ and managing management tokens.
- **Expiration date**: Set an expiration date for the token
- **Expiration time**: Set an expiration time for the token
- **Description**: Enter a description for the token
-
If an expiration isn't set, the token does not expire until revoked.

If an expiration isn't set, the token does not expire until revoked.

6. Click the **Create Token** button. The dialog displays the **Token secret** string and the description you provided.
{{% /tab-content %}}
{{% tab-content %}}
Expand Down
10 changes: 5 additions & 5 deletions content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ The {{% product-name %}} administrative UI includes a portal for managing manage

{{< admin-ui-access >}}

**Search** for the token or use the sort button and column headers to sort the token list and find the token you want to revoke.
5. Click the options button (three vertical dots) to the right of the token you want to revoke.
1. **Search** for the token or use the sort button and column headers to sort the token list and find the token you want to revoke.
2. Click the options button (three vertical dots) to the right of the token you want to revoke.
The options menu displays.
6. In the options menu, click **Revoke Token**.
7. In the **Revoke Management Token** dialog, check the box to confirm you "Understand the risk of this action".
8. Click the **Revoke Token** button to revoke the token.
3. In the options menu, click **Revoke Token**.
4. In the **Revoke Management Token** dialog, check the box to confirm you "Understand the risk of this action".
5. Click the **Revoke Token** button to revoke the token.
The token is revoked and filtered from the list of active tokens.
{{% /tab-content %}}
{{% tab-content %}}
Expand Down