Commit Graph

40 Commits (sql-difference-fn)

Author SHA1 Message Date
Jason Stirnaman c9708a18fa
chore(spell-check): improve Vale spell checking for code comments (#6876)
* chore(spell-check): improve Vale spell checking for code comments

- Enable spell checking in code blocks by removing ~code exclusion from InfluxDataDocs Spelling rule
- Add comprehensive filters to avoid false positives from:
  - camelCase and snake_case identifiers
  - hexadecimal values and version numbers
  - URL paths and URLs
  - shortcode attributes
  - code punctuation and symbols
- Fix spelling errors in code comments:
  - "includimng" → "including" in 3 files
  - "continously" → "continuously" in 5 files

This allows Vale to catch typos and spelling mistakes in code comments and documentation strings while avoiding false positives on actual code syntax and identifiers.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* chore(spell-check): add codespell configuration

- Add .codespellrc with 'clear' builtin dictionary to catch unambiguous spelling errors
- Add .codespellignore for technical terms and product names
- Configuration prevents false positives while enabling comprehensive spell checking for code comments

This enables codespell for automated spell checking via CI/CD, complementing the Vale configuration.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* fix(reference): correct 6 spelling errors across reference pages

Fixes identified through codespell analysis of reference documentation:

- influxdb/v2/config-options: useable → usable
- influxdb3/clustered/release-notes: provid → provide, certficate → certificate, memeory → memory, Geting → Getting
- kapacitor/v1/release-notes: auotmatically → automatically

Note: "invokable" is excluded as a branding term; "fpr" in GPG code is a legitimate field name.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* docs(spell-check): improve validation rules and documentation

Core improvements to spell-checking rules:

CODESPELL CONFIGURATION (.codespellrc):
- Use only 'clear' dictionary (removes 'rare', 'code' for fewer false positives)
- Add 'api-docs' to skip list (avoids false positives in generated specs)
- Add 'invokable' to ignore list (product branding term)
- Remove unclear 'tage' term
- Add documentation explaining each setting

VALE CONFIGURATION (Spelling.yml):
- Expand scope documentation explaining why code blocks are included
- Add comprehensive comments for each filter pattern
- Include examples for each regex pattern
- Document limitations and edge cases
- Organize filters by category (branding, URLs, code, literals)

NEW DOCUMENTATION (SPELL-CHECK.md):
- Tool comparison and use cases
- Detailed explanation of each filter pattern
- Troubleshooting guide
- Running instructions for both tools
- Contribution guidelines
- References and related files

These changes ensure:
 Minimal false positives (8.5-9/10)
 Strong true positive detection (8.5-9.5/10)
 Clear, maintainable rules
 Easy to extend and modify
 Well-documented for team use

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* refactor(spell-check): consolidate ignore words to single source

Consolidate duplicate ignored words configuration:

BEFORE:
- .codespellignore: AKS, aks, invokable, tagE
- .codespellrc: inline ignore-words-list = aks,invokable
- Problem: Maintenance duplication and confusion

AFTER:
- .codespellignore: authoritative list (aks, AKS, invokable with docs)
- .codespellrc: references .codespellignore via 'ignore-words' config
- Benefit: Single source of truth, cleaner configuration

Also removed:
- 'tagE' from ignore list (unclear, possibly a typo)
- Inline word list from .codespellrc (now external)

This follows codespell best practices and reduces maintenance burden.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* docs(spell-check): correct version number regex documentation

Fix incorrect limitation note in SPELL-CHECK.md:

The regex pattern \d+\.\d+(?:\.\d+)* actually DOES match
4-part versions like 1.2.3.4 (and any number of parts).

The (?:\.\d+)* part is a repeating group that matches
zero or more additional dot-separated version components.

Updated documentation to clarify that the pattern handles
any number of version parts, not just 2-3 part versions.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* Update SPELL-CHECK.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix(spell-check): tighten camelCase regex to prevent false negatives

The original camelCase regex pattern was too permissive and would match
any word starting with lowercase (e.g., 'provide', 'database', 'variable'),
causing Vale to skip spell-checking normal prose words.

Improved pattern now requires:
- camelCase: at least one uppercase letter (myVariable ✓, provide ✗)
- snake_case: at least one underscore (my_variable ✓, variable ✗)

This prevents common prose words from being silently excluded from
spell-checking while still properly handling code identifiers.

Combined pattern: (?:_*[a-z]+(?:[A-Z][a-z0-9]*)+(?:[A-Z][a-zA-Z0-9]*)*|[a-z_][a-z0-9]*_[a-z0-9_]*)

Updated files:
- SPELL-CHECK.md: Added detailed explanation and test cases
- .ci/vale/styles/InfluxDataDocs/Spelling.yml: Updated filter pattern

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* fix(spell-check): expand URL scheme pattern to match documentation comment

The comment said the URL filter ignores 'http, https, ftp, etc.' but the
regex only matched http and https. Expanded the pattern to match:

- http/https (as before)
- ftp/ftps (file transfer protocols)
- ssh (secure shell)
- file (local file URLs)

Updated pattern: (?:https?|ftp|ftps|ssh|file)://[^\s\)\]>"]+

This ensures the filter matches the documented behavior.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-28 14:24:23 -06:00
Jason Stirnaman f72f3564ae
Update content/influxdb3/clustered/reference/release-notes/clustered.md 2026-01-05 17:04:22 -06:00
Dustin Eaton f6da51829b feat: Clustered release 20251218-1946608 2026-01-05 12:56:28 -06:00
Jason Stirnaman 5b37cb7eba
fix(clustered): use "database" instead of "namespace" in release notes (#6583)
* docs(influxdb3): Use the CLI (influxdb3 --version), /ping endpoint, or /health endpoint to get the actual InfluxDB product version—not the SQL version() function.

  Summary of Changes

  1. content/shared/sql-reference/functions/misc.md (SQL version() function)

  - Enhanced the description to clarify it returns the DataFusion query engine version
  - Added a Note callout explicitly stating this is NOT the InfluxDB product version
  - Added a link to the identify-version page for users who want to find their InfluxDB version
  - Added an expandable example with the actual query and output:
  SELECT version()
  - Output: Apache DataFusion 49.0.2, aarch64 on linux

  2. content/shared/identify-version.md (Identify version page)

  Added a Note callout in three locations:
  - Core-specific section (show-in "core")
  - Enterprise-specific section (show-in "enterprise")
  - General InfluxDB 3 Core and Enterprise section (in the tabs)

  Replaced hardcoded patch version with latest-version shortcode

* fix(clustered): use "database" instead of "namespace" in release notes

Replace user-facing "namespace" terminology with "database" in the
Clustered release notes for clarity. Add a note explaining that
"namespace" in environment variable names refers to a database.

closes influxdata/DAR#556
2025-12-02 12:24:00 -06:00
Scott Anderson 990da1b168
chore(clustered): added latest release artifacts and newly supported functionality (#6441)
* chore(clustered): added latest release artificts, enabled newly supported pages

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-10-06 10:08:53 -06:00
Brandon Pfeifer d1ee147153 docs: add artifacts and release notes for clustered release 20250925 2025-10-01 14:27:10 -04:00
Jason Stirnaman c748819f6d fix(clustered): Google Cloud IAM link 2025-09-09 16:53:47 -05:00
Jason Stirnaman f0117ed399 Update content/influxdb3/clustered/reference/release-notes/clustered.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-09-09 16:53:47 -05:00
Jason Stirnaman 6fcd870555 fix(clustered): Add known bug and clustered-auth override to release notes 2025-09-09 16:53:47 -05:00
Scott Anderson de8f5d2b34 hotfix(clustered): add missing release artifacts to latest clustered release notes 2025-08-28 17:39:57 -06:00
Jason Stirnaman f587fbaf48 fix: links containing hostname 2025-08-24 21:32:26 -05:00
David Rusnak 8151caa4f3 docs: add date to release notes 2025-08-20 12:30:40 -04:00
David Rusnak c1de7e71be docs: add artifacts and release notes for clustered release 20250814 2025-08-19 15:24:43 -04:00
Jason Stirnaman a38dd87629 Update content/influxdb3/clustered/reference/release-notes/clustered.md 2025-08-05 09:22:01 -05:00
Dustin Eaton ee20564750 Clustered release 20250721-1796368 2025-08-05 09:22:01 -05:00
David Rusnak c8d03d6d59 docs: address PR comments 2025-07-08 16:22:50 -04:00
David Rusnak 5ccad4043e docs: add release notes and artifacts for 20250707-1777929 2025-07-08 16:08:04 -04:00
Jason Stirnaman c9bc5e1e8e fix(clustered): release number should match files in downloads/clustered-release-artifacts 2025-06-23 16:27:51 -05:00
Scott Anderson e3e76b46d5 removed clustered release artifacts links without actual artifacts 2025-06-23 13:46:44 -06:00
Dustin Eaton 2815721f5f add release notes for 2025-06-18 Clustered release 2025-06-18 12:32:29 -05:00
Scott Anderson 27a276a564
Clustered release 20250613-1754010 (#6134)
* added release notes for jun 2025 clustered release

* updated clustered release number

* Update clustered.md

* corrected release number, added release artifacts
2025-06-13 14:01:43 -05:00
Scott Anderson 67963c8e56 hotfix: improved instructions for downloading clustered release artifacts manually 2025-06-10 16:15:00 -06:00
Scott Anderson f38ca674bf
Add release artifacts to Clustered release notes (#6132)
* WIP add build artifacts to clustered release notes

* added artifacts helper script, added artifacts, added artifact links to clustered release notes

* add instructions for downloading release artifacts manually

* added jq installation links
2025-06-10 16:57:08 -05:00
Scott Anderson 5435140582 hotfix: fix nav orphans and sorting, update clustered token delete to revoke 2025-05-13 09:25:11 -06:00
Scott Anderson 2c0a35bc1a
Clustered release 20250508-1719206 (#6054)
* update database delete behavior

* chore: update docs for 20250508-1719206 clustered release (#6051)

* chore: update docs for 20250508-1719206 release

* Apply suggestions from code review

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>

* Update content/influxdb3/clustered/reference/cli/influxctl/database/delete.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Logan <mail@logan-cox.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-05-13 07:07:20 -06:00
Maya Strandboge 8e62adaff5
Release influxctl v2.10.0 (#5959)
* Release influxctl v2.10.0

* Database token expiration in Dedicated and Clustered (#5930)

* adds database token expiration to dedicated and clustered docs

* update to fix md lint

* updates influxctl create in dedicated

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* udpates for influxctl 2.10.0 (#5960)

* added missing expires at information to cloud-dedicated token mgmt

* influxctl 2.10.0 release notes (#5961)

* influxctl 2.10.0 release notes

* corrected influxctl release note

* corrected punctuation in influxctl release note

* corrected link urls in shared influxctl release notes

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
2025-04-04 11:57:06 -06:00
Jason Stirnaman c37e50e352
Merge branch 'master' into jts/dar-472-catalog-terminology 2025-03-14 17:34:39 -05:00
Scott Anderson 8cada04c55
updated all notes and warnings in influxdb3 to use gh alert syntax (#5890) 2025-03-13 17:02:04 -06:00
Jason Stirnaman b1773f4e2b
Merge branch 'master' into jts/dar-472-catalog-terminology 2025-03-13 14:06:33 -05:00
Scott Anderson 242490d617
hotfix: removed clustered 20240925 release from release notes (#5883)
* hotfix: removed clustered 20240925 release from release notes

* move relevent info to the release following the removed release
2025-03-11 17:21:44 -06:00
Jason Stirnaman 8491969abd fix(clustered): Closes https://github.com/influxdata/DAR/issues/472. Catalog terminology is confusing, needs scaling recommendations:
- Distinguish between Catalog store (Postgres db) and Catalog service (API and cache for the store).
- Add scaling recommendations for each.
- Resolve conflicting scaling info, remove duplicated scaling info from storage-engine.md.
2025-03-11 17:18:05 -05:00
Jason Stirnaman ae32fa01f9
Update content/influxdb3/clustered/reference/release-notes/clustered.md 2025-02-24 09:16:58 -06:00
Scott Anderson a39644200e updated clustered upgrade, closes influxdata/DAR#479, closes influxdata/DAR#480 2025-02-21 15:31:55 -07:00
David Rusnak 6b588059f6 fix: address comments 2025-02-14 12:38:19 -05:00
David Rusnak 494b923582 docs: add release notes for 20250212 2025-02-14 09:47:57 -05:00
Scott Anderson d234e1ebda
influxctl 2.9.9 release notes and changes (#5815) 2025-02-03 09:27:50 -07:00
Jennifer Moore a51603ef4c
Revert "Revert "docs: add dec 2024 clustered release notes"" 2025-01-17 13:40:18 -06:00
Jennifer Moore ab3dbc6ccb
Revert "docs: add dec 2024 clustered release notes (#5774)"
This reverts commit d5948dbfe5.
2025-01-16 10:02:10 -06:00
Bill O'Connell d5948dbfe5
docs: add dec 2024 clustered release notes (#5774)
* docs: add dec 2024 clustered release notes

* just some docs-style updates

---------

Co-authored-by: Scott Anderson <scott@influxdata.com>
2025-01-14 15:19:31 -07:00
Scott Anderson 72c5295eed
InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760)
* WIP monolith docs

* WIP monolith

* updated alpha shortcode

* template updates for v3 and pro

* SQL & InfluxQL reference docs for Pro and OSS v3 (#5718)

* point to shared influxql source files

* add sql and influxql references to pro and oss v3 docs

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* ported changes to distributed influxql refs

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* Influxdb3 restructure (#5744)

* WIP monolith naming restructure

* rebuild homepage

* updated broken home links

* stabs in the dark

* fixed duplicate-oss shortcode

* move clustered and cloud-dedicated

* clean-up serverless cruft

* add distributed product redirects

* standarize productPathData

* switch back to findRE for productPathData

* remove debugging code

* move cloud dedicated content

* new product dropdown

* Jstirnaman/influxdb3 restructure (#5743)

* LDAPS and LDAP Client Certificate Docs

Add documentation via LDAP sample configuration for LDAPS and LDAP client certificates. These are new features in the yet-to-be released Enterprise 1.11.7

* Update bucket-schema.md

ndjson.org goes to some sort of sports betting site.

https://jsonlines.org/ is probably a better site.

* fix(partitioning): improve clarity and consistency in partitioning, apply suggestions from @reidkaufmann

* update shared links to use ambiguous version

* WIP monolith docs

* template updates for v3 and pro

* move clustered and cloud-dedicated

* switch back to findRE for productPathData

* move cloud dedicated content

* chore(influxdb3): port cloud-dedicated URLs from recent commit

* chore(influxdb3/clustered): fix and update links

* removed merge cruft

---------

Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com>
Co-authored-by: Daniel Lo <wilburlo@gmail.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com>
Co-authored-by: Daniel Lo <wilburlo@gmail.com>

* added and styled alpha banner, updated producted selector styles and js

* updated alpha link styles

* updated discord link text

* updated alpha message

* fix page title

* Initial Files

* Initial Files

* InfluxDB 3 Enterprise CLI docs (#5745)

* WIP influxdb3 cli

* fix page title

* influxdb3 enterprise cli

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* fix(js): initialize CodePlaceholder on content loaded, small refactor toward component pattern.

* updated URL modal for core and enterprise

* remove testing code on install page

* InfuxDB 3 Enterprise configuration options (#5749)

* fix page title

* add enterprise 3 configuration options

* revert command updates to avoid conflicts

* updated config option name

* CLI updates, reorg, and photos

* updated host-id option to writer-id

* InfluxDB 3 Core CLI (#5750)

* WIP make influxdb3 docs shared

* finish making influxdb3 enterprise cli shared

* add influxdb3 core cli docs

* update config option name

* updated host-id to writer-id

* updated a few more host-id options to writer-id

* InfluxDB 3 Core configuration options (#5752)

* added missing enterprise config options

* add influxdb3 core config options, update enterprise options

* minor fixes in core config options

* update search integration data (#5753)

* Add shared v3 line protocol doc to Core and Enterprise (#5754)

* add shared v3 line protocol doc to core and enterprise

* Update content/shared/v3-line-protocol.md

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>

* feat: update getting started guides

* Update content/influxdb3/core/_index.md

* Update content/influxdb3/core/_index.md

* update use of 3.0 and v3 to just 3

* add basic download/install instructions (#5756)

* chore(monolith): port Enterprise and Core get-started guides to shared for reuse as /index and /get-started

* fix(monolith): reapply previous description change

* Jts/update Get started for monolith (#5759)

* fix(monolith): get-started cleanup (spelling, style, APIs)
- Finished Enterprise for now, not ported to Core.

* fix(monolith): python sample columns

* fix(monolith): Ports edits to Core, misc. fixes

* update alpha message

* add state to product dropdown items

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Geoffrey Wossum <gwossum@influxdata.com>
Co-authored-by: Daniel Lo <wilburlo@gmail.com>
Co-authored-by: Peter Barnett <peterbarnett@Peters-MacBook-Pro.local>
Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
Co-authored-by: Paul Dix <paul@pauldix.net>
2025-01-13 07:21:11 -07:00