Skip to content

fix(explorer): clarify cloud support and point to the Admin UI - #7629

Open
jstirnaman wants to merge 3 commits into
masterfrom
claude/explorer-docs-dedicated-callout-jsaiw4
Open

fix(explorer): clarify cloud support and point to the Admin UI#7629
jstirnaman wants to merge 3 commits into
masterfrom
claude/explorer-docs-dedicated-callout-jsaiw4

Conversation

@jstirnaman

@jstirnaman jstirnaman commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Related: #7626, #7627, #7628 (follow-ups, not closed by this PR)

What changed

Explorer docs no longer imply that InfluxDB 3 Explorer is a supported way to work with InfluxDB Cloud Dedicated, and the Cloud Dedicated and InfluxDB 3 Cloud docs now point administrators to the Admin UI at console.influxdata.com.

  • About Explorer — replaced the "in a future release" statement with a Product support section describing current support.
  • Explorer get started — turned the supported-products list into a table separating "query and administer" from "query only", and added a callout sending Cloud Dedicated and InfluxDB 3 Cloud users to the Admin UI.
  • Cloud Dedicated admin and get started — added callouts preferring the Admin UI over the standalone Explorer UI.
  • Shared InfluxDB 3 admin index — added the same callout for InfluxDB 3 Cloud, scoped with show-in so it renders only for that product.
  • Explorer manage databases / manage tokens — fixed two links pointing at #run-in-query-or-admin-mode, an anchor that does not exist. The heading on the install page is "Choose operational mode".
  • Cloud Dedicated get started — fixed a pre-existing broken anchor in the tools table. It linked to #influxdb-3-client-libraries, but the heading is "InfluxDB client libraries" and covers both v3 and v2 client libraries, so the link was wrong rather than the heading. Unchanged on master; the link checker only began scanning the file because this branch modifies it.

Why

A customer was told they could "technically use" Explorer with Cloud Dedicated. Explorer has only partial support for Dedicated, and Dedicated customers should be using the Admin UI.

The docs invited that mistake by contradicting themselves. About Explorer said support for Serverless, Dedicated, and Clustered was coming "in a future release", while the get started guide already listed Serverless and Dedicated as supported in query mode. Neither page mentioned the Admin UI.

Impact

Cloud Dedicated and InfluxDB 3 Cloud readers are now directed to the console for administrative tasks. Core and Enterprise guidance is unchanged — Explorer is still the recommended UI for those products, and the new shared-content callout is scoped so it never appears on their pages.

The callouts state a preference and nothing more. They don't enumerate which resources the Admin UI manages, and they make no claim about what Explorer can do against a cluster. Two reasons:

  1. Console feature support is unverified — see Confirm Explorer and Admin UI support levels for Cloud Dedicated and InfluxDB 3 Cloud #7628.
  2. Admin functionality is documented in the admin sections, and duplicating it in a callout means maintaining it twice. Enumerating resources also misleads by omission: an admin section whose children are CLI and API pages reads as though the Admin UI doesn't support those tasks.

Which interface to use for each task belongs on the specific admin pages, where it can be stated with the detail it needs.

For the same reason, no Admin UI row was added to the Cloud Dedicated tools comparison table.

Verification

  • npx hugo --quiet passes.
  • Shared-content scoping. content/shared/influxdb3-admin/_index.md is sourced by Core, Enterprise, and InfluxDB 3 Cloud. An unscoped callout would tell Core and Enterprise users to avoid Explorer, which is the opposite of the guidance for those products. Confirmed in the built output that the callout appears on /influxdb3/cloud/admin/ and on neither /influxdb3/core/admin/ nor /influxdb3/enterprise/admin/. A site-wide search finds it on exactly two pages: Cloud and Cloud Dedicated.
  • version: cloud is not globally unique — influxdb_cloud (Cloud TSM) cascades the same value. It is unambiguous here only because Cloud TSM doesn't source this file, which is why the scoping is verified by build output rather than assumed. Tracked in InfluxDB 3 Cloud has no identify-version page, blocked by version: cloud key collision #7627.
  • All internal and external links in the change resolve in the build, including the corrected #choose-operational-mode and #influxdb-client-libraries anchors.
  • Vale reports 0 errors and 0 warnings across all changed files, under both the default and cloud-dedicated configs.
  • No layout changes, so no e2e tests required.

Checklist


Suggested reviewers (click to expand)

Based on files changed:

