docs(explorer): restructure install docs for v1.10 WASM transition - #7734
Draft
jstirnaman wants to merge 4 commits into
Draft
docs(explorer): restructure install docs for v1.10 WASM transition#7734jstirnaman wants to merge 4 commits into
jstirnaman wants to merge 4 commits into
Conversation
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
Contributor
Vale Style Check Results
✅ Check passed |
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
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