Skip to content

docs(v1): shared influx-cli page, v1.13.0 version tags, release-note links - #7701

Open
jstirnaman wants to merge 5 commits into
masterfrom
docs-7312-tsi-adaptive-cache
Open

docs(v1): shared influx-cli page, v1.13.0 version tags, release-note links#7701
jstirnaman wants to merge 5 commits into
masterfrom
docs-7312-tsi-adaptive-cache

Conversation

@jstirnaman

Copy link
Copy Markdown
Contributor

Closes #7662 (influx-cli/use-influx-cli.md entry)

What changed

  • Moves tools/influx-cli/use-influx-cli.md (v1 OSS + Enterprise) into
    content/shared/influxdb-v1/, leaving frontmatter stubs with source: in
    both editions. Gates the v1.13.0 mTLS CLI flags
    (-cert, -key, -root-ca, -insecure-certificate,
    -ignore-cert-sanity-checks) to Enterprise, since they're Enterprise-only.
    Gates the backup/export links, since OSS and Enterprise use different page
    slugs (backup_and_restore vs backup-and-restore).
  • Adds the {metadata="v1.13.0+"} tag to series-id-set-cache-max-size,
    -target-hit-rate, and -shrink-conservatism in both editions' config
    references, matching the tag already on user-write-bytes-enabled from
    the same release. Documents that series-id-set-cache-size must be
    greater than 0 to use adaptive sizing.
  • Links four v1.13.0 release-notes Features bullets (SHOW MEASUREMENTS,
    -timeout, influxd-ctl backup node selection) to their reference
    sections in both editions.

Why

The v1.13.0 doc set shipped without a shared copy of the influx-cli page,
inconsistent version tags on the adaptive-cache options, and several
Features bullets that didn't link anywhere. /code-review against issues
#7312 (TSI adaptive cache) and #7662 (shared-content migration) surfaced
these gaps.

Impact

Readers of both v1 editions get one maintained influx-cli page instead of
two drifting copies, and OSS no longer falsely documents Enterprise-only
mTLS client flags. Release-notes readers can jump straight to the relevant
reference docs for four more features.

Verification

  • npx hugo --quiet completes with no errors.
  • Rendered output checked per edition: OSS's influx-cli page omits
    -cert/-key/-root-ca/-insecure-certificate/-ignore-cert-sanity-checks
    and resolves backup links to backup_and_restore/; Enterprise includes the
    flags and resolves to backup-and-restore/.
  • New anchors confirmed in rendered HTML:
    id=override-the-default-timeout on influxd-ctl/_index.md and
    id=node-selection on influxd-ctl/backup.md.

Checklist

  • Signed the InfluxData CLA
  • Rebased/mergeable
  • Local build passes (npx hugo --quiet)

What changed
Moves the duplicated `tools/influx-cli/use-influx-cli.md` page (v1 OSS
and v1 Enterprise) into `content/shared/influxdb-v1/`, leaving
frontmatter stubs with `source:` in both editions. Gates the v1.13.0
mTLS CLI flags (`-cert`, `-key`, `-root-ca`, `-insecure-certificate`,
`-ignore-cert-sanity-checks`) to Enterprise with `show-in`, since
Enterprise's `_index.md` confirms they're Enterprise-only. Also gates
the backup/export links, since OSS and Enterprise use different page
slugs (`backup_and_restore` vs `backup-and-restore`).

Why
Closes the `tools/influx-cli/use-influx-cli.md` entry in #7662's
worklist for reconciling the remaining duplicated v1 pages.

Impact
Readers of both v1 editions get one maintained copy. OSS no longer
falsely documents Enterprise-only mTLS client flags.

Verification
- npx hugo --quiet completes with no errors.
- Rendered output checked per edition: OSS omits -cert/-key/-root-ca/
  -insecure-certificate/-ignore-cert-sanity-checks and resolves backup
  links to backup_and_restore/; Enterprise includes the flags and
  resolves to backup-and-restore/.
What changed
Links the v1.13.0 "SHOW MEASUREMENTS" release note bullet to the
InfluxQL query language reference.

Why
Other Features bullets in the same release entry already link out;
this one didn't. mTLS support, hardening-enabled, backup compression,
and the broader config value formats aren't linked because none of
those config options or flags are documented yet in
administration/config.md or tools/influxd/backup.md.