Content Product
Explorer mavarius, peterbarnett03
Cloud Dedicated ritwika314, sanderson
/content/shared/ influxdata/product-managers

Product review is worth having here: the support levels this PR documents came from a support thread, and the open questions in #7628 are what kept further capability claims out of the diff.

Explorer docs described Cloud Serverless, Cloud Dedicated, and Clustered
support as coming "in a future release" while the get started guide listed
Serverless and Dedicated as supported in query mode, leaving customers with
the impression that Explorer is a supported way to work with Cloud Dedicated.
Cloud Dedicated and InfluxDB 3 Cloud customers should administer their
clusters and instances through the Admin UI at console.influxdata.com.

- Replace the outdated "future release" statement in About Explorer with a
  Product support section that states current support levels.
- Convert the supported products list in the Explorer get started guide to a
  table that distinguishes "query and administer" from "query only".
- Add callouts in the Explorer docs directing Cloud Dedicated and InfluxDB 3
  Cloud users to the Admin UI for administrative tasks.
- Add a callout to Administer InfluxDB Cloud Dedicated and to the Cloud
  Dedicated get started guide advising the Admin UI or influxctl over the
  standalone Explorer UI. These state the directive only; they make no claim
  about what Explorer can do against a cluster, which needs verification.
- Add an equivalent callout to the shared InfluxDB 3 admin index, scoped with
  show-in so it renders only for InfluxDB 3 Cloud and not for Core or
  Enterprise, where Explorer is the recommended UI.
- Fix broken #run-in-query-or-admin-mode anchors in the Explorer manage
  databases and manage tokens pages.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MgQ2tqMK4FPgn4WnYDdkEt
@jstirnaman
jstirnaman requested a review from a team as a code owner August 7, 2026 20:38
@jstirnaman
jstirnaman requested review from sanderson and removed request for a team August 7, 2026 20:38
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 0
Warnings 4
Warnings (4)
File Line Rule Message
content/influxdb3/core/admin/_index.md 10 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/cloud/admin/_index.md 10 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/enterprise/admin/_index.md 10 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb3/explorer/manage-databases.md 47 InfluxDataDocs.Capitalization 'Delete a database' should be in sentence case

Check passed

@github-actions github-actions Bot added product:explorer InfluxDB 3 Explorer product:shared Shared content across products product:v3-distributed InfluxDB 3 Cloud Serverless, Cloud Dedicated, Clustered product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable) labels Aug 7, 2026
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Check Results — Link Check Bot

All links are valid

Metric Value
Files Checked 9
Total Links 2083
Errors 0
Warnings 10
Success Rate 98.655785%
⚠️ 10 warning(s) (do not fail CI)
Source File URL Issue
content/influxdb3/cloud-dedicated/admin/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud-dedicated/get-started/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/cloud-dedicated/get-started/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb3/cloud-dedicated/api/management File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb3/cloud/admin/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/core/admin/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/enterprise/admin/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/explorer/about/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/explorer/get-started/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/explorer/manage-databases/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb3/explorer/manage-tokens/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…

Full details: workflow run summary and artifact. Last updated: 2026-08-07 21:29:29 UTC

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

📦 PR Preview — Preview Bot

Status Details
Result ✅ DEPLOYED (full site)
Preview View preview
Build time 88s
Last updated 2026-08-07 22:19:38 UTC
Changed pages (9)

Preview auto-deploys on push. Will be cleaned up when PR closes.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Clarifies Explorer support and directs cloud administrators to the Admin UI.

Changes:

  • Adds an Explorer product-support matrix.
  • Adds cloud administration guidance.
  • Corrects two operational-mode anchors.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
content/shared/influxdb3-admin/_index.md Adds Cloud Admin UI guidance.
content/influxdb3/explorer/manage-tokens.md Corrects the operational-mode anchor.
content/influxdb3/explorer/manage-databases.md Corrects the operational-mode anchor.
content/influxdb3/explorer/get-started.md Adds support levels and cloud guidance.
content/influxdb3/explorer/about/_index.md Documents current product support.
content/influxdb3/cloud-dedicated/get-started/_index.md Recommends supported administration tools.
content/influxdb3/cloud-dedicated/admin/_index.md Directs administrators away from Explorer.

Comment thread content/influxdb3/explorer/get-started.md Outdated
Comment thread content/shared/influxdb3-admin/_index.md Outdated
Comment thread content/influxdb3/explorer/about/_index.md Outdated
…brary anchor

