ci: feature-agnostic conventions for stating a version or edition con… - #7789
Merged
Merged
Conversation
…straint: 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.
Contributor
Vale Style Check Results
✅ Check passed |
…page What changed: - Rewrite the "Include a version check" section of DOCS-VERSION-AVAILABILITY.md to state the rule and link to content/shared/identify-version.md instead of restating InfluxDB 3 CLI and /ping commands. - Scope the remaining /ping guidance explicitly to InfluxDB 3 Core and Enterprise. - Move the "HEAD returns 404" fact into content/shared/identify-version.md, beside both InfluxDB 3 /ping examples. Why: The section showed only InfluxDB 3 commands without saying so. A writer working on v1, v2, Clustered, or Cloud content would have followed it and documented the wrong CLI, port, and endpoint. The commands already live in one shared source that covers every product, so duplicating them here created a second place to drift. Impact: Contributor guidance only, plus one sentence added to the 11 pages that consume the shared file. No commands or behavior change. Verification: - yarn verify:changed on both paths. - yarn lint-codeblocks content/shared/identify-version.md passes. - HEAD/404 confirmed against api-docs/_build/influxdb3/core/influxdb3-core-openapi.yaml, where /ping defines only get and post.
Contributor
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/enterprise_influxdb/v1/administration/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/cloud/admin/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v1/administration/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb/v2/admin/identify-version/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/cloud-dedicated/admin/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud-serverless/admin/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/cloud/admin/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/clustered/admin/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/core/admin/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/admin/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/platform/identify-version/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
Full details: workflow run summary and artifact. Last updated: 2026-09-18 16:07:25 UTC
github-actions
Bot
added
product:shared
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.
No description provided.