Verification
- npx hugo --quiet completes with no errors.
…tion

What changed
Adds the {metadata="v1.13.0+"} tag to series-id-set-cache-max-size,
-target-hit-rate, and -shrink-conservatism in both editions' config
references, matching the tag already on user-write-bytes-enabled from
the same release. Also documents that series-id-set-cache-size must
be greater than 0 to use adaptive sizing, since a floor of 0 disables
the cache entirely regardless of the other adaptive settings.

Why
Code review of the v1.13.0 doc range flagged the missing version tag
as inconsistent (all four options shipped together) and the floor
interaction as an undocumented edge case in issue #7312's spec.

Verification
- npx hugo --quiet completes with no errors.
What changed
Links the "-timeout" and "influxd-ctl backup" Features bullets in the
Enterprise v1.13.0 release notes to their reference sections. The
"influx-meta cleanup-shards" bullet stays unlinked — there's no
influx-meta command reference in this repo yet.

Why
mTLS was already linked; the other three Features bullets weren't.

Verification
- npx hugo --quiet completes with no errors.
- Rendered output confirms both anchors exist:
  id=override-the-default-timeout on influxd-ctl/_index.md and
  id=node-selection on influxd-ctl/backup.md.
@jstirnaman
jstirnaman requested a review from a team as a code owner August 24, 2026 23:39
@jstirnaman
jstirnaman requested review from sanderson and removed request for a team August 24, 2026 23:39
@github-actions

Copy link
Copy Markdown
Contributor

Vale Style Check Results

Metric Count
Errors 10
Warnings 12

Errors (blocking)

File Line Rule Message
content/influxdb/v1/about_the_project/release-notes.md 630 Google.Spacing 't.P' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 733 Google.Spacing 'e.G' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 946 Google.Spacing 'e.D' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 952 Google.Spacing 'r.C' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 954 Google.Spacing 'e.C' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 964 Google.Spacing 't.M' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 1007 Google.Spacing 'e.D' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 1167 Google.Spacing 'l.M' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 1204 Google.Spacing 'y.E' should have one space.
content/influxdb/v1/about_the_project/release-notes.md 1223 Google.Spacing 'y.E' should have one space.
Warnings (12)
File Line Rule Message
content/influxdb/v1/about_the_project/release-notes.md 163 InfluxDataDocs.Spelling Did you really mean 'buildtsi'?
content/influxdb/v1/about_the_project/release-notes.md 584 InfluxDataDocs.Spelling Did you really mean 'inmem'?
content/influxdb/v1/about_the_project/release-notes.md 660 InfluxDataDocs.Spelling Did you really mean 'inmem'?
content/influxdb/v1/about_the_project/release-notes.md 928 InfluxDataDocs.Spelling Did you really mean 'deletetsm'?
content/influxdb/v1/about_the_project/release-notes.md 1046 Google.Colons ': W' should be in lowercase.
content/influxdb/v1/about_the_project/release-notes.md 1188 InfluxDataDocs.Spelling Did you really mean 'dereference'?
content/influxdb/v1/about_the_project/release-notes.md 1233 InfluxDataDocs.Spelling Did you really mean 'dereference'?
content/influxdb/v1/about_the_project/release-notes.md 1351 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb/v1/about_the_project/release-notes.md 1630 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb/v1/about_the_project/release-notes.md 1851 InfluxDataDocs.WordList Use 'administrator' instead of 'admin'.
content/influxdb/v1/about_the_project/release-notes.md 1853 Google.Colons ': E' should be in lowercase.
content/influxdb/v1/about_the_project/release-notes.md 1863 InfluxDataDocs.Spelling Did you really mean 'ident'?

Check failed — fix 10 error(s) before merging.

@github-actions

Copy link
Copy Markdown
Contributor

Release version check

Product Release notes data/products.yml Status
enterprise_influxdb (latest_patches.v1) 1.13.0 1.13.0 ✅ in sync
influxdb (latest_patches.v1) 1.13.0 1.13.0 ✅ in sync

💡 Badge new features with the version

