Skip to content

style(enterprise): clean up InfluxQL spec and fix broken config links#6949

Merged
jstirnaman merged 2 commits intoworktree-jts-fix-unpublish-ent-1.12.3from
jts-enterprise-v1-cleanup
Mar 14, 2026
Merged

style(enterprise): clean up InfluxQL spec and fix broken config links#6949
jstirnaman merged 2 commits intoworktree-jts-fix-unpublish-ent-1.12.3from
jts-enterprise-v1-cleanup

Conversation

@jstirnaman
Copy link
Contributor

Summary

Formatting and style cleanup for existing Enterprise v1 documentation — not version-specific, applies to current v1.12.2 docs.

InfluxQL spec (content/enterprise_influxdb/v1/query_language/spec.md):

  • Update frontmatter: improve description, remove stale v2 alias, add related: links
  • Replace absolute-URL manual TOC with relative-anchor TOC
  • Convert > **NOTE:** / > **Note:** callouts to > [!Note] format throughout
  • Fix h5 headings in EXPLAIN ANALYZE section to h4 for correct nesting
  • Fix broken anchor links (#execution-time#execution_time, #planning-time#planning_time)
  • Fix cross-reference links in EXPLAIN ANALYZE to use absolute paths to OSS v1 spec
  • Fix typos: "keywords" → "keyword", "retention polices" → "retention policies"
  • Rewrite KILL QUERY section with proper #### Syntax header and combined example block
  • Fix SHOW STATS headings: remove backtick-wrapping from ### \SHOW STATS FOR...`` headings
  • Add [with_key_clause] to SHOW TAG KEYS grammar production and add example
  • Remove trailing whitespace in SHOW SHARDS section

Config meta nodes (content/enterprise_influxdb/v1/administration/configure/config-meta-nodes.md):

  • Fix 3 broken cross-references that pointed to /enterprise_influxdb/v1/administration/config-data-nodes#... (missing configure/ path segment and trailing slash) — corrected to /enterprise_influxdb/v1/administration/configure/config-data-nodes/#...

Notes

…loses #6590)

The correct InfluxQL syntax has always been FUTURE LIMIT before PAST LIMIT.
The old docs incorrectly showed PAST before FUTURE in grammar definitions,
examples, and section ordering. Also fixes a broken glossary anchor link
for replication factor and adds missing production rule definitions to the
spec.
…inks

- Update frontmatter: improve description, remove v2 alias, add related links
- Replace absolute-URL TOC with relative-anchor TOC
- Convert legacy `> **NOTE:**` callouts to `> [!Note]` format
- Fix h5 headings in EXPLAIN ANALYZE section to h4
- Fix broken anchor links (#execution-time, #planning-time → #execution_time, #planning_time)
- Fix cross-reference links in EXPLAIN ANALYZE to use absolute paths
- Fix typos: "keywords" → "keyword", "retention polices" → "retention policies"
- Rewrite KILL QUERY section with proper Syntax header and combined example block
- Fix SHOW STATS headings: remove backtick-wrapping from section headings
- Add [with_key_clause] to SHOW TAG KEYS grammar and add example
- Remove trailing whitespace in SHOW SHARDS section
- Fix 3 broken cross-references in config-meta-nodes.md to use correct
  /enterprise_influxdb/v1/administration/configure/config-data-nodes/ path
@jstirnaman jstirnaman requested a review from a team as a code owner March 14, 2026 20:22
@jstirnaman jstirnaman requested review from sanderson and removed request for a team March 14, 2026 20:22
@github-actions github-actions bot added the product:v1-enterprise InfluxDB Enterprise v1 label Mar 14, 2026
@github-actions
Copy link
Contributor

PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-6949/
on branch gh-pages at 2026-03-14 20:24 UTC

@github-actions
Copy link
Contributor

Preview Pages for Review

2 page(s) changed in this PR:

Preview URLs

@github-copilot please review the preview pages listed above using the template below:

Visual Review Prompt

Review the rendered documentation pages at the preview URLs listed below.
Check each page for visual and structural issues that are invisible in the
Markdown source.

Checklist

For each preview URL, verify:

  • No raw shortcodes — No {{< or {{% syntax visible on the page
  • No placeholder text — No PLACEHOLDER, TODO, FIXME, or
    template variables visible in rendered content
  • Layout intact — No overlapping text, missing images, or collapsed
    sections
  • Code blocks render correctly — No raw HTML fences or Markdown
    syntax visible inside code blocks
  • Product names correct — Page header, breadcrumbs, and sidebar show
    the correct product name
  • No 404s or errors — Page loads without error states
  • Navigation correct — Sidebar entries link to the right pages and
    the page appears in the expected location

Output

Follow the shared review comment format, severity definitions, and label
mapping in
templates/review-comment.md.

Adapt the "Files Reviewed" section to list preview URLs instead of file
paths.

Preview URLs

Copy link
Contributor Author

@jstirnaman jstirnaman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Base automatically changed from jts-enterprise-v1.12.2-fixes to worktree-jts-fix-unpublish-ent-1.12.3 March 14, 2026 20:36
@jstirnaman jstirnaman merged commit f05f9e8 into worktree-jts-fix-unpublish-ent-1.12.3 Mar 14, 2026
9 of 10 checks passed
@jstirnaman jstirnaman deleted the jts-enterprise-v1-cleanup branch March 14, 2026 20:40
github-actions bot added a commit that referenced this pull request Mar 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:v1-enterprise InfluxDB Enterprise v1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant