chore: update Admin UI doc to reflect the new UI design #6528

blegesse-w · 2025-11-10T20:12:58Z

PR updates admin UI doc to reflect the new UI design

Major Updates:

New Navigation Section - added "Navigate the Admin UI" to explain the collapsible sidebar structure
Account and Cluster Management - expanded section explaining the new hierarchical navigation with account/cluster selectors at the bottom of the sidebar
All Accounts/Clusters Views - added documentation for viewing all accounts and clusters
Cluster Overview
All pages now reference the sidebar navigation instead of the old portal-style navigation
Added new section documenting the Help menu with links to documentation, support, and sales
Management Tokens
Signed the InfluxData CLA
(if necessary)
Rebased/mergeable

wdoconnell · 2025-11-19T21:00:41Z

content/influxdb3/cloud-dedicated/admin/account/_index.md

- [Access the Admin UI](#access-the-admin-ui)
- [View account information](#view-account-information)
- [View cluster information](#view-cluster-information)
-  - [Access operational dashboards](#access-operational-dashboards)


The 'operational dashboards' and 'management tokens' anchors are the ones that weren't on this page (so existing links didn't work)

wdoconnell · 2025-11-19T21:02:09Z

content/influxdb3/cloud-dedicated/admin/clusters/get.md

-
-   After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/)
-   and lists all clusters associated with your account.
-3. **Search** for the cluster or use the sort button and column headers to sort the cluster list and find the cluster.


We could leave all of this in, but I found this a little repetitive; for purposes of opening the application I think providing the URL and request to contact support if credentials are required is sufficient.

wdoconnell · 2025-11-19T21:02:30Z

content/influxdb3/cloud-dedicated/admin/databases/update.md

-> #### Database names can't be updated
-> 
+> [!Note]
+> #### Database names can't be updated with this command


I edited this because there is a database rename command in influxctl now.

wdoconnell · 2025-11-19T21:03:02Z

content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md

+- **Time Range Configuration**: Adjust the metrics time range
+- **Live Updates**: Enable automatic refresh for real-time monitoring
+
+## Monitor with Grafana operational dashboards


@ritwika314 I imagine we should keep the Grafana operational dashboards instructions at least for now.

wdoconnell · 2025-11-19T21:04:46Z

content/influxdb3/cloud-dedicated/admin/users/admin-ui.md


-1. Access the {{% product-name %}} Admin UI at [console.influxdata.com](https://console.influxdata.com).
-   If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
-2. Log in using the credentials provided by InfluxData.


I proposed condensing this throughout as I thought it might be too wordy; I'll revert if we think the specific instructions on selecting the account/cluster are needed on each page

wdoconnell · 2025-11-19T21:05:07Z

content/influxdb3/cloud-dedicated/reference/admin-ui.md

@@ -1,100 +0,0 @@
---


This doesn't delete this material, but rather moves it over into the body of the docs.

wdoconnell · 2025-11-19T21:19:00Z

fyi @blegesse-w @ritwika314: I added a separate commit implementing what I understand has been discussed with @jstirnaman about the organization of the Admin UI documentation going forward: i.e., removing the old 'reference' section, and moving the Admin UI documentation and screenshots into the main documentation sections (which allow choosing between the Admin UI, influxctl, and sometimes the management API, depending on the context).

wdoconnell · 2025-11-19T21:21:33Z

One thing I was not sure about how to resolve: I did get several "Vale" errors of the following form in my local instance of the repo, which I think are due to the inclusion of URLs and code blocks including the term 'API' (and commas and periods). I ignored the warnings on commit/push, but if I should resolve locally, please advise.

 5:59     error  Use 'APIs?' instead of 'api'.   Vale.Terms
 34:21    error  Commas and periods go inside    Google.Quotes
                 quotation marks.

sanderson

Some minor punctuation nits, but otherwise looks great! Thanks @blegesse-w and @wdoconnell

content/influxdb3/cloud-dedicated/admin/account/_index.md

ritwika314

I mostly just propagated @sanderson's punctuation suggestions to other lists, looks great overall, thank you @blegesse-w and @wdoconnell !

content/influxdb3/cloud-dedicated/admin/clusters/get.md

ritwika314 · 2025-11-19T21:44:23Z

content/influxdb3/cloud-dedicated/admin/databases/list.md

+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).


@sanderson could this be a macro/shortcut? its repeated on every ui page.

@ritwika314 It is now! I added it with some templating.

content/influxdb3/cloud-dedicated/admin/tables/list.md

content/influxdb3/cloud-dedicated/admin/tokens/database/list.md

content/influxdb3/cloud-dedicated/admin/tokens/management/list.md

content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Co-authored-by: ritwika314 <mim.ghosh@gmail.com>

jstirnaman · 2025-11-21T18:43:25Z

One thing I was not sure about how to resolve: I did get several "Vale" errors of the following form in my local instance of the repo

False positives - fixing those rules is on my todo list.

blegesse-w added 2 commits November 10, 2025 14:12

chore: replace old ui images with new ui

e6e80d2

chore: update doc to reflect the new UI design

6108483

blegesse-w changed the title ~~chore(WIP): replace old ui images with new ui~~ chore(WIP): update Admin UI doc to reflect the new UI design Nov 10, 2025

blegesse-w marked this pull request as ready for review November 10, 2025 21:02

blegesse-w requested a review from wdoconnell November 10, 2025 21:02

blegesse-w changed the title ~~chore(WIP): update Admin UI doc to reflect the new UI design~~ chore: update Admin UI doc to reflect the new UI design Nov 10, 2025

fix: update View account information to use new design and info

84b196b

blegesse-w force-pushed the chore/update_admin_ui_images branch from 157d579 to 84b196b Compare November 10, 2025 22:15

influxdata deleted a comment from blegesse-w Nov 19, 2025

wdoconnell force-pushed the chore/update_admin_ui_images branch from 68b17b4 to 095592a Compare November 19, 2025 21:00

wdoconnell reviewed Nov 19, 2025

View reviewed changes

docs: replace admin ui reference docs with inline docs

365a1c1

wdoconnell force-pushed the chore/update_admin_ui_images branch from 095592a to 365a1c1 Compare November 19, 2025 21:13

wdoconnell requested review from jstirnaman, ritwika314 and sanderson November 19, 2025 21:16

sanderson approved these changes Nov 19, 2025

View reviewed changes

ritwika314 approved these changes Nov 19, 2025

View reviewed changes

wdoconnell and others added 5 commits November 19, 2025 16:59

Update content/influxdb3/cloud-dedicated/admin/account/_index.md

bb434e7

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Update content/influxdb3/cloud-dedicated/admin/account/_index.md

2ff1b24

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Update content/influxdb3/cloud-dedicated/admin/account/_index.md

36e8563

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Update content/influxdb3/cloud-dedicated/admin/account/_index.md

480ee39

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

Update content/influxdb3/cloud-dedicated/admin/clusters/get.md

c7fc09b

Co-authored-by: ritwika314 <mim.ghosh@gmail.com>

wdoconnell and others added 5 commits November 19, 2025 17:01

Update content/influxdb3/cloud-dedicated/admin/tables/list.md

09cd1f2

Co-authored-by: ritwika314 <mim.ghosh@gmail.com>

Update content/influxdb3/cloud-dedicated/admin/tokens/management/list.md

9dba2c8

Co-authored-by: ritwika314 <mim.ghosh@gmail.com>

Update content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md

fdc1ad2

Co-authored-by: ritwika314 <mim.ghosh@gmail.com>

Update content/influxdb3/cloud-dedicated/admin/tokens/database/list.md

0726900

Co-authored-by: ritwika314 <mim.ghosh@gmail.com>

docs: admin ui uses macro for intro

4e71b96

wdoconnell requested review from ritwika314 and sanderson November 20, 2025 16:20

sanderson approved these changes Nov 20, 2025

View reviewed changes

ritwika314 approved these changes Nov 20, 2025

View reviewed changes

wdoconnell added 2 commits November 20, 2025 13:59

Merge branch 'master' into chore/update_admin_ui_images

d14cc75

Merge branch 'master' into chore/update_admin_ui_images

fd59414

wdoconnell merged commit c45a28b into master Nov 21, 2025
2 checks passed

wdoconnell mentioned this pull request Nov 21, 2025

fix: dedicated docs adjustments #6562

Merged

2 tasks

jstirnaman deleted the chore/update_admin_ui_images branch November 21, 2025 18:43

		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).

chore: update Admin UI doc to reflect the new UI design #6528

chore: update Admin UI doc to reflect the new UI design #6528

Uh oh!

Conversation

blegesse-w commented Nov 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wdoconnell commented Nov 19, 2025

Uh oh!

wdoconnell commented Nov 19, 2025

Uh oh!

sanderson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ritwika314 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jstirnaman commented Nov 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

blegesse-w commented Nov 10, 2025 •

edited

Loading