From 4e71b963d6b6db01b89ef5dc5351b84e2b7ec9f2 Mon Sep 17 00:00:00 2001 From: Bill OConnell Date: Thu, 20 Nov 2025 11:13:10 -0500 Subject: [PATCH] docs: admin ui uses macro for intro --- content/influxdb3/cloud-dedicated/admin/account/_index.md | 3 +-- content/influxdb3/cloud-dedicated/admin/clusters/get.md | 3 +-- content/influxdb3/cloud-dedicated/admin/clusters/list.md | 3 +-- content/influxdb3/cloud-dedicated/admin/databases/list.md | 3 +-- .../influxdb3/cloud-dedicated/admin/monitor-your-cluster.md | 3 +-- content/influxdb3/cloud-dedicated/admin/tables/list.md | 3 +-- .../influxdb3/cloud-dedicated/admin/tokens/database/create.md | 3 +-- .../influxdb3/cloud-dedicated/admin/tokens/database/list.md | 3 +-- .../influxdb3/cloud-dedicated/admin/tokens/database/revoke.md | 3 +-- .../influxdb3/cloud-dedicated/admin/tokens/database/update.md | 3 +-- .../influxdb3/cloud-dedicated/admin/tokens/management/list.md | 3 +-- .../cloud-dedicated/admin/tokens/management/revoke.md | 3 +-- content/influxdb3/cloud-dedicated/admin/users/admin-ui.md | 3 +-- layouts/shortcodes/admin-ui-access.html | 3 +++ 14 files changed, 16 insertions(+), 26 deletions(-) create mode 100644 layouts/shortcodes/admin-ui-access.html diff --git a/content/influxdb3/cloud-dedicated/admin/account/_index.md b/content/influxdb3/cloud-dedicated/admin/account/_index.md index e1d6a7781..376ff6f61 100644 --- a/content/influxdb3/cloud-dedicated/admin/account/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/account/_index.md @@ -20,8 +20,7 @@ Your {{% product-name %}} account is a collection of {{% product-name omit="Clus ## Access and Navigate the Admin UI -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} The Admin UI features a collapsible sidebar navigation that provides quick access to all administrative functions: diff --git a/content/influxdb3/cloud-dedicated/admin/clusters/get.md b/content/influxdb3/cloud-dedicated/admin/clusters/get.md index c426bb425..5e7e56a8c 100644 --- a/content/influxdb3/cloud-dedicated/admin/clusters/get.md +++ b/content/influxdb3/cloud-dedicated/admin/clusters/get.md @@ -28,8 +28,7 @@ Use the Admin UI or the [`influxctl cluster get` CLI command](/influxdb3/cloud-d [influxctl](#) {{% /tabs %}} {{% tab-content %}} -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} ### View cluster details diff --git a/content/influxdb3/cloud-dedicated/admin/clusters/list.md b/content/influxdb3/cloud-dedicated/admin/clusters/list.md index 3abc2287b..7fc250ee6 100644 --- a/content/influxdb3/cloud-dedicated/admin/clusters/list.md +++ b/content/influxdb3/cloud-dedicated/admin/clusters/list.md @@ -24,8 +24,7 @@ to view information about all {{< product-name omit=" Clustered" >}} clusters as [influxctl](#) {{% /tabs %}} {{% tab-content %}} -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} ### View cluster details diff --git a/content/influxdb3/cloud-dedicated/admin/databases/list.md b/content/influxdb3/cloud-dedicated/admin/databases/list.md index a77134314..4de3813b9 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/list.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/list.md @@ -35,8 +35,7 @@ or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to list [Management API](#) {{% /tabs %}} {{% tab-content %}} -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} The database list displays the following database details: diff --git a/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md b/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md index 800dd3e5f..c1dac34f4 100644 --- a/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md +++ b/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md @@ -19,8 +19,7 @@ weight: 104 The Admin UI **Overview** page provides real-time monitoring of your cluster's performance and resource usage. -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-overview.png" alt="InfluxDB Cloud Dedicated Admin UI cluster overview" />}} diff --git a/content/influxdb3/cloud-dedicated/admin/tables/list.md b/content/influxdb3/cloud-dedicated/admin/tables/list.md index caa59d347..e64def787 100644 --- a/content/influxdb3/cloud-dedicated/admin/tables/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/list.md @@ -53,8 +53,7 @@ The InfluxDB Cloud Dedicated administrative UI includes a portal for managing tables. You can view the list of tables associated with a database and their details. -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-tables.png" alt="InfluxDB Cloud Dedicated Admin UI tables list" />}} diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md index 641435a8b..2cea32ab0 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md @@ -70,8 +70,7 @@ or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to crea The InfluxDB Cloud Dedicated administrative UI includes a portal for creating and managing database tokens. -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} In the Database Tokens portal, click the **New Database Token** button. The **Create Database Token** dialog displays. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md index c39d6d4ec..1af27846f 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md @@ -63,8 +63,7 @@ Administrators can use this portal to: - Create a database token - Revoke a database token -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI database tokens" />}} diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md index 67b0f9ea9..1bbf7cd0e 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md @@ -56,8 +56,7 @@ Administrators can use this portal to: - Create a database token - Revoke a database token -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< 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. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md index bc2632f08..ba38ada90 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md @@ -74,8 +74,7 @@ Through this portal, administrators can edit a token's permissions to: ### Open the Edit Database Token dialog -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< 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. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md index 347be9aed..624c43b02 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md @@ -30,8 +30,7 @@ to list manually-created management tokens. The InfluxDB Cloud Dedicated administrative UI includes a portal for creating and managing management tokens. -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-management-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI management tokens" />}} diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md index 3cf7930a7..ba289e364 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md @@ -28,8 +28,7 @@ to revoke a management token and remove all access associated with the token. The {{% product-name %}} administrative UI includes a portal for managing management tokens. -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< 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. diff --git a/content/influxdb3/cloud-dedicated/admin/users/admin-ui.md b/content/influxdb3/cloud-dedicated/admin/users/admin-ui.md index 72ce61bd9..a2d202375 100644 --- a/content/influxdb3/cloud-dedicated/admin/users/admin-ui.md +++ b/content/influxdb3/cloud-dedicated/admin/users/admin-ui.md @@ -28,8 +28,7 @@ Use the {{% product-name %}} Admin UI to manage users and control access to your ## Access the Users page -Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). +{{< admin-ui-access >}} {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-users.png" alt="InfluxDB Cloud Dedicated Admin UI users" />}} diff --git a/layouts/shortcodes/admin-ui-access.html b/layouts/shortcodes/admin-ui-access.html new file mode 100644 index 000000000..8fb97decf --- /dev/null +++ b/layouts/shortcodes/admin-ui-access.html @@ -0,0 +1,3 @@ +{{ $_hugo_config := `{ "version": 1 }` }} +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).