Documenting a new feature? Add a version badge in the page frontmatter — the
same mechanism used elsewhere in the docs:

  • metadata: [InfluxDB 3 Core v3.11+] — badge list under the page title
  • updated_in: v3.11 — an "Updated in v3.11" badge
  • introduced: v3.11 — a "‹Product› v3.11+" badge
  • menu.params.state: new — a "NEW" pill on the sidebar nav item

For inline version text, use {{< latest-patch >}} / {{< current-version >}},
which read the value from data/products.yml so it stays correct automatically.

@github-actions github-actions Bot added product:shared Shared content across products product:v1 InfluxDB v1 OSS product:v1-enterprise InfluxDB Enterprise v1 labels Aug 24, 2026
@github-actions

github-actions Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

🔗 Link Check Results — Link Check Bot

12 broken link(s) found — fix them before merging.

Metric Value
Files Checked 8
Total Links 2113
Errors 12
Warnings 14
Success Rate 98.15428%

Broken Links

Source File Broken URL Error Report
content/enterprise_influxdb/v1/about-the-project/release-notes/_index.md https://influxdata.com/blog/telegraf-controller-1-1-influxdb/ Rejected status code: 404 Not Found Report
content/enterprise_influxdb/v1/administration/configure/config-data-nodes/_index.md https://influxdata.com/blog/telegraf-controller-1-1-influxdb/ Rejected status code: 404 Not Found Report
content/enterprise_influxdb/v1/tools/influx-cli/use-influx-cli/_index.md https://influxdata.com/blog/telegraf-controller-1-1-influxdb/ Rejected status code: 404 Not Found Report
content/influxdb/v1/about_the_project/release-notes/_index.md https://influxdata.com/blog/telegraf-controller-1-1-influxdb/ Rejected status code: 404 Not Found Report
content/influxdb/v1/administration/config/_index.md https://influxdata.com/blog/telegraf-controller-1-1-influxdb/ Rejected status code: 404 Not Found Report
content/influxdb/v1/tools/influx-cli/use-influx-cli/_index.md https://influxdata.com/blog/telegraf-controller-1-1-influxdb/ Rejected status code: 404 Not Found Report
content/influxdb/v1/tools/influx-cli/use-influx-cli/_index.md #linux Fragment not found: #linux Report
content/influxdb/v1/tools/influx-cli/use-influx-cli/_index.md #macos Fragment not found: #macos Report
content/influxdb/v1/tools/influx-cli/use-influx-cli/_index.md #homebrew Fragment not found: #homebrew Report
content/influxdb/v1/tools/influx-cli/use-influx-cli/_index.md #linux Fragment not found: #linux Report
content/influxdb/v1/tools/influx-cli/use-influx-cli/_index.md #macos Fragment not found: #macos Report
content/influxdb/v1/tools/influx-cli/use-influx-cli/_index.md #homebrew Fragment not found: #homebrew Report
⚠️ 14 warning(s) (do not fail CI)
Source File URL Issue
content/enterprise_influxdb/v1/about-the-project/release-notes/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/enterprise_influxdb/v1/administration/configure/config-data-nodes/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/enterprise_influxdb/v1/tools/influx-cli/use-influx-cli/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/query File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/debug File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/delete-v2-compatible File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/delete-v2-compatible File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/debug File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/debug File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/buckets-v2-compatible File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/about_the_project/release-notes/_index.md file:///home/runner/work/docs-v2/docs-v2/public/influxdb/v1/api/buckets-v2-compatible File not found. Check if file exists and path is correct: File not found. Check …
content/influxdb/v1/administration/config/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…
content/influxdb/v1/tools/influx-cli/use-influx-cli/_index.md https://support.influxdata.com/ Network error: SSL certificate not trusted. Use --insecure if site is trusted (e…

Full details: workflow run summary and artifact. Last updated: 2026-08-25 14:30:46 UTC

@github-actions

github-actions Bot commented Aug 24, 2026

Copy link
Copy Markdown
Contributor

📦 PR Preview — Preview Bot

Status Details
Result ✅ DEPLOYED (full site)
Preview View preview
Build time 91s
Last updated 2026-08-25 14:32:43 UTC
Changed pages (6)

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:shared Shared content across products product:v1-enterprise InfluxDB Enterprise v1 product:v1 InfluxDB v1 OSS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Phase B: reconcile the 30 remaining InfluxDB v1 OSS/Enterprise duplicate pages

1 participant