docs(explorer): restructure install docs for v1.10 WASM transition - #7734
Closed
jstirnaman wants to merge 4 commits into
Closed
jstirnaman wants to merge 4 commits into
jstirnaman wants to merge 4 commits into
Conversation
Contributor
Vale Style Check Results
✅ Check passed |
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
…iness 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
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
jstirnaman
force-pushed
the
explorer-v1.10-install-restructure
branch
from
September 16, 2026 19:49
c5f0c16 to
c103ba9
Compare
Contributor
Author
Contributor
Author
jstirnaman
pushed a commit
that referenced
this pull request
Sep 25, 2026
## 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 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv
jstirnaman
pushed a commit
that referenced
this pull request
Oct 1, 2026
## 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 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv
jstirnaman
added a commit
that referenced
this pull request
Oct 1, 2026
…ion (#7788) * 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 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv * 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 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv * 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 * docs(explorer): link PR in exec-plan status Claude-Session: https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7 * 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(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 * 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). * 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. * docs(explorer): remove duplicated version availability guide * 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. --------- Co-authored-by: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Planning and conventions for the InfluxDB 3 Explorer v1.10 transition. This PR is a draft and contains no published content changes yet.
docs/exec-plans/2026-09-02-explorer-install-version-routing.md— decision record for restructuring the Explorer install documentation.docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md— ordered pre-release, release-day, and post-release task sequence for the v1.10 and accompanying Enterprise release.DOCS-VERSION-AVAILABILITY.md— feature-agnostic conventions for stating 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.AGENTS.mdlists the new reference; instruction adapters regenerated.Content changes follow in this branch:
content/influxdb3/explorer/install.mdbecomesinstall/_index.md, a version-routing hubcontent/influxdb3/explorer/install/docker.mdholds the Docker instructions with an explicit version ceilingcontent/influxdb3/explorer/_index.md,about/_index.md,get-started.md, andrelease-notes/_index.mdstate the version and edition scopeWhy
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 carry no version or edition scoping, so readers, search engines, retrieval systems, and coding agents all get Docker as the unconditional answer to "how do I install Explorer", and Core as a supported target with no end version.
The conventions are separated from the release plan because they apply to any version-gated documentation, not only this release.
Closes #6702, which reports that the docs never state which distributions exist.
Impact
No published content changes yet. Decisions recorded:
/influxdb3/explorer/install/URL. It holds the search ranking, seven inbound in-repo links (three of them deep anchors), and thellms.txtcorpus entry. The problem is the page content, not its address.metadata,cascade.prepend) instead of new template logic.article/stable-version.htmlis gated on a product whitelist and a/vN/URL segment, neither of which applies to Explorer.data/notifications.yamlfor the release announcement and keep version facts in the pages. Notifications render in the footer, outside the article, so they never reach Markdown twins orllms-full.txt.GET /pingfor version verification, since WASM availability depends on the InfluxDB 3 server version and build, not on Explorer alone.x-influxdb-buildalso answers the edition question.Verification
yarn build:agent:instructionsandyarn validate:agent-instructionspass.lint-instructions,lint-markdown-instructions: 0 errors, 0 warnings).The exec-plans list the verification steps for the content changes that follow: Hugo build, anchor resolution,
yarn check:md-coherence, Cypress navigation tests, and published Markdown twin checks.https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7