Address review feedback on the Explorer and Admin UI callouts.

The InfluxDB 3 Cloud callout listed databases, tables, tokens, and users as
Admin UI tasks. That enumeration is documented for Cloud Dedicated, whose Admin
UI sidebar lists those resources, but it contradicts the InfluxDB 3 Cloud docs:
content/influxdb3/cloud/admin/tokens/_index.md says to manage tokens with the
influxdb3 CLI or the HTTP API, and the Cloud Admin UI page covers users only.
Make the Explorer and shared admin callouts recommendation-only so they don't
present unconfirmed console capabilities as settled.

Also fix a pre-existing broken anchor in the Cloud Dedicated get started tools
table. The table linked to #influxdb-3-client-libraries, but the heading is
"InfluxDB client libraries" (#influxdb-client-libraries), which covers both v3
and v2 client libraries. The link, not the heading, was wrong. This link is
unchanged on master; the link checker only began scanning the file because this
branch modifies it.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MgQ2tqMK4FPgn4WnYDdkEt

Copy link
Copy Markdown
Contributor Author

Pushed c5c6174, which addresses the link-check failure and all three review comments.

Review comments — all three accepted

The review was right, and one comment caught a real defect. I had written "use the Admin UI to manage databases, tables, tokens, and users" for both Cloud Dedicated and InfluxDB 3 Cloud. That enumeration is grounded for Dedicated — content/influxdb3/cloud-dedicated/admin/account/_index.md documents an Admin UI sidebar with exactly Databases, Tables, Database Tokens, Management Tokens, and Users. I then carried the same wording to InfluxDB 3 Cloud without checking, and for i3c it is wrong:

  • content/influxdb3/cloud/admin/tokens/_index.md says tokens are created and managed with the influxdb3 CLI or the HTTP API.
  • content/influxdb3/cloud/admin/users/admin-ui.md scopes the i3c Admin UI to users only.

So the callout contradicted the product's own docs. Fixed by making the callouts recommendation-only:

  • content/shared/influxdb3-admin/_index.md — now points to the Admin UI and the tools described in the following articles, so the linked pages remain the authority on which tool does what.
  • content/influxdb3/explorer/about/_index.md — "administer your cluster or instance" instead of the resource list.
  • content/influxdb3/explorer/get-started.md — dropped "you can query data, but you can't administer your cluster". Support characterization stays in the support table, as suggested.

The Cloud Dedicated get-started callout keeps its enumeration, since that one is documented.

Link check

#influxdb-3-client-libraries in the Cloud Dedicated get-started tools table. The heading is ### InfluxDB client libraries (#influxdb-client-libraries) and it covers both v3 and v2 client libraries, so the heading is right and the link was wrong — fixed the link.

This anchor is unchanged on master; my diff never touched that line. The link checker only started scanning the file because this branch modifies it, which surfaced a latent break. The identical mismatch exists at content/influxdb3/clustered/get-started/_index.md:111. I left it alone to avoid pulling another file into link-check scope and growing this PR — worth a separate fix.

Vale

0 errors. The 4 warnings are pre-existing and untouched by this branch: the three adminadministrator hits are on line 10 of product stub files I don't modify, and manage-databases.md:47 predates this work.


Generated by Claude Code

Admin functionality belongs in the admin sections, not duplicated in callouts
or the get started tools table. Enumerating resources also misleads by
omission: an admin section whose children are CLI and API pages reads as though
the Admin UI doesn't support those tasks.

Reduce every callout to the one durable point -- prefer the Admin UI over the
standalone Explorer UI -- and let the admin sections state which interface to
use for each task.

- Drop "manage databases, tables, tokens, and users" from the Cloud Dedicated
  get started callout; link to the admin section instead.
- Drop the influxctl reference from the Cloud Dedicated admin callout.
- Drop "and the tools described in the following articles" from the shared
  InfluxDB 3 Cloud callout.
- Shorten the Explorer pointers to "For administrative tasks, see ...".

The tools comparison table still carries no Admin UI row.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MgQ2tqMK4FPgn4WnYDdkEt
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:explorer InfluxDB 3 Explorer product:shared Shared content across products product:v3-distributed InfluxDB 3 Cloud Serverless, Cloud Dedicated, Clustered product:v3-monolith InfluxDB 3 Core and Enterprise (single-node / clusterable)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants