From 708c204b8db35ae9aea33519d1ebb0edad9de537 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 3 Sep 2026 18:23:26 +0000 Subject: [PATCH 01/10] docs(enterprise): document integrated Explorer WASM UI in 3.11 ## What changed - Add `content/influxdb3/enterprise/visualize-data/explorer.md`, the server-side deployment page for the integrated Explorer web UI. - Document the `webui` value of `--mode` in the shared config options reference. - Add an Enterprise-only "Web UI" section to the shared config options reference covering `--webui-session-secret` and `--webui-openai-base-url`. - Link the 3.11 release notes entry to the new page. ## Why Enterprise 3.11 ships Explorer inside the binary as a WebAssembly guest, but the only description of it was the release notes entry. Readers had no page that states the requirements, the startup command, or how the integrated UI differs from the Docker container. This is item 3 of the "Before the release" list in docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md (PR #7734), which reserves the Enterprise-side WASM instructions for a separate change. It touches no file that PR #7734 restructures. ## Impact The new page carries `metadata: [InfluxDB 3 Enterprise v3.11+]` and shows both version checks (`influxdb3 --version` and `GET /ping`), following DOCS-VERSION-AVAILABILITY.md. The config options additions are gated with `show-in "enterprise"`, so Core output is unchanged. Four facts are marked with NEEDS VERIFICATION comments rather than guessed: the address that serves the UI, whether the first connection needs an operator token, how the AI chat endpoint authenticates, and the full `--webui-*` option list with its environment variable names. Extract those from `influxdb3 serve --help-all` and remove the comments before publishing. ## Verification - `npx hugo --quiet` builds without errors. - The `#web-ui`, `#webui-session-secret`, and `#webui-openai-base-url` anchors render in the Enterprise config options page and are absent from Core. - Every internal link on the new page resolves to a built page or anchor. - Vale and link-checker aren't installed in this environment, so neither ran. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv --- .../enterprise/visualize-data/explorer.md | 207 ++++++++++++++++++ .../shared/influxdb3-cli/config-options.md | 46 ++++ .../_index.md | 3 + 3 files changed, 256 insertions(+) create mode 100644 content/influxdb3/enterprise/visualize-data/explorer.md diff --git a/content/influxdb3/enterprise/visualize-data/explorer.md b/content/influxdb3/enterprise/visualize-data/explorer.md new file mode 100644 index 0000000000..f283fecf87 --- /dev/null +++ b/content/influxdb3/enterprise/visualize-data/explorer.md @@ -0,0 +1,207 @@ +--- +title: Use the integrated InfluxDB 3 Explorer UI +list_title: InfluxDB 3 Explorer +description: > + Serve the InfluxDB 3 Explorer web UI directly from your + {{< product-name >}} server. Starting with v3.11, Explorer ships inside the + Enterprise binary as a WebAssembly (WASM) guest, so you don't run a separate + container. +menu: + influxdb3_enterprise: + parent: Visualize data + name: Use InfluxDB 3 Explorer + identifier: visualize-with-explorer +weight: 100 +metadata: [InfluxDB 3 Enterprise v3.11+] +related: + - /influxdb3/enterprise/reference/config-options/#mode + - /influxdb3/enterprise/reference/config-options/#web-ui + - /influxdb3/explorer/, InfluxDB 3 Explorer documentation +--- + +Starting with {{% product-name %}} v3.11, the +[InfluxDB 3 Explorer](/influxdb3/explorer/) web UI ships inside the Enterprise +binary as a [WebAssembly](https://webassembly.org/) (WASM) guest that the +server hosts in-process behind a +[WASI](https://wasi.dev/) sandbox. +To serve Explorer from your server, add the `webui` mode when you start the +server. +You don't need to run the Explorer Docker container alongside InfluxDB. + +Explorer isn't enabled by default. +The `all` mode doesn't include `webui`, so name `webui` explicitly--for +example, `--mode all,webui`. + +- [Before you begin](#before-you-begin) +- [Check your version](#check-your-version) +- [Start the server with Explorer enabled](#start-the-server-with-explorer-enabled) +- [Connect Explorer to your server](#connect-explorer-to-your-server) +- [Manage the session secret](#manage-the-session-secret) +- [Explorer application data](#explorer-application-data) +- [Enable AI chat](#enable-ai-chat) +- [Choose between integrated and containerized Explorer](#choose-between-integrated-and-containerized-explorer) + +## Before you begin + +To serve Explorer from your server, you need the following: + +- {{% product-name %}} v3.11 or later. + For earlier releases, run the + [Explorer Docker container](/influxdb3/explorer/install/). +- A session secret. + {{% product-name %}} requires + [`--webui-session-secret`](/influxdb3/enterprise/reference/config-options/#webui-session-secret) + whenever `webui` mode is enabled, and doesn't start without it. +- A plugin directory. + Pass the directory to + [`--plugin-dir`](/influxdb3/enterprise/reference/config-options/#plugin-dir) + and create it before you start the server. + +## Check your version + +Explorer availability depends on the InfluxDB 3 server version and edition, not +on the Explorer version alone. +Use either of the following checks. + +To check the version of a local binary: + +```bash +influxdb3 --version +``` + +To check the version and edition of a running server, send a `GET` request to +the `/ping` endpoint: + +```sh +curl --get "http://localhost:8181/ping" \ + --header "Authorization: Bearer AUTH_TOKEN" +``` + +The response headers include `x-influxdb-version` and `x-influxdb-build`. +`x-influxdb-build` reports `Core` or `Enterprise`, so one request answers both +the version question and the edition question. +Use `GET`; a `HEAD` request returns `404`. + +## Start the server with Explorer enabled + +1. Create the plugin directory: + + ```bash + mkdir -p ./plugins + ``` + +2. Start the server with `webui` added to `--mode` and a session secret: + + ```bash + influxdb3 serve \ + --cluster-id cluster0 \ + --node-id node0 \ + --mode all,webui \ + --plugin-dir ./plugins \ + --webui-session-secret "$(openssl rand -base64 24)" + ``` + +`openssl rand -base64 24` generates a new secret on every start, which signs +users out after each restart. +For anything beyond a local trial, generate the secret once and pass the same +value on every start. +See [Manage the session secret](#manage-the-session-secret). + +> [!Important] +> #### Control who can reach Explorer +> +> Anyone who can reach Explorer can use the InfluxDB connection configured in +> it, with that token's permissions. +> Treat reaching Explorer the same as holding the token: bind the server to an +> interface you intend to expose, use tokens scoped to the task, and put an +> authenticating reverse proxy with TLS in front of any remote access. +> To control which interface the server listens on, see +> [`--http-bind`](/influxdb3/enterprise/reference/config-options/#http-bind). + + + +## Connect Explorer to your server + +After the server starts, configure a connection to your server in Explorer the +same way you configure one in the standalone Docker Explorer--for example, +`http://localhost:8181`. +For the connection fields and the steps to create a connection, see +[Get started with InfluxDB 3 Explorer](/influxdb3/explorer/get-started/). + + + +## Manage the session secret + +`--webui-session-secret` signs the session cookies that Explorer issues. +The server requires the option whenever `webui` mode is enabled. + +- **Generate the secret once and reuse it.** + A secret that changes on restart invalidates every existing session. +- **Keep the secret out of your shell history and process list.** + Set the secret through the environment variable instead of the command line + when you can. +- **Rotate the secret when it may have been exposed.** + Rotating signs out all users. + +To generate a secret: + +```bash +openssl rand -base64 24 +``` + +## Explorer application data + +The integrated Explorer keeps its application state in a SQLite database that +the server synchronizes to object storage for each cluster. +You don't mount a volume to persist it, which is the main operational +difference from the +[Explorer Docker container](/influxdb3/explorer/install/#persist-data-across-restarts). + +## Enable AI chat + +Explorer includes an AI chat feature that you can point at any +OpenAI-compatible endpoint. +To enable it, set +[`--webui-openai-base-url`](/influxdb3/enterprise/reference/config-options/#webui-openai-base-url) +to the base URL of the endpoint: + +```bash +influxdb3 serve \ + --cluster-id cluster0 \ + --node-id node0 \ + --mode all,webui \ + --plugin-dir ./plugins \ + --webui-session-secret "$WEBUI_SESSION_SECRET" \ + --webui-openai-base-url "https://your-openai-compatible-endpoint" +``` + +Chat prompts, and any query results included with them, go to the endpoint you +configure. +Choose an endpoint that your data handling policies allow. + + + +## Choose between integrated and containerized Explorer + +| | Integrated (WASM) | Docker container | +| :--- | :--- | :--- | +| Requires | {{% product-name %}} v3.11+ | Docker | +| Runs | In the InfluxDB server process | As a separate container | +| Enabled by | `--mode all,webui` | `docker run influxdata/influxdb3-ui` | +| Application data | SQLite synchronized to object storage | SQLite in a mounted volume | +| Works with InfluxDB 3 Core | No | Yes | + +Use the container when you run Core, when you run an Enterprise release +earlier than v3.11, or when you want Explorer to run separately from the +database server--for example, on an operator workstation. +See [Install and run InfluxDB 3 Explorer](/influxdb3/explorer/install/). diff --git a/content/shared/influxdb3-cli/config-options.md b/content/shared/influxdb3-cli/config-options.md index 9ddd8f1a2f..6a39180bfe 100644 --- a/content/shared/influxdb3-cli/config-options.md +++ b/content/shared/influxdb3-cli/config-options.md @@ -193,6 +193,7 @@ For detailed information about thread allocation, see the [Resource Limits](#res - [Processing Engine](#processing-engine) {{% show-in "enterprise" %}} - [Cluster Management](#cluster-management) +- [Web UI](#web-ui) {{% /show-in %}} - [Resource Limits](#resource-limits) - [Data Lifecycle Management](#data-lifecycle-management) @@ -260,6 +261,7 @@ This option supports the following values: - `query`: Enables only query capabilities - `compact`: Enables only compaction processes - `process`: Activates the [Processing Engine](/influxdb3/enterprise/reference/processing-engine/) so the node can execute trigger plugins. `process` has no API surface of its own — it doesn't accept writes or serve queries. Setting [`--plugin-dir`](#plugin-dir) implicitly adds `process` mode regardless of `--mode`. Conversely, `--mode=process` requires `--plugin-dir`. In a multi-node cluster, combine `process` with another mode (typically `query`) so plugins can call `influxdb3_local.query()` locally. +- `webui` *(3.11+)*: Serves the [InfluxDB 3 Explorer](/influxdb3/enterprise/visualize-data/explorer/) web UI from the server process as a WebAssembly (WASM) guest. `all` doesn't include `webui`, so name `webui` explicitly--for example, `--mode all,webui`. `webui` mode requires [`--webui-session-secret`](#webui-session-secret) and [`--plugin-dir`](#plugin-dir). You can specify multiple modes using a comma-delimited list (for example, `ingest,query`). @@ -2359,6 +2361,50 @@ together with the `--internode-bind-addr` option. | :--------------------- | :-------------------- | | `--conn-info` | `INFLUXDB3_CONN_INFO`
`INFLUXDB3_ENTERPRISE_CONN_INFO` ([pre-3.11 name](#name-changes-in-3-11)) | +*** + +### Web UI {#web-ui metadata="v3.11+"} + +Configure the integrated [InfluxDB 3 Explorer](/influxdb3/enterprise/visualize-data/explorer/) web UI, +which the server hosts in-process as a WebAssembly (WASM) guest. +The web UI is off unless you add `webui` to [`--mode`](#mode). + +- [webui-session-secret](#webui-session-secret) +- [webui-openai-base-url](#webui-openai-base-url) + + + +#### webui-session-secret + +Specifies the secret that signs web UI session cookies. +Required whenever [`--mode`](#mode) includes `webui`--the server doesn't start +without it. + +Generate a secret with `openssl rand -base64 24`, then pass the same value on +every start. +A secret that changes between restarts signs out every user. + +| influxdb3 serve option | Environment variable | +| :------------------------ | :-------------------------------- | +| `--webui-session-secret` | `INFLUXDB3_WEBUI_SESSION_SECRET` | + +*** + +#### webui-openai-base-url + +Specifies the base URL of the OpenAI-compatible endpoint that the web UI AI +chat sends requests to. +Chat prompts, and any query results included with them, go to this endpoint. + +| influxdb3 serve option | Environment variable | +| :------------------------- | :--------------------------------- | +| `--webui-openai-base-url` | `INFLUXDB3_WEBUI_OPENAI_BASE_URL` | + {{% /show-in %}} *** diff --git a/content/shared/v3-core-enterprise-release-notes/_index.md b/content/shared/v3-core-enterprise-release-notes/_index.md index 6486e2e5f5..ffa56b2067 100644 --- a/content/shared/v3-core-enterprise-release-notes/_index.md +++ b/content/shared/v3-core-enterprise-release-notes/_index.md @@ -260,6 +260,9 @@ Additional Enterprise-specific updates: cluster. AI chat is included and can point at any OpenAI-compatible endpoint with `--webui-openai-base-url`. + For setup steps, see + [Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). + - **Thread defaults scale with your license on the upgraded storage engine**: On clusters running the upgraded storage engine (the default for new clusters), `--num-io-threads` and the DataFusion thread pool each default to From 9ff6042929f04e2ffe424baab1180b9ab40637f3 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 3 Sep 2026 18:30:50 +0000 Subject: [PATCH 02/10] docs(enterprise): link get-started setup to integrated Explorer ## What changed Add an Enterprise-only optional bullet to the "Start InfluxDB" option list in content/shared/influxdb3-get-started/setup.md, naming `--mode all,webui` and linking to the integrated Explorer deployment page. ## Why The setup guide is where a reader chooses their `influxdb3 serve` options. Without a mention there, the integrated web UI is reachable only from the release notes or the Visualize data section, so a reader setting up a 3.11 server has no reason to know the option exists. The bullet names the dependencies and defers the requirements and the full command to the deployment page rather than repeating them. ## Impact Enterprise only. The bullet is wrapped in `show-in "enterprise"`, and the Explorer link uses the explicit `/influxdb3/enterprise/` path rather than `/influxdb3/version/`, so the shared file produces no Core-side link to a page that doesn't exist in Core. ## Verification - `npx hugo --quiet` builds without errors. - The bullet renders on /influxdb3/enterprise/get-started/setup/ and is absent from the Core build of the same page. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv --- content/shared/influxdb3-get-started/setup.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/shared/influxdb3-get-started/setup.md b/content/shared/influxdb3-get-started/setup.md index 700ec06722..828f27c40c 100644 --- a/content/shared/influxdb3-get-started/setup.md +++ b/content/shared/influxdb3-get-started/setup.md @@ -115,6 +115,15 @@ Provide the following: To accept only local connections until you create your first admin token, specify `127.0.0.1:8181`. +{{% show-in "enterprise" %}} +- _(Optional, v3.11+)_ `--mode all,webui`: Serves the InfluxDB 3 Explorer web UI + from the server process. + `all` doesn't include `webui`, so name `webui` explicitly. + This mode also requires `--webui-session-secret` and `--plugin-dir`. + For the requirements and the full startup command, see + [Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). +{{% /show-in %}} + > [!Caution] > #### Create your admin token before you expose the server > From 3ad42e656bf66234315a48bcabaed6550fd83d60 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 2 Sep 2026 12:57:34 -0500 Subject: [PATCH 03/10] docs(explorer): add exec-plan for install version routing What changed: Adds docs/exec-plans/2026-09-02-explorer-install-version-routing.md, the decision record for restructuring the InfluxDB 3 Explorer install documentation ahead of the v1.10 release. Why: Explorer v1.9 is the last release distributed as a standalone Docker container. Starting with v1.10, Explorer is included with InfluxDB 3 Enterprise and deployed as WebAssembly (WASM). The current pages state no version or edition scope, so readers, search engines, retrieval systems, and coding agents all get Docker as the unconditional answer to "how do I install Explorer". Impact: Documentation only. No content or template changes in this commit. The record fixes the approach before implementation: keep the /influxdb3/explorer/install/ URL as a version-routing hub, move the Docker body to a child page that declares its version ceiling, and use existing frontmatter (metadata, cascade.prepend) instead of new template logic. Verification: None required for this commit. The exec-plan lists the verification steps for the implementation that follows. Claude-Session: https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7 --- ...-09-02-explorer-install-version-routing.md | 128 ++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 docs/exec-plans/2026-09-02-explorer-install-version-routing.md diff --git a/docs/exec-plans/2026-09-02-explorer-install-version-routing.md b/docs/exec-plans/2026-09-02-explorer-install-version-routing.md new file mode 100644 index 0000000000..f4955e086a --- /dev/null +++ b/docs/exec-plans/2026-09-02-explorer-install-version-routing.md @@ -0,0 +1,128 @@ +# Explorer install docs: route by version and edition + +**Status:** In progress — branch `explorer-v1.10-install-restructure` +**Closes:** [#6702](https://github.com/influxdata/docs-v2/issues/6702) + +## Goal + +Restructure the InfluxDB 3 Explorer install documentation so that each page +states which Explorer versions and which InfluxDB 3 editions it applies to. +After this change, `/influxdb3/explorer/install/` routes readers by version +instead of presenting Docker as the only deployment method, and the Docker +instructions live on a child page that declares its version ceiling in +frontmatter, in the lede, and in the Markdown twin. + +## Why now + +Explorer v1.9 is the last release distributed as a standalone Docker container. +Starting with v1.10, Explorer is included with InfluxDB 3 Enterprise and is +deployed as WebAssembly (WASM). The current pages have no version or edition +scoping: + +- `content/influxdb3/explorer/install.md` documents only Docker. +- `content/influxdb3/explorer/_index.md` repeats a `docker pull` quick start. +- `content/influxdb3/explorer/about/_index.md` states full Core and Enterprise + support with no end version. +- `data/products.yml` lists `Docker` in `schema.operating_system`, which feeds + the JSON-LD `SoftwareApplication` node. + +Each of these tells readers, search engines, retrieval systems, and coding +agents that Explorer is a Docker container that works with Core. Doing the +restructure before v1.10 ships means the corpus and search index carry the +version scoping before the release changes the answer. + +Issue #6702 reports the related gap: the docs never state outright which +distributions exist, so a docs-grounded assistant can only infer the +limitation. + +## Decisions + +- **Keep `/influxdb3/explorer/install/` as the URL and convert it to a + version-routing hub.** The URL holds the search ranking, seven inbound + in-repo links (three of them deep anchors), the `llms.txt` corpus entry, and + any existing model memory. Moving the page under `/get-started/` or demoting + it in the navigation would break those without addressing the actual problem, + which is the page content, not its address. +- **Move the Docker body to `install/docker.md` unchanged.** Keeping the body + intact preserves the three anchors that other pages link to: + `#choose-operational-mode`, `#network-exposure-and-access-control`, and + `#set-file-permissions-for-upgrades`. +- **Do not redirect `/install/` to `/install/docker/`.** A redirect would send + every "install Explorer" search result and every agent's first URL guess to + the deprecated path. +- **Use `metadata: [Explorer v1.9 and earlier]` rather than + `introduced`/`deprecated`.** Both render into the `ul.metadata` list under the + h1 and into the first line of the Markdown twin, verified against + `/influxdb3/clustered/reference/cli/influxctl/query/index.md` (`* influxctl + 2.4.0+`) and `/telegraf/v1/input-plugins/jenkins/index.md` (`* Telegraf + v1.9.0+`). The `introduced`/`deprecated` pair renders as a range + ("v1.0.0 – v1.10.0"), which is ambiguous about the last working release. + `metadata` states the ceiling exactly. +- **Keep the Docker page published and indexed.** Explorer v1.9 remains + supported, and removing or hiding the instructions creates a retrieval dead + end. A page that states its own version ceiling is not misleading. +- **Use `cascade.prepend` on `explorer/_index.md` for the transition notice, + not a template banner.** `article/stable-version.html` is gated on a + hardcoded product whitelist and a `/vN/` URL segment, neither of which + applies to Explorer, and extending it would add magic values to a template + (see `.claude/rules/layouts.md`). `article/special-state.html` has the same + problem. `cascade.prepend` is documented in `DOCS-FRONTMATTER.md` and needs no + template change. +- **Accept the twin cost of the cascaded notice, and remove it after v1.11.** + Prepended content appears in every Explorer Markdown twin and in + `llms-full.txt`, which makes the first chunk of all 12 Explorer pages more + alike (the twin-hygiene problem tracked in + [#7323](https://github.com/influxdata/docs-v2/issues/7323)). The notice is + three lines and is worth that cost while the transition is live. +- **Document version verification with `GET /ping`, not only + `influxdb3 --version`.** WASM availability depends on the InfluxDB 3 server + version and build, not on Explorer alone. `GET /ping` returns + `x-influxdb-version` and `x-influxdb-build` (`Core` or `Enterprise`) in + headers and `version` in the body + (`api-docs/influxdb3/enterprise/influxdb3-enterprise-openapi.yaml`), so one + command answers both questions and works headlessly against a remote + instance. A `HEAD` request returns 404, so the docs specify `GET`. + +## Explicitly out of scope + +- WASM deployment instructions under `/influxdb3/enterprise/`. Those wait until + v1.10 ships; this change only prepares the routing and cross-links. +- `data/products.yml` updates to `latest_patch` and `schema.operating_system`. + Both change on release day, not before. +- The `localhost` connection failure reported in + [#7333](https://github.com/influxdata/docs-v2/issues/7333). It affects the + Docker instructions but is a separate content fix. +- Extending `article/stable-version.html` to support products without a `/vN/` + URL segment. + +## How to update + +The Explorer version ceiling appears in four places on +`content/influxdb3/explorer/install/docker.md`: the `metadata` frontmatter, the +`description` frontmatter, the lede, and the transition notice cascaded from +`content/influxdb3/explorer/_index.md`. Update the notice in `_index.md` once +and it changes on every Explorer page. Remove the `cascade.prepend` block when +v1.11 ships. + +## Verification + +1. `npx hugo --quiet` builds without errors. +2. Confirm the three anchors still resolve within `install/docker/`, and that no + in-repo link points at `/influxdb3/explorer/install/#` for a Docker-only + section. +3. `yarn check:md-coherence` confirms the head link, `sitemap-md.xml`, and + corpus surfaces agree after the URL structure changes. +4. Run the Cypress navigation tests. Converting a single page to a section + changes the menu tree. +5. After deploy, check the published Markdown twins. PR previews return 404 for + twins, so use production or staging: + + ```sh + curl -s --compressed https://docs.influxdata.com/influxdb3/explorer/install/index.md | head -20 + curl -s --compressed https://docs.influxdata.com/influxdb3/explorer/install/docker/index.md | head -20 + ``` + + The Docker twin starts with `* Explorer v1.9 and earlier` above the lede. +6. Ask the documentation MCP server "How do I install InfluxDB 3 Explorer?" + after the corpus rebuilds. The answer routes by version instead of returning + `docker run`. From 85635784cae8949d08eeeb40ac212f090d932add Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 2 Sep 2026 12:58:18 -0500 Subject: [PATCH 04/10] docs(explorer): link PR in exec-plan status Claude-Session: https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7 --- docs/exec-plans/2026-09-02-explorer-install-version-routing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/exec-plans/2026-09-02-explorer-install-version-routing.md b/docs/exec-plans/2026-09-02-explorer-install-version-routing.md index f4955e086a..de049644eb 100644 --- a/docs/exec-plans/2026-09-02-explorer-install-version-routing.md +++ b/docs/exec-plans/2026-09-02-explorer-install-version-routing.md @@ -1,6 +1,6 @@ # Explorer install docs: route by version and edition -**Status:** In progress — branch `explorer-v1.10-install-restructure` +**Status:** In review — PR [#7734](https://github.com/influxdata/docs-v2/pull/7734) **Closes:** [#6702](https://github.com/influxdata/docs-v2/issues/6702) ## Goal From 9ca0b7b6c934c6696710bb7478bad2b9b74e66d6 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 2 Sep 2026 13:29:52 -0500 Subject: [PATCH 05/10] docs(explorer): add version availability conventions and release readiness plan What changed: - Adds DOCS-VERSION-AVAILABILITY.md, which documents how to state a version or edition constraint: which marker to use for page-wide versus section-level scope, which surface carries which fact, where a page lives when a feature spans two products, the version-check pattern, and how temporary notices are retired. - Adds docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md, the ordered pre-release, release-day, and post-release task sequence for the Explorer v1.10 and InfluxDB 3 Enterprise release. - Lists the new reference in AGENTS.md and regenerates the instruction adapters. Why: The install restructure exec-plan prepares version routing but leaves the WASM instructions, products.yml updates, and hub lede flip until v1.10 ships. The release sequence needs to exist before release day. The conventions are feature-agnostic and apply to any version-gated documentation, so they belong in a durable reference rather than in a per-release plan. Impact: Documentation for contributors and agents. No published content changes. The conventions reference links to DOCS-FRONTMATTER.md and DOCS-AI-VISIBILITY.md instead of restating field syntax or artifact layers. It records that data/notifications.yaml renders in the footer and therefore never reaches Markdown twins or llms-full.txt, so a version fact stated only in a notification is invisible to AI consumers. Verification: yarn build:agent:instructions and yarn validate:agent-instructions both pass. Markdown lint passes on the new files. Claude-Session: https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7 --- DOCS-VERSION-AVAILABILITY.md | 107 ++++++++++++++++ ...6-09-02-explorer-v110-release-readiness.md | 118 ++++++++++++++++++ 2 files changed, 225 insertions(+) create mode 100644 DOCS-VERSION-AVAILABILITY.md create mode 100644 docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md diff --git a/DOCS-VERSION-AVAILABILITY.md b/DOCS-VERSION-AVAILABILITY.md new file mode 100644 index 0000000000..a7ef6f7411 --- /dev/null +++ b/DOCS-VERSION-AVAILABILITY.md @@ -0,0 +1,107 @@ +# Documenting version availability + +How to state which product versions and editions a page or feature applies to. + +This page covers the decisions: which marker to use, which surface carries +which fact, where a page lives, and when a notice is removed. +For field syntax, see [DOCS-FRONTMATTER.md](DOCS-FRONTMATTER.md). +For how Markdown twins and corpora are published, see +[DOCS-AI-VISIBILITY.md](DOCS-AI-VISIBILITY.md). + +## Choose a marker + +Match the marker to the scope of the version constraint. + +| Scope | Use | Example | +| ---------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------- | +| The whole page applies to a version range | `metadata:` frontmatter | `metadata: [Explorer v1.9 and earlier]` | +| The whole page is one of a generated set with a real range | `introduced`, `deprecated`, `removed` frontmatter | `introduced: "v1.9.0"` | +| One section applies to a version range | Heading attribute | `## Configure user auth {metadata="v1.10+"}` | + +Use `metadata:` when you need to state a ceiling or an exact phrase. +The `introduced`/`deprecated`/`removed` fields render as a range, such as +"InfluxDB 3 Explorer v1.0.0 – v1.10.0", which doesn't say which release is the +last working one. +Telegraf plugin pages use the range fields because the values are generated +from plugin metadata. + +Don't state a version constraint only in body text. +Frontmatter markers render in a list under the page h1 and appear above the +lede in the page's Markdown twin, which is the text a retrieval system reads +first. + +## Choose a surface + +Each surface reaches a different audience. +Decide which one carries the fact before you write it. + +| Surface | Reaches | Use for | +| ------------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------- | +| Frontmatter markers and the lede | Readers, search engines, Markdown twins, `llms-full.txt` | Any version or edition fact a reader or an agent needs to act correctly | +| `prepend` / `append` frontmatter (with `cascade`) | Same as above, on every page it cascades to | A transition notice that must appear in the twin | +| `data/notifications.yaml` | Readers only | A dated announcement, such as a release or a scheduled change | + +Notifications render in the site footer through +`layouts/partials/footer/notifications.html`, outside the article element. +They don't appear in Markdown twins or in `llms-full.txt`. +A fact that exists only in a notification is invisible to every AI consumer of +the docs, so don't use a notification as the only statement of a version +requirement. + +Cascaded `prepend` content appears in the twin of every page it reaches, which +makes the first chunk of those pages similar to each other. +Keep cascaded notices to a few lines, and remove them when the transition ends. + +## Place a feature page + +When a feature spans two products, such as a UI feature that depends on a +server capability: + +1. Put the canonical page in the product that owns the behavior. +2. Add `alt_links` so the product switcher moves readers to the equivalent page + in the other product. +3. Add `related` entries from the other product's page. + +Don't duplicate the instructions in both products. +If both products need the same body, use `source:` to share the content and set +`canonical: self` on the page whose URL marks the product identity. + +## Include a version check + +A page that documents a version-gated feature states how to verify the version, +or links to a page that does. +Give both a local check and a check that works against a running instance, so +that a reader without shell access to the server can still confirm the version. + +Local: + +```bash +influxdb3 --version +``` + +Running instance: + +```sh +curl --get "http://localhost:8181/ping" \ + --header "Authorization: Bearer AUTH_TOKEN" +``` + +The `/ping` response includes the `x-influxdb-version` and `x-influxdb-build` +headers, and `version` and `revision` in the body. +Because `x-influxdb-build` reports `Core` or `Enterprise`, `/ping` is the only +check that answers both the version question and the edition question. +Use `GET`; a `HEAD` request returns `404`. + +## Retire a notice + +Every temporary notice names the release that removes it. + +- For a `cascade.prepend` notice, record the removal release in the exec-plan + for the change that added it. +- For a `data/notifications.yaml` entry, record the removal release with the + entry `id`, so the entry can be found and deleted without reading the message + text. + +Version markers in frontmatter are permanent. +They describe a fact about the release, not a temporary state, so leave them in +place after the transition ends. diff --git a/docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md b/docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md new file mode 100644 index 0000000000..a32b5bb397 --- /dev/null +++ b/docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md @@ -0,0 +1,118 @@ +# Explorer v1.10 release readiness + +**Status:** In progress — PR [#7734](https://github.com/influxdata/docs-v2/pull/7734) +**Refs:** [2026-09-02-explorer-install-version-routing.md](2026-09-02-explorer-install-version-routing.md) + +## Goal + +Define the documentation work to complete before and on the day InfluxDB 3 +Explorer v1.10 and the accompanying InfluxDB 3 Enterprise release ship. +The sequence applies regardless of which features the release contains. +Feature-specific content, such as user authorization, follows the same steps. + +## Why now + +The install restructure in the referenced exec-plan prepares the version +routing but stops short of the release itself. It deliberately leaves the WASM +deployment instructions, the `data/products.yml` updates, and the hub lede flip +until v1.10 ships. This plan records that remaining work as an ordered sequence +so the release day doesn't depend on someone reconstructing it. + +The conventions the release work follows are documented separately in +[DOCS-VERSION-AVAILABILITY.md](../../DOCS-VERSION-AVAILABILITY.md), which this +plan applies rather than restates. + +## Decisions + +- **Feature pages are drafted before the release, not written on the day.** + Each new page carries its version metadata, its version-verification step, + and its cross-product links from the first commit. Publishing then becomes a + frontmatter change rather than an authoring task. +- **Use `data/notifications.yaml` for the release announcement, and keep the + version facts in the pages.** Notifications render in the footer, outside the + article, so they don't appear in Markdown twins or `llms-full.txt`. The + announcement is for readers; the version scope that agents and retrieval + systems need stays in frontmatter and the lede. +- **Add the notification as a commented-out stub before the release.** The + `influxdb3-cloud-ga` entry in `data/notifications.yaml` already uses this + pattern: a commented block with a checklist of what to confirm before it goes + live. Uncommenting is a one-line release-day action. +- **Order the release-day steps so no published page contradicts another at any + point.** Feature pages publish first, then the hub lede flips to lead with + WASM, then `data/products.yml` changes. Reversing that order leaves the hub + pointing at unpublished pages. +- **Retire notices by identifier, not by search.** The `cascade.prepend` + transition notice and the notification entry are both removed at v1.11, and + both are named here so the removal doesn't depend on finding them again. +- **The install restructure exec-plan stays as written.** This plan follows it. + Where the two describe the same file, the restructure plan describes the + pre-release state and this plan describes the release-day change. + +## Pre-release tasks + +1. Draft each new feature page with `draft: true`. + Apply the version marker for the feature's availability, per + [DOCS-VERSION-AVAILABILITY.md](../../DOCS-VERSION-AVAILABILITY.md). + Use a page-level `metadata:` entry when the whole page is new in v1.10, and + a heading attribute such as `{metadata="v1.10+"}` when only a section is. +2. Include the version-check step on each feature page, or link to the section + of the install hub that documents it. +3. Add `alt_links` in both directions between the Explorer page and the + InfluxDB 3 Enterprise page that documents the server side of the feature. +4. Add the WASM deployment instructions to the InfluxDB 3 Enterprise section, + including the server version that introduced them. +5. Add a commented-out entry to `data/notifications.yaml` with the final `id`, + `scope`, `title`, and `slug`, and a comment listing what to confirm before + uncommenting. +6. Draft the release notes entry in + `content/influxdb3/explorer/release-notes/_index.md`. + +## Release-day tasks + +Complete in this order. + +1. Remove `draft: true` from the feature pages. +2. Update the install hub lede at + `content/influxdb3/explorer/install/_index.md` so the WASM path is described + first and Docker reads as the path for v1.9 and earlier. +3. Update `data/products.yml`: set `latest_patch` to the new Explorer version, + and update `schema.operating_system`, which currently lists `Docker` and + feeds the JSON-LD `SoftwareApplication` node. +4. Publish the release notes entry. +5. Uncomment the `data/notifications.yaml` entry. +6. Verify the published surfaces (see Verification). + +## Post-release tasks + +At the v1.11 release: + +1. Delete the `data/notifications.yaml` entry by `id`. +2. Remove the `cascade.prepend` transition notice from + `content/influxdb3/explorer/_index.md`. +3. Leave all frontmatter version markers in place. They state a fact about the + release, not a temporary condition. + +## Verification + +1. `npx hugo --quiet` builds without errors. + +2. `yarn check:md-coherence` confirms the head links, `sitemap-md.xml`, and + corpus surfaces agree after pages are published. + +3. Confirm the notification renders on the scoped paths and doesn't render on + the excluded ones. + +4. After deploy, confirm the version marker leads each new page's Markdown + twin. PR previews return 404 for twins, so use production or staging: + + ```sh + curl -s --compressed https://docs.influxdata.com/influxdb3/explorer//index.md | head -20 + ``` + +5. Confirm the notification text doesn't appear in the twin or in + `https://docs.influxdata.com/influxdb3/explorer/llms-full.txt`. Notifications + are footer content; if the text appears in either file, it was added to the + wrong surface. + +6. Ask the documentation MCP server how to install Explorer and how to use the + new feature. Both answers state the version requirement. From e588a26447161a66eb70b059f775dfde1e1d7512 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Wed, 2 Sep 2026 14:01:25 -0500 Subject: [PATCH 06/10] docs(explorer): tighten release readiness plan What changed: Slims the release readiness exec-plan to the v1.10 release. Adds the decision that every new feature page shows the reader how to check whether their version has the feature, covering both the Explorer version and the InfluxDB 3 server version and edition. Replaces the draft:true default with merging at release, keeping draft:true for specific cases such as a link target other merged content needs. Why: The first draft stated version markers but not how a reader arriving from search determines which version they're running, and it assumed a publishing workflow the team doesn't use. Impact: Planning document only. Verification: Markdown lint passes. Claude-Session: https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7 --- ...6-09-02-explorer-v110-release-readiness.md | 139 ++++++++---------- 1 file changed, 60 insertions(+), 79 deletions(-) diff --git a/docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md b/docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md index a32b5bb397..cf657c0286 100644 --- a/docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md +++ b/docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md @@ -5,114 +5,95 @@ ## Goal -Define the documentation work to complete before and on the day InfluxDB 3 -Explorer v1.10 and the accompanying InfluxDB 3 Enterprise release ship. -The sequence applies regardless of which features the release contains. -Feature-specific content, such as user authorization, follows the same steps. - -## Why now - -The install restructure in the referenced exec-plan prepares the version -routing but stops short of the release itself. It deliberately leaves the WASM -deployment instructions, the `data/products.yml` updates, and the hub lede flip -until v1.10 ships. This plan records that remaining work as an ordered sequence -so the release day doesn't depend on someone reconstructing it. - -The conventions the release work follows are documented separately in -[DOCS-VERSION-AVAILABILITY.md](../../DOCS-VERSION-AVAILABILITY.md), which this -plan applies rather than restates. +Define the documentation work for the InfluxDB 3 Explorer v1.10 release and the +InfluxDB 3 Enterprise release that carries it. The install restructure prepares +the version routing; this plan covers what changes when v1.10 ships. ## Decisions -- **Feature pages are drafted before the release, not written on the day.** - Each new page carries its version metadata, its version-verification step, - and its cross-product links from the first commit. Publishing then becomes a - frontmatter change rather than an authoring task. +- **Every new feature page tells the reader how to check whether their version + has the feature.** A version marker states the requirement, but a reader + arriving from search doesn't know which version they're running. Each feature + page states the requirement and shows the check, or links to the check in the + install hub. See + [DOCS-VERSION-AVAILABILITY.md](../../DOCS-VERSION-AVAILABILITY.md). +- **The check covers both the Explorer version and the InfluxDB 3 server + version and edition.** A v1.10 feature can require both. `GET /ping` returns + `x-influxdb-version` and `x-influxdb-build` (`Core` or `Enterprise`), so it + answers the server half in one request, including against a remote instance. +- **Merge at release rather than publishing with `draft: true`.** Content pages + merge on release day. Use `draft: true` only when a page must exist in the + branch before the release for a specific reason, such as a link target that + other merged content depends on. - **Use `data/notifications.yaml` for the release announcement, and keep the version facts in the pages.** Notifications render in the footer, outside the article, so they don't appear in Markdown twins or `llms-full.txt`. The announcement is for readers; the version scope that agents and retrieval systems need stays in frontmatter and the lede. -- **Add the notification as a commented-out stub before the release.** The - `influxdb3-cloud-ga` entry in `data/notifications.yaml` already uses this - pattern: a commented block with a checklist of what to confirm before it goes - live. Uncommenting is a one-line release-day action. -- **Order the release-day steps so no published page contradicts another at any - point.** Feature pages publish first, then the hub lede flips to lead with - WASM, then `data/products.yml` changes. Reversing that order leaves the hub - pointing at unpublished pages. -- **Retire notices by identifier, not by search.** The `cascade.prepend` - transition notice and the notification entry are both removed at v1.11, and - both are named here so the removal doesn't depend on finding them again. -- **The install restructure exec-plan stays as written.** This plan follows it. - Where the two describe the same file, the restructure plan describes the - pre-release state and this plan describes the release-day change. - -## Pre-release tasks - -1. Draft each new feature page with `draft: true`. - Apply the version marker for the feature's availability, per - [DOCS-VERSION-AVAILABILITY.md](../../DOCS-VERSION-AVAILABILITY.md). - Use a page-level `metadata:` entry when the whole page is new in v1.10, and - a heading attribute such as `{metadata="v1.10+"}` when only a section is. -2. Include the version-check step on each feature page, or link to the section - of the install hub that documents it. -3. Add `alt_links` in both directions between the Explorer page and the - InfluxDB 3 Enterprise page that documents the server side of the feature. -4. Add the WASM deployment instructions to the InfluxDB 3 Enterprise section, +- **Order the release-day merge so no published page points at an unpublished + one.** Feature pages first, then the install hub lede, then + `data/products.yml`. + +## Before the release + +1. Write each new feature page with its version marker: page-level `metadata:` + when the whole page is new in v1.10, a `{metadata="v1.10+"}` heading + attribute when only a section is. +2. Add the version check to each feature page. State the Explorer version the + feature requires and, when the feature depends on the server, the InfluxDB 3 + version and edition. Show the `/ping` request or link to the check in the + install hub. +3. Add the WASM deployment instructions to the InfluxDB 3 Enterprise section, including the server version that introduced them. -5. Add a commented-out entry to `data/notifications.yaml` with the final `id`, - `scope`, `title`, and `slug`, and a comment listing what to confirm before - uncommenting. -6. Draft the release notes entry in +4. Add `alt_links` in both directions between each Explorer feature page and + the Enterprise page that documents the server side. +5. Write the release notes entry in `content/influxdb3/explorer/release-notes/_index.md`. +6. Add a commented-out `data/notifications.yaml` entry with the final `id`, + `scope`, `title`, and `slug`, following the `influxdb3-cloud-ga` stub + already in that file. -## Release-day tasks - -Complete in this order. +## On release day -1. Remove `draft: true` from the feature pages. -2. Update the install hub lede at - `content/influxdb3/explorer/install/_index.md` so the WASM path is described - first and Docker reads as the path for v1.9 and earlier. -3. Update `data/products.yml`: set `latest_patch` to the new Explorer version, - and update `schema.operating_system`, which currently lists `Docker` and - feeds the JSON-LD `SoftwareApplication` node. -4. Publish the release notes entry. -5. Uncomment the `data/notifications.yaml` entry. -6. Verify the published surfaces (see Verification). +Merge in this order. -## Post-release tasks +1. Feature pages and the Enterprise WASM deployment page. +2. The install hub lede at `content/influxdb3/explorer/install/_index.md`, so + the WASM path is described first and Docker reads as the path for v1.9 and + earlier. +3. `data/products.yml`: set `latest_patch` to the new Explorer version and + update `schema.operating_system`, which lists `Docker` and feeds the JSON-LD + `SoftwareApplication` node. +4. The release notes entry. +5. The `data/notifications.yaml` entry, uncommented. -At the v1.11 release: +## At v1.11 1. Delete the `data/notifications.yaml` entry by `id`. 2. Remove the `cascade.prepend` transition notice from `content/influxdb3/explorer/_index.md`. -3. Leave all frontmatter version markers in place. They state a fact about the - release, not a temporary condition. +3. Leave the frontmatter version markers. They state a fact about the release, + not a temporary condition. ## Verification 1. `npx hugo --quiet` builds without errors. 2. `yarn check:md-coherence` confirms the head links, `sitemap-md.xml`, and - corpus surfaces agree after pages are published. + corpus surfaces agree after the new pages publish. -3. Confirm the notification renders on the scoped paths and doesn't render on - the excluded ones. +3. The notification renders on its scoped paths and not on the excluded ones. -4. After deploy, confirm the version marker leads each new page's Markdown - twin. PR previews return 404 for twins, so use production or staging: +4. After deploy, the version marker leads each new page's Markdown twin. PR + previews return 404 for twins, so use production or staging: ```sh curl -s --compressed https://docs.influxdata.com/influxdb3/explorer//index.md | head -20 ``` -5. Confirm the notification text doesn't appear in the twin or in - `https://docs.influxdata.com/influxdb3/explorer/llms-full.txt`. Notifications - are footer content; if the text appears in either file, it was added to the - wrong surface. +5. The notification text appears in neither the twins nor + `https://docs.influxdata.com/influxdb3/explorer/llms-full.txt`. If it does, + it was added to the wrong surface. -6. Ask the documentation MCP server how to install Explorer and how to use the - new feature. Both answers state the version requirement. +6. Ask the documentation MCP server how to use a new v1.10 feature. The answer + states the version requirement and how to check it. From 70e50f370b5a6e242a045eb1c60ad1855d975073 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Thu, 17 Sep 2026 18:13:38 +0000 Subject: [PATCH 07/10] docs(explorer): restructure install docs to route by version and edition Convert /influxdb3/explorer/install/ into a version-routing hub and move the Docker instructions to install/docker.md with an explicit version ceiling (v1.9 and earlier). Explorer v1.10+ ships with InfluxDB 3 Enterprise as WASM instead of a standalone container, so the old Docker-only page misled readers and retrieval systems about the current distribution model. - install/docker.md: metadata frontmatter states the version ceiling in the frontmatter, description, and lede; anchors are unchanged. - install/_index.md: new hub that routes by version/edition and shows the GET /ping check. - explorer/_index.md: cascade.prepend transition notice and a version-branched quick start. - about/_index.md: states the v1.9/v1.10 distribution split. - Seven inbound links updated to point at the hub or install/docker/#anchor. Implements the restructure described in PR #7734's linked exec-plan (docs/exec-plans/2026-09-02-explorer-install-version-routing.md). --- .../enterprise/visualize-data/explorer.md | 6 +-- content/influxdb3/explorer/_index.md | 40 ++++++++++++------- content/influxdb3/explorer/about/_index.md | 7 ++++ content/influxdb3/explorer/get-started.md | 2 +- content/influxdb3/explorer/install/_index.md | 40 +++++++++++++++++++ .../{install.md => install/docker.md} | 17 +++++--- .../influxdb3/explorer/manage-databases.md | 2 +- content/influxdb3/explorer/manage-tokens.md | 2 +- .../explorer/release-notes/_index.md | 2 +- 9 files changed, 92 insertions(+), 26 deletions(-) create mode 100644 content/influxdb3/explorer/install/_index.md rename content/influxdb3/explorer/{install.md => install/docker.md} (97%) diff --git a/content/influxdb3/enterprise/visualize-data/explorer.md b/content/influxdb3/enterprise/visualize-data/explorer.md index f283fecf87..8c66d65e82 100644 --- a/content/influxdb3/enterprise/visualize-data/explorer.md +++ b/content/influxdb3/enterprise/visualize-data/explorer.md @@ -47,7 +47,7 @@ To serve Explorer from your server, you need the following: - {{% product-name %}} v3.11 or later. For earlier releases, run the - [Explorer Docker container](/influxdb3/explorer/install/). + [Explorer Docker container](/influxdb3/explorer/install/docker/). - A session secret. {{% product-name %}} requires [`--webui-session-secret`](/influxdb3/enterprise/reference/config-options/#webui-session-secret) @@ -162,7 +162,7 @@ The integrated Explorer keeps its application state in a SQLite database that the server synchronizes to object storage for each cluster. You don't mount a volume to persist it, which is the main operational difference from the -[Explorer Docker container](/influxdb3/explorer/install/#persist-data-across-restarts). +[Explorer Docker container](/influxdb3/explorer/install/docker/#persist-data-across-restarts). ## Enable AI chat @@ -204,4 +204,4 @@ option in a specific build. --> Use the container when you run Core, when you run an Enterprise release earlier than v3.11, or when you want Explorer to run separately from the database server--for example, on an operator workstation. -See [Install and run InfluxDB 3 Explorer](/influxdb3/explorer/install/). +See [Install and run InfluxDB 3 Explorer with Docker](/influxdb3/explorer/install/docker/). diff --git a/content/influxdb3/explorer/_index.md b/content/influxdb3/explorer/_index.md index a3bb240a38..3ad6ceef68 100644 --- a/content/influxdb3/explorer/_index.md +++ b/content/influxdb3/explorer/_index.md @@ -9,6 +9,16 @@ weight: 1 cascade: product: influxdb3_explorer version: explorer + prepend: | + > [!Important] + > #### Explorer's distribution model is changing in v1.10 + > + > Starting with v1.10, Explorer is included with + > [InfluxDB 3 Enterprise](/influxdb3/enterprise/) and runs as WebAssembly + > (WASM) instead of a standalone Docker container. Explorer v1.9 and + > earlier remains available as Docker. See + > [Install Explorer](/influxdb3/explorer/install/) to find the + > instructions for your version. --- InfluxDB 3 Explorer is the standalone web application designed for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise. @@ -24,23 +34,25 @@ Use InfluxDB 3 Explorer for: ## Quick start -Run the Docker image to start InfluxDB 3 Explorer: +How you install {{% product-name %}} depends on your version: -```sh -# Pull the Docker image -docker pull influxdata/influxdb3-ui +- **v1.10 and later** is included with InfluxDB 3 Enterprise and runs as WASM. +- **v1.9 and earlier** runs as a standalone Docker container: -# Run the Docker container -docker run --detach \ - --name influxdb3-explorer \ - --publish 8080:8080 \ - --publish 8443:8443 \ - influxdata/influxdb3-ui \ - --mode=admin + ```sh + # Pull the Docker image + docker pull influxdata/influxdb3-ui -# Visit http://localhost:8080 in your browser to begin using InfluxDB 3 Explorer -``` + # Run the Docker container + docker run --detach \ + --name influxdb3-explorer \ + --publish 8080:8080 \ + --publish 8443:8443 \ + influxdata/influxdb3-ui \ + --mode=admin + # Visit http://localhost:8080 in your browser to begin using InfluxDB 3 Explorer + ``` -For installation and configuration options, see [Install and run InfluxDB 3 Explorer](/influxdb3/explorer/install/). +For installation and configuration options, see [Install InfluxDB 3 Explorer](/influxdb3/explorer/install/). Get started using InfluxDB 3 Explorer diff --git a/content/influxdb3/explorer/about/_index.md b/content/influxdb3/explorer/about/_index.md index 98a9a5cc50..eb072f9a90 100644 --- a/content/influxdb3/explorer/about/_index.md +++ b/content/influxdb3/explorer/about/_index.md @@ -18,6 +18,13 @@ Explorer is fully featured for [InfluxDB 3 Core](/influxdb3/core/) and [InfluxDB 3 Enterprise](/influxdb3/enterprise/). You can use Explorer to query data in and administer these products. +Explorer v1.9 and earlier runs as a standalone Docker container that works +with either Core or Enterprise. Starting with Explorer v1.10, Explorer is +included with InfluxDB 3 Enterprise and runs as WebAssembly (WASM); it isn't +distributed separately for Core. See +[Install Explorer](/influxdb3/explorer/install/) to find the instructions for +your version. + Explorer provides only _partial_ support for [InfluxDB Cloud Dedicated](/influxdb3/cloud-dedicated/) and [InfluxDB Cloud Serverless](/influxdb3/cloud-serverless/). diff --git a/content/influxdb3/explorer/get-started.md b/content/influxdb3/explorer/get-started.md index d46988ff37..409afce6e8 100644 --- a/content/influxdb3/explorer/get-started.md +++ b/content/influxdb3/explorer/get-started.md @@ -86,7 +86,7 @@ InfluxDB 3 Explorer supports the following InfluxDB 3 products: > The token's permissions also define what anyone with access to this > Explorer instance can do. Use a token scoped to what you need, and > control who can reach Explorer. See - > [Network exposure and access control](/influxdb3/explorer/install/#network-exposure-and-access-control). + > [Network exposure and access control](/influxdb3/explorer/install/docker/#network-exposure-and-access-control). 4. Click **Add Server**. diff --git a/content/influxdb3/explorer/install/_index.md b/content/influxdb3/explorer/install/_index.md new file mode 100644 index 0000000000..dfce5bcff4 --- /dev/null +++ b/content/influxdb3/explorer/install/_index.md @@ -0,0 +1,40 @@ +--- +title: Install InfluxDB 3 Explorer +description: > + Install and run InfluxDB 3 Explorer. Instructions depend on your Explorer + version--Docker for v1.9 and earlier, or WASM with InfluxDB 3 Enterprise + for v1.10 and later. +menu: + influxdb3_explorer: + name: Install Explorer +weight: 2 +--- + +How you install {{% product-name %}} depends on which version you're +installing: + +- **Explorer v1.10 and later** is included with + [InfluxDB 3 Enterprise](/influxdb3/enterprise/) and runs as WebAssembly + (WASM)--there's no separate container to install. For deployment + instructions, see the InfluxDB 3 Enterprise documentation. +- **Explorer v1.9 and earlier** is a standalone Docker container. For + installation and configuration instructions, see + [Install and run InfluxDB 3 Explorer with Docker](/influxdb3/explorer/install/docker/). + +## Check which version applies to you + +If you already have an InfluxDB 3 server running, check its version and +edition with `GET /ping`: + +```sh +curl --get "http://localhost:8181/ping" \ + --header "Authorization: Bearer AUTH_TOKEN" +``` + +The response includes the `x-influxdb-version` and `x-influxdb-build` headers +(`Core` or `Enterprise`), and `version` in the body. Use `GET`; a `HEAD` +request to `/ping` returns `404`. + +If you're installing InfluxDB 3 Enterprise 1.10 or later, Explorer is already +included--go to the Enterprise deployment instructions. Otherwise, use +[Docker](/influxdb3/explorer/install/docker/). diff --git a/content/influxdb3/explorer/install.md b/content/influxdb3/explorer/install/docker.md similarity index 97% rename from content/influxdb3/explorer/install.md rename to content/influxdb3/explorer/install/docker.md index 7e9f0ede7b..6d65df8e32 100644 --- a/content/influxdb3/explorer/install.md +++ b/content/influxdb3/explorer/install/docker.md @@ -1,14 +1,21 @@ --- -title: Install and run InfluxDB 3 Explorer +title: Install and run InfluxDB 3 Explorer with Docker description: > - Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**. + Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer + v1.9 and earlier**, the last release distributed as a standalone container. menu: influxdb3_explorer: - name: Install Explorer -weight: 2 + name: Docker +weight: 1 +metadata: [Explorer v1.9 and earlier] --- -Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**. +Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer +v1.9 and earlier**, the last release distributed as a standalone container. +Starting with v1.10, Explorer is included with +[InfluxDB 3 Enterprise](/influxdb3/enterprise/) and deployed as WebAssembly +(WASM); see [Install Explorer](/influxdb3/explorer/install/) to choose the +instructions for your version. > [!Important] > #### Control who can reach Explorer diff --git a/content/influxdb3/explorer/manage-databases.md b/content/influxdb3/explorer/manage-databases.md index 2759afeea2..6e984d4228 100644 --- a/content/influxdb3/explorer/manage-databases.md +++ b/content/influxdb3/explorer/manage-databases.md @@ -17,7 +17,7 @@ or InfluxDB 3 Enterprise cluster. > [!Important] > Using {{% product-name %}} to manage a database in InfluxDB 3 requires that -> Explorer is running in [admin mode](/influxdb3/explorer/install/#choose-operational-mode) +> Explorer is running in [admin mode](/influxdb3/explorer/install/docker/#choose-operational-mode) > and that the token used in the InfluxDB 3 server configuration is an > [admin token](/influxdb3/enterprise/admin/tokens/admin/). diff --git a/content/influxdb3/explorer/manage-tokens.md b/content/influxdb3/explorer/manage-tokens.md index 7034aa690d..0e26699c6d 100644 --- a/content/influxdb3/explorer/manage-tokens.md +++ b/content/influxdb3/explorer/manage-tokens.md @@ -17,7 +17,7 @@ Core instance or InfluxDB 3 Enterprise cluster. > [!Important] > Using {{% product-name %}} to manage authorization tokens in InfluxDB 3 requires that -> Explorer is running in [admin mode](/influxdb3/explorer/install/#choose-operational-mode) +> Explorer is running in [admin mode](/influxdb3/explorer/install/docker/#choose-operational-mode) > and that the token used in the InfluxDB 3 server configuration is an > [admin token](/influxdb3/enterprise/admin/tokens/admin/). diff --git a/content/influxdb3/explorer/release-notes/_index.md b/content/influxdb3/explorer/release-notes/_index.md index 0f4ae87608..9f1a9f68f0 100644 --- a/content/influxdb3/explorer/release-notes/_index.md +++ b/content/influxdb3/explorer/release-notes/_index.md @@ -66,7 +66,7 @@ docker pull influxdata/influxdb3-ui #### Breaking changes - **Container user change**: The Docker container now runs as non-root user `influxui` (uid 1500) instead of root for improved security. -- **Upgrade action**: See [Install InfluxDB 3 Explorer](/influxdb3/explorer/install/#set-file-permissions-for-upgrades) +- **Upgrade action**: See [Install and run InfluxDB 3 Explorer with Docker](/influxdb3/explorer/install/docker/#set-file-permissions-for-upgrades) for upgrade file permission steps. #### Features From d179aae6e17d42d72c38d86155d9eace5004cc80 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Fri, 18 Sep 2026 13:57:24 +0000 Subject: [PATCH 08/10] docs(explorer): restructure install docs to route by version and edition What changed: - Split install.md into install/_index.md (a version-routing hub) and install/docker.md (Docker instructions scoped to InfluxDB 3 Core and Enterprise earlier than v3.11). - Added a GET /ping-based version/edition check to the hub, and a cascade.prepend transition notice on explorer/_index.md. - Propagated the InfluxDB 3 Enterprise v3.11+ (integrated WASM) vs. Docker scoping to about/_index.md, get-started.md, manage-databases.md, and manage-tokens.md, replacing links/claims that assumed Docker is the only deployment. - Fixed inbound links across content/shared, enterprise, and explorer pages to point at the hub or the Docker page as appropriate; preserved the three anchors other pages link into. - Added bidirectional alt_links and related entries between the install hub and content/influxdb3/enterprise/visualize-data/explorer.md, so the product switcher and related links connect the two halves of this split feature. Why: the Explorer install docs described Docker as the only distribution with no version or edition scoping, so a docs-grounded assistant could only infer that no other install path exists (issue #6702). InfluxDB 3 Enterprise v3.11 added an integrated WASM alternative to the Docker container without any corresponding doc changes. Verification: npx hugo --quiet builds clean; yarn lint-codeblocks passes on all changed files; node scripts/check-jsonld-links.js reports no dangling @id references; manually confirmed the three preserved anchors resolve and no in-repo link still points at the old /install/#anchor paths. --- .../enterprise/visualize-data/explorer.md | 3 ++ content/influxdb3/explorer/_index.md | 21 +++++---- content/influxdb3/explorer/about/_index.md | 10 ++--- content/influxdb3/explorer/get-started.md | 7 ++- content/influxdb3/explorer/install/_index.md | 44 ++++++++++++------- content/influxdb3/explorer/install/docker.md | 21 +++++---- .../influxdb3/explorer/manage-databases.md | 7 ++- content/influxdb3/explorer/manage-tokens.md | 9 ++-- 8 files changed, 76 insertions(+), 46 deletions(-) diff --git a/content/influxdb3/enterprise/visualize-data/explorer.md b/content/influxdb3/enterprise/visualize-data/explorer.md index 8c66d65e82..52d6c27b21 100644 --- a/content/influxdb3/enterprise/visualize-data/explorer.md +++ b/content/influxdb3/enterprise/visualize-data/explorer.md @@ -13,10 +13,13 @@ menu: identifier: visualize-with-explorer weight: 100 metadata: [InfluxDB 3 Enterprise v3.11+] +alt_links: + explorer: /influxdb3/explorer/install/ related: - /influxdb3/enterprise/reference/config-options/#mode - /influxdb3/enterprise/reference/config-options/#web-ui - /influxdb3/explorer/, InfluxDB 3 Explorer documentation + - /influxdb3/explorer/install/, Install InfluxDB 3 Explorer --- Starting with {{% product-name %}} v3.11, the diff --git a/content/influxdb3/explorer/_index.md b/content/influxdb3/explorer/_index.md index 3ad6ceef68..723b88f7a1 100644 --- a/content/influxdb3/explorer/_index.md +++ b/content/influxdb3/explorer/_index.md @@ -11,14 +11,14 @@ cascade: version: explorer prepend: | > [!Important] - > #### Explorer's distribution model is changing in v1.10 + > #### How you install Explorer depends on your InfluxDB 3 server > - > Starting with v1.10, Explorer is included with - > [InfluxDB 3 Enterprise](/influxdb3/enterprise/) and runs as WebAssembly - > (WASM) instead of a standalone Docker container. Explorer v1.9 and - > earlier remains available as Docker. See + > Starting with InfluxDB 3 Enterprise v3.11, Explorer is included with + > the server and runs as WebAssembly (WASM)--there's no separate + > container to install. For InfluxDB 3 Core, or Enterprise earlier than + > v3.11, Explorer runs as a standalone Docker container. See > [Install Explorer](/influxdb3/explorer/install/) to find the - > instructions for your version. + > instructions for your server. --- InfluxDB 3 Explorer is the standalone web application designed for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise. @@ -34,10 +34,13 @@ Use InfluxDB 3 Explorer for: ## Quick start -How you install {{% product-name %}} depends on your version: +How you install {{% product-name %}} depends on your InfluxDB 3 server: -- **v1.10 and later** is included with InfluxDB 3 Enterprise and runs as WASM. -- **v1.9 and earlier** runs as a standalone Docker container: +- **InfluxDB 3 Enterprise v3.11 and later** includes Explorer as an + integrated WASM component. See + [Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). +- **InfluxDB 3 Core, or Enterprise earlier than v3.11**, runs Explorer as a + standalone Docker container: ```sh # Pull the Docker image diff --git a/content/influxdb3/explorer/about/_index.md b/content/influxdb3/explorer/about/_index.md index eb072f9a90..5bc4b6fc44 100644 --- a/content/influxdb3/explorer/about/_index.md +++ b/content/influxdb3/explorer/about/_index.md @@ -18,12 +18,12 @@ Explorer is fully featured for [InfluxDB 3 Core](/influxdb3/core/) and [InfluxDB 3 Enterprise](/influxdb3/enterprise/). You can use Explorer to query data in and administer these products. -Explorer v1.9 and earlier runs as a standalone Docker container that works -with either Core or Enterprise. Starting with Explorer v1.10, Explorer is -included with InfluxDB 3 Enterprise and runs as WebAssembly (WASM); it isn't -distributed separately for Core. See +Explorer runs as a standalone Docker container that works with either Core or +Enterprise. Starting with InfluxDB 3 Enterprise v3.11, Explorer is also +available as an integrated WebAssembly (WASM) component of the Enterprise +server; it isn't distributed this way for Core. See [Install Explorer](/influxdb3/explorer/install/) to find the instructions for -your version. +your InfluxDB 3 server. Explorer provides only _partial_ support for [InfluxDB Cloud Dedicated](/influxdb3/cloud-dedicated/) and diff --git a/content/influxdb3/explorer/get-started.md b/content/influxdb3/explorer/get-started.md index 409afce6e8..c069d7c140 100644 --- a/content/influxdb3/explorer/get-started.md +++ b/content/influxdb3/explorer/get-started.md @@ -85,8 +85,13 @@ InfluxDB 3 Explorer supports the following InfluxDB 3 products: > > The token's permissions also define what anyone with access to this > Explorer instance can do. Use a token scoped to what you need, and - > control who can reach Explorer. See + > control who can reach Explorer. If you're running the + > [Docker container](/influxdb3/explorer/install/docker/), see > [Network exposure and access control](/influxdb3/explorer/install/docker/#network-exposure-and-access-control). + > If you're using the + > [integrated Explorer UI](/influxdb3/enterprise/visualize-data/explorer/), + > control access through + > [`--http-bind`](/influxdb3/enterprise/reference/config-options/#http-bind). 4. Click **Add Server**. diff --git a/content/influxdb3/explorer/install/_index.md b/content/influxdb3/explorer/install/_index.md index dfce5bcff4..31fc9b63df 100644 --- a/content/influxdb3/explorer/install/_index.md +++ b/content/influxdb3/explorer/install/_index.md @@ -1,24 +1,29 @@ --- title: Install InfluxDB 3 Explorer description: > - Install and run InfluxDB 3 Explorer. Instructions depend on your Explorer - version--Docker for v1.9 and earlier, or WASM with InfluxDB 3 Enterprise - for v1.10 and later. + Install and run InfluxDB 3 Explorer. Instructions depend on your InfluxDB 3 + server--integrated WASM for InfluxDB 3 Enterprise v3.11 and later, or + Docker for earlier releases and InfluxDB 3 Core. menu: influxdb3_explorer: name: Install Explorer weight: 2 +alt_links: + enterprise: /influxdb3/enterprise/visualize-data/explorer/ +related: + - /influxdb3/enterprise/visualize-data/explorer/, Use the integrated InfluxDB 3 Explorer UI --- -How you install {{% product-name %}} depends on which version you're -installing: +How you install {{% product-name %}} depends on the InfluxDB 3 server you're +connecting it to: -- **Explorer v1.10 and later** is included with - [InfluxDB 3 Enterprise](/influxdb3/enterprise/) and runs as WebAssembly - (WASM)--there's no separate container to install. For deployment - instructions, see the InfluxDB 3 Enterprise documentation. -- **Explorer v1.9 and earlier** is a standalone Docker container. For - installation and configuration instructions, see +- **InfluxDB 3 Enterprise v3.11 and later** includes Explorer as an + integrated WebAssembly (WASM) component--there's no separate container to + install. For setup instructions, see + [Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). +- **InfluxDB 3 Core, or InfluxDB 3 Enterprise earlier than v3.11**, runs + Explorer as a standalone Docker container. For installation and + configuration instructions, see [Install and run InfluxDB 3 Explorer with Docker](/influxdb3/explorer/install/docker/). ## Check which version applies to you @@ -31,10 +36,15 @@ curl --get "http://localhost:8181/ping" \ --header "Authorization: Bearer AUTH_TOKEN" ``` -The response includes the `x-influxdb-version` and `x-influxdb-build` headers -(`Core` or `Enterprise`), and `version` in the body. Use `GET`; a `HEAD` -request to `/ping` returns `404`. +The response includes the following version details: -If you're installing InfluxDB 3 Enterprise 1.10 or later, Explorer is already -included--go to the Enterprise deployment instructions. Otherwise, use -[Docker](/influxdb3/explorer/install/docker/). +- `x-influxdb-version` reports the InfluxDB 3 server version. +- `x-influxdb-build` reports whether the server is Core or Enterprise. +- The response body includes the version in its `version` field. + +Use `GET`; a `HEAD` request to `/ping` returns `404`. + +If `x-influxdb-build` reports `Enterprise` and `x-influxdb-version` is `3.11` +or later, use the +[integrated Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). +Otherwise, use [Docker](/influxdb3/explorer/install/docker/). diff --git a/content/influxdb3/explorer/install/docker.md b/content/influxdb3/explorer/install/docker.md index 6d65df8e32..6258bfc0f2 100644 --- a/content/influxdb3/explorer/install/docker.md +++ b/content/influxdb3/explorer/install/docker.md @@ -1,21 +1,24 @@ --- title: Install and run InfluxDB 3 Explorer with Docker description: > - Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer - v1.9 and earlier**, the last release distributed as a standalone container. + Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer** + as a standalone container against InfluxDB 3 Core or InfluxDB 3 Enterprise + earlier than v3.11. menu: influxdb3_explorer: name: Docker weight: 1 -metadata: [Explorer v1.9 and earlier] +metadata: [InfluxDB 3 Core, InfluxDB 3 Enterprise earlier than v3.11] --- -Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer -v1.9 and earlier**, the last release distributed as a standalone container. -Starting with v1.10, Explorer is included with -[InfluxDB 3 Enterprise](/influxdb3/enterprise/) and deployed as WebAssembly -(WASM); see [Install Explorer](/influxdb3/explorer/install/) to choose the -instructions for your version. +Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer** +as a standalone container. Use this method with +[InfluxDB 3 Core](/influxdb3/core/), or with +[InfluxDB 3 Enterprise](/influxdb3/enterprise/) releases earlier than v3.11. +Starting with Enterprise v3.11, Explorer is also available as an integrated +WebAssembly (WASM) component of the server--see +[Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/) +if you run Enterprise v3.11 or later and want to skip the separate container. > [!Important] > #### Control who can reach Explorer diff --git a/content/influxdb3/explorer/manage-databases.md b/content/influxdb3/explorer/manage-databases.md index 6e984d4228..22ea4b46c1 100644 --- a/content/influxdb3/explorer/manage-databases.md +++ b/content/influxdb3/explorer/manage-databases.md @@ -17,9 +17,12 @@ or InfluxDB 3 Enterprise cluster. > [!Important] > Using {{% product-name %}} to manage a database in InfluxDB 3 requires that -> Explorer is running in [admin mode](/influxdb3/explorer/install/docker/#choose-operational-mode) -> and that the token used in the InfluxDB 3 server configuration is an +> the token used in the InfluxDB 3 server configuration is an > [admin token](/influxdb3/enterprise/admin/tokens/admin/). +> If you're running the +> [Docker container](/influxdb3/explorer/install/docker/), Explorer must also +> be running in +> [admin mode](/influxdb3/explorer/install/docker/#choose-operational-mode). To manage databases, navigate to **Manage Databases** in Explorer. This page provides a list of databases in the connected InfluxDB 3 server that diff --git a/content/influxdb3/explorer/manage-tokens.md b/content/influxdb3/explorer/manage-tokens.md index 0e26699c6d..e915c70d03 100644 --- a/content/influxdb3/explorer/manage-tokens.md +++ b/content/influxdb3/explorer/manage-tokens.md @@ -16,10 +16,13 @@ related: Core instance or InfluxDB 3 Enterprise cluster. > [!Important] -> Using {{% product-name %}} to manage authorization tokens in InfluxDB 3 requires that -> Explorer is running in [admin mode](/influxdb3/explorer/install/docker/#choose-operational-mode) -> and that the token used in the InfluxDB 3 server configuration is an +> Using {{% product-name %}} to manage authorization tokens in InfluxDB 3 +> requires that the token used in the InfluxDB 3 server configuration is an > [admin token](/influxdb3/enterprise/admin/tokens/admin/). +> If you're running the +> [Docker container](/influxdb3/explorer/install/docker/), Explorer must also +> be running in +> [admin mode](/influxdb3/explorer/install/docker/#choose-operational-mode). To manage InfluxDB authorization tokens, navigate to **Manage Tokens** in Explorer. This page provides a list of databases in the connected InfluxDB 3 server that From 47708ed959b2142f33804bbb5f97afd1ecff4f85 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 28 Sep 2026 09:36:45 -0500 Subject: [PATCH 09/10] docs(explorer): remove duplicated version availability guide --- DOCS-VERSION-AVAILABILITY.md | 107 ----------------------------------- 1 file changed, 107 deletions(-) delete mode 100644 DOCS-VERSION-AVAILABILITY.md diff --git a/DOCS-VERSION-AVAILABILITY.md b/DOCS-VERSION-AVAILABILITY.md deleted file mode 100644 index a7ef6f7411..0000000000 --- a/DOCS-VERSION-AVAILABILITY.md +++ /dev/null @@ -1,107 +0,0 @@ -# Documenting version availability - -How to state which product versions and editions a page or feature applies to. - -This page covers the decisions: which marker to use, which surface carries -which fact, where a page lives, and when a notice is removed. -For field syntax, see [DOCS-FRONTMATTER.md](DOCS-FRONTMATTER.md). -For how Markdown twins and corpora are published, see -[DOCS-AI-VISIBILITY.md](DOCS-AI-VISIBILITY.md). - -## Choose a marker - -Match the marker to the scope of the version constraint. - -| Scope | Use | Example | -| ---------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------- | -| The whole page applies to a version range | `metadata:` frontmatter | `metadata: [Explorer v1.9 and earlier]` | -| The whole page is one of a generated set with a real range | `introduced`, `deprecated`, `removed` frontmatter | `introduced: "v1.9.0"` | -| One section applies to a version range | Heading attribute | `## Configure user auth {metadata="v1.10+"}` | - -Use `metadata:` when you need to state a ceiling or an exact phrase. -The `introduced`/`deprecated`/`removed` fields render as a range, such as -"InfluxDB 3 Explorer v1.0.0 – v1.10.0", which doesn't say which release is the -last working one. -Telegraf plugin pages use the range fields because the values are generated -from plugin metadata. - -Don't state a version constraint only in body text. -Frontmatter markers render in a list under the page h1 and appear above the -lede in the page's Markdown twin, which is the text a retrieval system reads -first. - -## Choose a surface - -Each surface reaches a different audience. -Decide which one carries the fact before you write it. - -| Surface | Reaches | Use for | -| ------------------------------------------------- | -------------------------------------------------------- | ----------------------------------------------------------------------- | -| Frontmatter markers and the lede | Readers, search engines, Markdown twins, `llms-full.txt` | Any version or edition fact a reader or an agent needs to act correctly | -| `prepend` / `append` frontmatter (with `cascade`) | Same as above, on every page it cascades to | A transition notice that must appear in the twin | -| `data/notifications.yaml` | Readers only | A dated announcement, such as a release or a scheduled change | - -Notifications render in the site footer through -`layouts/partials/footer/notifications.html`, outside the article element. -They don't appear in Markdown twins or in `llms-full.txt`. -A fact that exists only in a notification is invisible to every AI consumer of -the docs, so don't use a notification as the only statement of a version -requirement. - -Cascaded `prepend` content appears in the twin of every page it reaches, which -makes the first chunk of those pages similar to each other. -Keep cascaded notices to a few lines, and remove them when the transition ends. - -## Place a feature page - -When a feature spans two products, such as a UI feature that depends on a -server capability: - -1. Put the canonical page in the product that owns the behavior. -2. Add `alt_links` so the product switcher moves readers to the equivalent page - in the other product. -3. Add `related` entries from the other product's page. - -Don't duplicate the instructions in both products. -If both products need the same body, use `source:` to share the content and set -`canonical: self` on the page whose URL marks the product identity. - -## Include a version check - -A page that documents a version-gated feature states how to verify the version, -or links to a page that does. -Give both a local check and a check that works against a running instance, so -that a reader without shell access to the server can still confirm the version. - -Local: - -```bash -influxdb3 --version -``` - -Running instance: - -```sh -curl --get "http://localhost:8181/ping" \ - --header "Authorization: Bearer AUTH_TOKEN" -``` - -The `/ping` response includes the `x-influxdb-version` and `x-influxdb-build` -headers, and `version` and `revision` in the body. -Because `x-influxdb-build` reports `Core` or `Enterprise`, `/ping` is the only -check that answers both the version question and the edition question. -Use `GET`; a `HEAD` request returns `404`. - -## Retire a notice - -Every temporary notice names the release that removes it. - -- For a `cascade.prepend` notice, record the removal release in the exec-plan - for the change that added it. -- For a `data/notifications.yaml` entry, record the removal release with the - entry `id`, so the entry can be found and deleted without reading the message - text. - -Version markers in frontmatter are permanent. -They describe a fact about the release, not a temporary state, so leave them in -place after the transition ends. From 0c1fe6bec8faa04c0d20d61f5b720c5dda7fd7b3 Mon Sep 17 00:00:00 2001 From: Jason Stirnaman Date: Mon, 28 Sep 2026 10:37:50 -0500 Subject: [PATCH 10/10] docs(explorer): port verified integrated UI guidance What changed: Port the Enterprise 3.11.5 Explorer corrections from master and update Docker compatibility across the install route. Why: Product review confirmed the UI URL, token rules, AI key handling, optional plugin directory, and continued Docker support for Enterprise 3.11+. Impact: The release branch now documents both deployment paths accurately and removes stale verification comments. Verification: Hugo build, code-block lint, link checks, and Markdown coherence pass. --- .../enterprise/visualize-data/explorer.md | 78 ++++++++++++------- content/influxdb3/explorer/_index.md | 13 ++-- content/influxdb3/explorer/install/_index.md | 10 ++- content/influxdb3/explorer/install/docker.md | 41 +++++----- .../shared/influxdb3-cli/config-options.md | 29 +++++-- content/shared/influxdb3-get-started/setup.md | 4 +- ...-09-02-explorer-install-version-routing.md | 55 ++++++------- 7 files changed, 130 insertions(+), 100 deletions(-) diff --git a/content/influxdb3/enterprise/visualize-data/explorer.md b/content/influxdb3/enterprise/visualize-data/explorer.md index 52d6c27b21..b78b5bb62c 100644 --- a/content/influxdb3/enterprise/visualize-data/explorer.md +++ b/content/influxdb3/enterprise/visualize-data/explorer.md @@ -55,10 +55,10 @@ To serve Explorer from your server, you need the following: {{% product-name %}} requires [`--webui-session-secret`](/influxdb3/enterprise/reference/config-options/#webui-session-secret) whenever `webui` mode is enabled, and doesn't start without it. -- A plugin directory. - Pass the directory to - [`--plugin-dir`](/influxdb3/enterprise/reference/config-options/#plugin-dir) - and create it before you start the server. +- _(Optional)_ A plugin directory. + Explorer runs without one. + To use the plugin features in Explorer, create the directory and pass it to + [`--plugin-dir`](/influxdb3/enterprise/reference/config-options/#plugin-dir). ## Check your version @@ -87,13 +87,22 @@ Use `GET`; a `HEAD` request returns `404`. ## Start the server with Explorer enabled -1. Create the plugin directory: +1. Start the server with `webui` added to `--mode` and a session secret: ```bash - mkdir -p ./plugins + influxdb3 serve \ + --cluster-id cluster0 \ + --node-id node0 \ + --mode all,webui \ + --webui-session-secret "$(openssl rand -base64 24)" ``` -2. Start the server with `webui` added to `--mode` and a session secret: + To use the plugin features in Explorer, create a plugin directory and add + `--plugin-dir`: + + ```bash + mkdir -p ./plugins + ``` ```bash influxdb3 serve \ @@ -104,6 +113,11 @@ Use `GET`; a `HEAD` request returns `404`. --webui-session-secret "$(openssl rand -base64 24)" ``` +2. Open Explorer in your browser. + The server serves Explorer at the root path of its regular HTTP address and + port--for example, . + Explorer doesn't use a separate port. + `openssl rand -base64 24` generates a new secret on every start, which signs users out after each restart. For anything beyond a local trial, generate the secret once and pass the same @@ -120,12 +134,9 @@ See [Manage the session secret](#manage-the-session-secret). > authenticating reverse proxy with TLS in front of any remote access. > To control which interface the server listens on, see > [`--http-bind`](/influxdb3/enterprise/reference/config-options/#http-bind). - - +> When browsers reach Explorer over HTTPS, also set +> [`--webui-cookie-secure`](/influxdb3/enterprise/reference/config-options/#webui-cookie-secure) +> so session cookies are never sent over HTTP. ## Connect Explorer to your server @@ -135,10 +146,12 @@ same way you configure one in the standalone Docker Explorer--for example, For the connection fields and the steps to create a connection, see [Get started with InfluxDB 3 Explorer](/influxdb3/explorer/get-started/). - +Choose the token for the connection based on what you need Explorer to do: + +- A [resource token](/influxdb3/enterprise/admin/tokens/resource/) is enough to + query and write data within the permissions you grant it. +- To manage databases, tokens, and other resources from Explorer, use an + [admin token](/influxdb3/enterprise/admin/tokens/admin/). ## Manage the session secret @@ -147,6 +160,9 @@ The server requires the option whenever `webui` mode is enabled. - **Generate the secret once and reuse it.** A secret that changes on restart invalidates every existing session. +- **Use the same secret on every node that serves Explorer.** + When several nodes in a cluster run `webui` mode, they all need the same + secret. - **Keep the secret out of your shell history and process list.** Set the secret through the environment variable instead of the command line when you can. @@ -169,30 +185,31 @@ difference from the ## Enable AI chat -Explorer includes an AI chat feature that you can point at any -OpenAI-compatible endpoint. -To enable it, set +Explorer includes an AI chat feature that supports OpenAI, Anthropic, and +Gemini. +Each user enters their own AI provider API key in Explorer's settings. +You don't configure an API key on the server, and no server option turns the +feature on. + [`--webui-openai-base-url`](/influxdb3/enterprise/reference/config-options/#webui-openai-base-url) -to the base URL of the endpoint: +changes only where Explorer sends OpenAI requests. +Set it to route OpenAI traffic to an OpenAI-compatible endpoint, such as a +self-hosted model or a gateway: ```bash influxdb3 serve \ --cluster-id cluster0 \ --node-id node0 \ --mode all,webui \ - --plugin-dir ./plugins \ --webui-session-secret "$WEBUI_SESSION_SECRET" \ --webui-openai-base-url "https://your-openai-compatible-endpoint" ``` -Chat prompts, and any query results included with them, go to the endpoint you -configure. -Choose an endpoint that your data handling policies allow. +The option doesn't affect Anthropic or Gemini requests. - +Chat prompts, and any query results included with them, go to the AI provider +the user selects. +Choose providers and endpoints that your data handling policies allow. ## Choose between integrated and containerized Explorer @@ -204,6 +221,9 @@ option in a specific build. --> | Application data | SQLite synchronized to object storage | SQLite in a mounted volume | | Works with InfluxDB 3 Core | No | Yes | +The container isn't replaced by the integrated UI. +It's required for Core and for Enterprise earlier than v3.11, and it still +works with v3.11 and later. Use the container when you run Core, when you run an Enterprise release earlier than v3.11, or when you want Explorer to run separately from the database server--for example, on an operator workstation. diff --git a/content/influxdb3/explorer/_index.md b/content/influxdb3/explorer/_index.md index 723b88f7a1..c4cc2c6d87 100644 --- a/content/influxdb3/explorer/_index.md +++ b/content/influxdb3/explorer/_index.md @@ -1,7 +1,7 @@ --- title: InfluxDB 3 Explorer documentation description: > - InfluxDB 3 Explorer is a standalone web-based interface for interacting with InfluxDB 3 Core and Enterprise. Visualize, query, and manage your time series data efficiently. + InfluxDB 3 Explorer is a web-based interface for InfluxDB 3 Core and Enterprise. Visualize, query, and manage your time series data efficiently. menu: influxdb3_explorer: name: InfluxDB 3 Explorer @@ -15,13 +15,14 @@ cascade: > > Starting with InfluxDB 3 Enterprise v3.11, Explorer is included with > the server and runs as WebAssembly (WASM)--there's no separate - > container to install. For InfluxDB 3 Core, or Enterprise earlier than - > v3.11, Explorer runs as a standalone Docker container. See + > container to install. Docker is required for InfluxDB 3 Core and + > Enterprise earlier than v3.11, and remains an option for later + > Enterprise releases. See > [Install Explorer](/influxdb3/explorer/install/) to find the > instructions for your server. --- -InfluxDB 3 Explorer is the standalone web application designed for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise. +InfluxDB 3 Explorer is the web application for visualizing, querying, and managing your data stored in InfluxDB 3 Core and Enterprise. Explorer provides an intuitive interface for interacting with your time series data, streamlining database operations and enhancing data insights. ## Key features @@ -39,8 +40,8 @@ How you install {{% product-name %}} depends on your InfluxDB 3 server: - **InfluxDB 3 Enterprise v3.11 and later** includes Explorer as an integrated WASM component. See [Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). -- **InfluxDB 3 Core, or Enterprise earlier than v3.11**, runs Explorer as a - standalone Docker container: +- **InfluxDB 3 Core and Enterprise** can run Explorer as a standalone Docker + container. Docker is required for Core and Enterprise earlier than v3.11: ```sh # Pull the Docker image diff --git a/content/influxdb3/explorer/install/_index.md b/content/influxdb3/explorer/install/_index.md index 31fc9b63df..3a09dcded9 100644 --- a/content/influxdb3/explorer/install/_index.md +++ b/content/influxdb3/explorer/install/_index.md @@ -3,7 +3,7 @@ title: Install InfluxDB 3 Explorer description: > Install and run InfluxDB 3 Explorer. Instructions depend on your InfluxDB 3 server--integrated WASM for InfluxDB 3 Enterprise v3.11 and later, or - Docker for earlier releases and InfluxDB 3 Core. + Docker for InfluxDB 3 Core and Enterprise. menu: influxdb3_explorer: name: Install Explorer @@ -21,9 +21,9 @@ connecting it to: integrated WebAssembly (WASM) component--there's no separate container to install. For setup instructions, see [Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). -- **InfluxDB 3 Core, or InfluxDB 3 Enterprise earlier than v3.11**, runs - Explorer as a standalone Docker container. For installation and - configuration instructions, see +- **InfluxDB 3 Core and Enterprise** can run Explorer as a standalone Docker + container. Docker is required for Core and Enterprise earlier than v3.11. + For installation and configuration instructions, see [Install and run InfluxDB 3 Explorer with Docker](/influxdb3/explorer/install/docker/). ## Check which version applies to you @@ -48,3 +48,5 @@ If `x-influxdb-build` reports `Enterprise` and `x-influxdb-version` is `3.11` or later, use the [integrated Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). Otherwise, use [Docker](/influxdb3/explorer/install/docker/). +Docker also works with Enterprise v3.11 and later if you want to run Explorer +separately from the server. diff --git a/content/influxdb3/explorer/install/docker.md b/content/influxdb3/explorer/install/docker.md index 6258bfc0f2..d9a0f65e75 100644 --- a/content/influxdb3/explorer/install/docker.md +++ b/content/influxdb3/explorer/install/docker.md @@ -2,23 +2,22 @@ title: Install and run InfluxDB 3 Explorer with Docker description: > Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer** - as a standalone container against InfluxDB 3 Core or InfluxDB 3 Enterprise - earlier than v3.11. + as a standalone container against InfluxDB 3 Core or Enterprise. menu: influxdb3_explorer: name: Docker weight: 1 -metadata: [InfluxDB 3 Core, InfluxDB 3 Enterprise earlier than v3.11] +metadata: [InfluxDB 3 Core and Enterprise] --- Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer** -as a standalone container. Use this method with -[InfluxDB 3 Core](/influxdb3/core/), or with -[InfluxDB 3 Enterprise](/influxdb3/enterprise/) releases earlier than v3.11. +as a standalone container with [InfluxDB 3 Core](/influxdb3/core/) or +[InfluxDB 3 Enterprise](/influxdb3/enterprise/), including Enterprise v3.11 +and later. Starting with Enterprise v3.11, Explorer is also available as an integrated -WebAssembly (WASM) component of the server--see +WebAssembly (WASM) component of the server. See [Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/) -if you run Enterprise v3.11 or later and want to skip the separate container. +if you run Enterprise v3.11 or later and don't need a separate container. > [!Important] > #### Control who can reach Explorer @@ -242,8 +241,8 @@ Use the following practices to control access: {{< code-tabs-wrapper >}} {{% code-tabs %}} - [Docker](#) - [Docker Compose](#) + [Run container](#) + [Compose](#) {{% /code-tabs %}} {{% code-tab-content %}} @@ -360,8 +359,8 @@ Instead of configuring connections through the UI, you can pre-define connection {{< code-tabs-wrapper >}} {{% code-tabs %}} - [Docker](#) - [Docker Compose](#) + [Run container](#) + [Compose](#) {{% /code-tabs %}} {{% code-tab-content %}} @@ -415,8 +414,8 @@ To enable TLS/SSL for secure connections: {{< code-tabs-wrapper >}} {{% code-tabs %}} - [Docker](#) - [Docker Compose](#) + [Run container](#) + [Compose](#) {{% /code-tabs %}} {{% code-tab-content %}} @@ -491,12 +490,12 @@ To configure Explorer to trust self-signed or custom CA certificates when connec 3. **Mount the CA certificate directory and set the `NODE_EXTRA_CA_CERTS` environment variable:** {{< expand-wrapper >}} -{{% expand "View example Docker configuration for self-signed certificates" %}} +{{% expand "View example configuration for self-signed certificates" %}} {{< code-tabs-wrapper >}} {{% code-tabs %}} -[Docker](#) -[Docker Compose](#) +[Run container](#) +[Compose](#) {{% /code-tabs %}} {{% code-tab-content %}} @@ -558,8 +557,8 @@ Set the mode using the `--mode` parameter: {{< code-tabs-wrapper >}} {{% code-tabs %}} -[Docker](#) -[Docker Compose](#) +[Run container](#) +[Compose](#) {{% /code-tabs %}} {{% code-tab-content %}} @@ -645,8 +644,8 @@ services: {{< code-tabs-wrapper >}} {{% code-tabs %}} -[Docker](#) -[Docker Compose](#) +[Run container](#) +[Compose](#) {{% /code-tabs %}} {{% code-tab-content %}} diff --git a/content/shared/influxdb3-cli/config-options.md b/content/shared/influxdb3-cli/config-options.md index 22a2fcbe1d..9e3e510a73 100644 --- a/content/shared/influxdb3-cli/config-options.md +++ b/content/shared/influxdb3-cli/config-options.md @@ -261,7 +261,7 @@ This option supports the following values: - `query`: Enables only query capabilities - `compact`: Enables only compaction processes - `process`: Activates the [Processing Engine](/influxdb3/enterprise/reference/processing-engine/) so the node can execute trigger plugins. `process` has no API surface of its own — it doesn't accept writes or serve queries. Setting [`--plugin-dir`](#plugin-dir) implicitly adds `process` mode regardless of `--mode`. Conversely, `--mode=process` requires `--plugin-dir`. In a multi-node cluster, combine `process` with another mode (typically `query`) so plugins can call `influxdb3_local.query()` locally. -- `webui` *(3.11+)*: Serves the [InfluxDB 3 Explorer](/influxdb3/enterprise/visualize-data/explorer/) web UI from the server process as a WebAssembly (WASM) guest. `all` doesn't include `webui`, so name `webui` explicitly--for example, `--mode all,webui`. `webui` mode requires [`--webui-session-secret`](#webui-session-secret) and [`--plugin-dir`](#plugin-dir). +- `webui` *(3.11+)*: Serves the [InfluxDB 3 Explorer](/influxdb3/enterprise/visualize-data/explorer/) web UI from the server process as a WebAssembly (WASM) guest. `all` doesn't include `webui`, so name `webui` explicitly--for example, `--mode all,webui`. `webui` mode requires [`--webui-session-secret`](#webui-session-secret). Set [`--plugin-dir`](#plugin-dir) as well to use the plugin features in Explorer. You can specify multiple modes using a comma-delimited list (for example, `ingest,query`). @@ -2403,15 +2403,9 @@ which the server hosts in-process as a WebAssembly (WASM) guest. The web UI is off unless you add `webui` to [`--mode`](#mode). - [webui-session-secret](#webui-session-secret) +- [webui-cookie-secure](#webui-cookie-secure) - [webui-openai-base-url](#webui-openai-base-url) - - #### webui-session-secret Specifies the secret that signs web UI session cookies. @@ -2428,6 +2422,25 @@ A secret that changes between restarts signs out every user. *** +#### webui-cookie-secure + +Sets the `Secure` attribute on web UI session cookies, which tells browsers to +send the cookies only over HTTPS. + +**Default:** `false` + +Enable this option when browsers reach Explorer over HTTPS--for example, +through a TLS-terminating reverse proxy. +Leave it disabled when you reach Explorer over HTTP, such as through +`http://localhost:8181/`; browsers withhold `Secure` cookies from HTTP +requests, so sessions don't persist. + +| influxdb3 serve option | Environment variable | +| :----------------------- | :------------------------------ | +| `--webui-cookie-secure` | `INFLUXDB3_WEBUI_COOKIE_SECURE` | + +*** + #### webui-openai-base-url Specifies the base URL of the OpenAI-compatible endpoint that the web UI AI diff --git a/content/shared/influxdb3-get-started/setup.md b/content/shared/influxdb3-get-started/setup.md index 828f27c40c..00ac5c1a42 100644 --- a/content/shared/influxdb3-get-started/setup.md +++ b/content/shared/influxdb3-get-started/setup.md @@ -119,7 +119,9 @@ Provide the following: - _(Optional, v3.11+)_ `--mode all,webui`: Serves the InfluxDB 3 Explorer web UI from the server process. `all` doesn't include `webui`, so name `webui` explicitly. - This mode also requires `--webui-session-secret` and `--plugin-dir`. + This mode also requires `--webui-session-secret`. + Explorer is served at the root path of the server's HTTP address--for + example, . For the requirements and the full startup command, see [Use the integrated InfluxDB 3 Explorer UI](/influxdb3/enterprise/visualize-data/explorer/). {{% /show-in %}} diff --git a/docs/exec-plans/2026-09-02-explorer-install-version-routing.md b/docs/exec-plans/2026-09-02-explorer-install-version-routing.md index de049644eb..43b5fa2f78 100644 --- a/docs/exec-plans/2026-09-02-explorer-install-version-routing.md +++ b/docs/exec-plans/2026-09-02-explorer-install-version-routing.md @@ -9,15 +9,14 @@ Restructure the InfluxDB 3 Explorer install documentation so that each page states which Explorer versions and which InfluxDB 3 editions it applies to. After this change, `/influxdb3/explorer/install/` routes readers by version instead of presenting Docker as the only deployment method, and the Docker -instructions live on a child page that declares its version ceiling in -frontmatter, in the lede, and in the Markdown twin. +instructions live on a child page that states which products they support. ## Why now -Explorer v1.9 is the last release distributed as a standalone Docker container. -Starting with v1.10, Explorer is included with InfluxDB 3 Enterprise and is -deployed as WebAssembly (WASM). The current pages have no version or edition -scoping: +Starting with InfluxDB 3 Enterprise v3.11, Explorer is included with the +server and deployed as WebAssembly (WASM). +The standalone Docker container remains available for Core and Enterprise. +The original pages have no version or edition scoping: - `content/influxdb3/explorer/install.md` documents only Docker. - `content/influxdb3/explorer/_index.md` repeats a `docker pull` quick start. @@ -27,9 +26,8 @@ scoping: the JSON-LD `SoftwareApplication` node. Each of these tells readers, search engines, retrieval systems, and coding -agents that Explorer is a Docker container that works with Core. Doing the -restructure before v1.10 ships means the corpus and search index carry the -version scoping before the release changes the answer. +agents only about the Docker deployment. +The restructure adds the integrated Enterprise path without removing Docker. Issue #6702 reports the related gap: the docs never state outright which distributions exist, so a docs-grounded assistant can only infer the @@ -49,18 +47,13 @@ limitation. `#set-file-permissions-for-upgrades`. - **Do not redirect `/install/` to `/install/docker/`.** A redirect would send every "install Explorer" search result and every agent's first URL guess to - the deprecated path. -- **Use `metadata: [Explorer v1.9 and earlier]` rather than - `introduced`/`deprecated`.** Both render into the `ul.metadata` list under the - h1 and into the first line of the Markdown twin, verified against - `/influxdb3/clustered/reference/cli/influxctl/query/index.md` (`* influxctl - 2.4.0+`) and `/telegraf/v1/input-plugins/jenkins/index.md` (`* Telegraf - v1.9.0+`). The `introduced`/`deprecated` pair renders as a range - ("v1.0.0 – v1.10.0"), which is ambiguous about the last working release. - `metadata` states the ceiling exactly. -- **Keep the Docker page published and indexed.** Explorer v1.9 remains - supported, and removing or hiding the instructions creates a retrieval dead - end. A page that states its own version ceiling is not misleading. + the Docker path, even when they run Enterprise v3.11 or later. +- **State Docker compatibility without a version ceiling.** Product review in + [PR #7788](https://github.com/influxdata/docs-v2/pull/7788) confirmed that + Docker remains supported with Enterprise v3.11 and later. +- **Keep the Docker page published and indexed.** Docker remains required for + Core and Enterprise earlier than v3.11, and remains optional for later + Enterprise releases. - **Use `cascade.prepend` on `explorer/_index.md` for the transition notice, not a template banner.** `article/stable-version.html` is gated on a hardcoded product whitelist and a `/vN/` URL segment, neither of which @@ -68,7 +61,7 @@ limitation. (see `.claude/rules/layouts.md`). `article/special-state.html` has the same problem. `cascade.prepend` is documented in `DOCS-FRONTMATTER.md` and needs no template change. -- **Accept the twin cost of the cascaded notice, and remove it after v1.11.** +- **Accept the twin cost of the cascaded notice, and remove it at v1.11.** Prepended content appears in every Explorer Markdown twin and in `llms-full.txt`, which makes the first chunk of all 12 Explorer pages more alike (the twin-hygiene problem tracked in @@ -85,8 +78,8 @@ limitation. ## Explicitly out of scope -- WASM deployment instructions under `/influxdb3/enterprise/`. Those wait until - v1.10 ships; this change only prepares the routing and cross-links. +- New Explorer feature pages and the v1.11 release notes. This change only + prepares the routing and cross-links. - `data/products.yml` updates to `latest_patch` and `schema.operating_system`. Both change on release day, not before. - The `localhost` connection failure reported in @@ -97,12 +90,12 @@ limitation. ## How to update -The Explorer version ceiling appears in four places on -`content/influxdb3/explorer/install/docker.md`: the `metadata` frontmatter, the -`description` frontmatter, the lede, and the transition notice cascaded from -`content/influxdb3/explorer/_index.md`. Update the notice in `_index.md` once -and it changes on every Explorer page. Remove the `cascade.prepend` block when -v1.11 ships. +The Docker compatibility statement appears in the `metadata` frontmatter, +the `description` frontmatter, and the lede of +`content/influxdb3/explorer/install/docker.md`. +The transition notice cascades from `content/influxdb3/explorer/_index.md` +to every Explorer page. +Remove the `cascade.prepend` block when v1.11 ships. ## Verification @@ -122,7 +115,7 @@ v1.11 ships. curl -s --compressed https://docs.influxdata.com/influxdb3/explorer/install/docker/index.md | head -20 ``` - The Docker twin starts with `* Explorer v1.9 and earlier` above the lede. + The Docker twin starts with `* InfluxDB 3 Core and Enterprise` above the lede. 6. Ask the documentation MCP server "How do I install InfluxDB 3 Explorer?" after the corpus rebuilds. The answer routes by version instead of returning `docker run`.