Commit Graph

126 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 8035366677
refactor: replace URL-parsing in shortcodes with cascade product data (#6883)
* chore: add .worktrees to gitignore

* refactor: replace URL-parsing in shortcodes with cascade product data

Replace duplicated URL-parsing logic across 28 shortcodes with Hugo's
cascade frontmatter. Each product section's _index.md now cascades
`product` (data key) and `version` (URL segment) to all descendants.

Key changes:
- Add cascade frontmatter to 15 product _index.md files
- Create layouts/partials/product/get-data.html shared partial
- Refactor 28 shortcodes to use the partial instead of parsing URLs
- Add version_label, limits, and distributed_architecture metadata
  to data/products.yml to eliminate hardcoded dicts in shortcodes
- Fix lefthook lint-markdown-instructions glob format (YAML array)
- Fix pre-existing Vale exclamation point errors in cloud and v2

* fix: prevent remark-lint from escaping Hugo template syntax in shortcodes

Lefthook's glob option only triggers whether a command runs — it does
not filter {staged_files}. This caused remark-lint to process .md
shortcode files in layouts/, escaping underscores, brackets, and
parentheses that are valid Hugo template syntax.

Add layouts/ exclusion to the existing content/ filter in the
lint-markdown-instructions run command. Also fix the 3 shortcode files
that were damaged by remark-lint in the previous commit.

* test: add E2E tests for cascade product shortcodes

Add Cypress tests validating all refactored shortcodes across 14
product/version combos (82 tests). Test expectations are derived
from products.yml at runtime via cy.task('getData').

Fix the product links test to iterate actual home page links
instead of all products.yml entries.

Create _test/shortcodes.md pages in each product section
exercising product-name, product-key, current-version,
influxdb/host, and InfluxDB3-specific shortcodes.

* test: expand E2E coverage to 27 of 28 cascade shortcodes

Add shortcode invocations to all 14 test pages and corresponding
Cypress assertions for version lookups, namespace URLs, product
name text, placeholder_host, version visibility, CTA links, and
site-level data.

Add shortcodes-real-pages.cy.js for 6 shortcodes that require real
page context (cli/mapped, children, flux/list-all-functions,
telegraf/plugins, html-diagram/sso-auth-flow, cli/influxd-flags).

Suppress Vale on test pages — they contain only shortcode syntax,
not prose.

163 tests total, all passing.

* refactor(test): rename _test dirs to __tests__ and add noindex

Rename test page directories from _test to __tests__ to align with
JS testing conventions. Add noindex: true to all 14 test page
frontmatter to prevent search engine indexing in production.
Update Cypress URL pattern to match new paths.
2026-02-27 09:46:57 -06:00
Copilot ba28e124b1
Add Documentation MCP server pages to chronograf, kapacitor, flux, and explorer (#6833)
* Initial plan

* feat: add Documentation MCP server pages to chronograf, kapacitor, flux, and explorer

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix: update MCP page descriptions to include product names

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* fix: resolve product-name shortcode for v1/v0 versioned products

The shortcode previously only checked the second URL path segment to
identify products, which works for InfluxDB 3 (/influxdb3/core/) but
fails for older products where the second segment is a version number
(/chronograf/v1/, /flux/v0/).

Add namespace extraction (first path segment) and conditional logic to
look up products by namespace when the version is v1 or v0. This fixes
empty product names in meta descriptions for Chronograf, Telegraf,
Kapacitor, Flux, and InfluxDB Enterprise v1.

* feat: relocate v2/cloud MCP pages and add alt_links for cross-product navigation

- Move MCP server pages from reference/ to tools/ for InfluxDB v2 and Cloud
- Add alt_links frontmatter to all MCP pages for cross-product navigation
- Use product-name shortcode in descriptions for consistency
- Convert code-placeholders shortcode to fenced code block attributes
- Update shared content to use version-agnostic URLs

* Add multi-assistant installation instructions for documentation MCP server (#6836)

* Initial plan

* feat(mcp): add installation instructions for multiple AI assistants

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

* refactor(mcp): replace Cline and Windsurf with GitHub Copilot and OpenCode

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2026-02-18 14:20:26 -06:00
Jakub Bednar 71e4a65f22 Release Kapacitor v1.8.2 2025-09-29 14:24:11 +02:00
karel rehor 93eb70d377 chore: switch list from ordered to unordered. 2025-09-08 16:26:48 +02:00
karel rehor 632b99fafc chore: update release notes and data for kapacitor-1.8.1 2025-09-08 15:10:40 +02:00
Jason Stirnaman f587fbaf48 fix: links containing hostname 2025-08-24 21:32:26 -05:00
Jason Stirnaman a816f51c29
Apply suggestions from code review
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-08-21 08:48:53 -05:00
Jason Stirnaman 29ff1ba739 chore(tools): remove minor version from product name in sidebarDisplay Kapacitor v1 instead of Kapacitor v1.<patch> 2025-08-20 16:16:48 -05:00
Jason Stirnaman 52ea0bf2cc
Update _index.md
Previous Kapacitor version in menu
2025-08-20 07:52:27 -05:00
Jakub Bednář 7a895276ca
Release Kapacitor v1.8.0 (#6156)
* Release Kapacitor v1.8.0

* Update content/kapacitor/v1/reference/about_the_project/release-notes.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-06-30 17:53:16 -05:00
karel-rehor dad38c90d6
Update content/kapacitor/v1/guides/anomaly_detection.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-06-06 17:04:40 +02:00
Scott Anderson b5a931279c
Apply suggestions from code review 2025-06-06 09:27:08 -05:00
karel rehor c98f6cfc95 chore: cleanup lint warning 2025-06-06 13:30:46 +02:00
karel rehor 7f901a0673 chore: remove refrences to Python2 in kapacitor anaomaly_detection. 2025-06-06 13:28:46 +02:00
Jason Stirnaman 36cfabae9c fix: broken links
- Flux links in Kapacitor and others: flux/v0.x/ -> flux/v0/
- influxdb/v2%2E0/ -> influxdb/v2/
2025-06-04 17:05:46 -05:00
Jakub Bednář 6696812e70
Release Kapacitor v1.7.7 (#6090)
* Release Kapacitor v1.7.7

* docs: use GitHub-style callouts

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

* Update content/kapacitor/v1/reference/about_the_project/release-notes.md

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-06-04 15:06:36 -05:00
Jakub Bednar 232e28f4c4 Release Kapacitor v1.7.6 2024-10-28 14:11:05 +01:00
vlastahajek 5c550e82d7 chore: formatting improvement 2024-10-28 14:05:18 +01:00
vlastahajek 0c6c335a2c chore: Improved description 2024-10-28 14:05:18 +01:00
vlastahajek c8edf061f1 feat: nww kafka sasl oauth params 2024-10-28 14:05:18 +01:00
Jakub Bednář 4a1aeadbbb docs: Update content/kapacitor/v1/reference/about_the_project/release-notes.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-06-18 10:03:28 -06:00
Jakub Bednar e6d7bff287 Release Kapacitor v1.7.5 2024-06-18 10:03:28 -06:00
alespour 2f57ac9fcc
Kapacitor v1.7.4 (#5438) 2024-04-23 17:43:02 +02:00
Jakub Bednář 7ec52d72c3
Release Kapacitor v1.7.3 (#5380) 2024-03-22 07:12:47 -06:00
Jakub Bednář 4ebfffa20a
Release Kapacitor v1.7.2 (#5335)
* Release Kapacitor v1.7.2

* Update content/kapacitor/v1/reference/about_the_project/release-notes.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-02-26 13:35:09 -07:00
Andreas Deininger 476a73e95e
Fixing typos (#5315)
* Fix typos

* Bump hugo to latest version v0.122.0

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-02-05 09:51:51 -07:00
Andreas Deininger c9488e3465
Fixing typos (#5242)
* Fixing typos

* Update content/enterprise_influxdb/v1/flux/guides/rate.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-11-27 09:32:55 -07:00
Scott Anderson 01e6d5c96e
InfluxDB 2.7.4 (#5232)
* InfluxDB 2.7.4, fix latest-patch shortcode for CLIs, update download links

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-11-14 16:49:35 -07:00
Scott Anderson 636f5ada45
V2 nav reorg (#5213)
* nest reference docs menu in v2 and cloud

* move migrate data into write data

* nest notebooks under tools

* nest templates under tools

* nest telegraf configs under tools

* cleanup weights and titles of tools sections

* reorg org and bucket management under admin

* add backup/restore to admin, clean up related links

* restructure security sections under admin

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* updated serverless cli docs to address pr feedback

* Update content/influxdb/cloud/admin/organizations/delete-org.md

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* port v2 install changes to new structure

* address pr feedback and ported missing content to serverless

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-11-06 15:53:12 -07:00
Scott Anderson fa399d9fb7
update release note date format and links (#5208) 2023-10-30 14:57:17 -06:00
Scott Anderson e0613d6b29 hotfix: Kapacitor 1.7.1 2023-10-23 14:16:49 -06:00
Scott Anderson 16ed30ae49
Kapacitor CLIs (#5162)
* WIP kapacitor command line tools

* added note to kapacitor delete command

* finished kapacitor cli docs

* updated kapacitor cli landing page

* Apply suggestions from code review

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>

* updated kapacitor service-tests example output

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-10-03 10:49:57 -06:00
Scott Anderson 09d283ff56
Kapacitor 1.7 (#5151)
* Kapacitor 1.7 and reorg

* fixed references to kapacitor 1.6
2023-09-22 11:35:04 -06:00
Scott Anderson 35ad46c4c2
Version restructure (#5133)
* mass changes for version restructure

* fixed latest-patch and flux version generator

* updated hugo configs

* fixed flux frontmatter injector

* fixed flux frontmatter injector

* WIP api generator updates for version restructure (#5128)

* fixed telegraf plugin list

* removed latest shortcode

* fixed current-version

* fixed product dropdown crosslinking

* fixed alt links

* WIP fixing links

* fixed broken links

* updated api doc generation

* fixed additional resources

* added version redirects to edge.js

* fixed search placeholder

* fixed paged titles
2023-09-12 23:33:31 -06:00
lwandzura 71a61c080d
updated event handler URL (#4638) 2022-11-16 09:45:50 -06:00
lwandzura b8c6beaa2a
Add shared secret kapa (#4451)
* added shared secret to http section

* added shared secret to http section
2022-09-12 11:35:39 -05:00
lwandzura eb2360eea8
Kapa 1.6.5 release notes (#4353)
* created initial release notes

* fixed apostrophe

* added today's date
2022-09-06 09:38:01 -05:00
lwandzura f8872a11cc
removed kapa enterprise from 1.6 (#4394) 2022-08-27 09:42:03 -05:00
lwandzura 8943c6394e
deprecated talk event handler (#4379) 2022-08-23 10:20:40 -05:00
peterreg eb34c798dd
Adding InfluxDB University course links to relevant areas in docs (#4102)
* Adding InfluxDB University videos to various docs.

* Update content/enterprise_influxdb/v1.9/introduction/installation/_index.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

* Add edits from kelseiv

* Adding edit from Scott

Thanks!

Co-authored-by: peterreg <pregan@influxdata.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-06-08 17:07:27 -07:00
kelseiv 9f9804c8a6
fix dar 266 (#4086) 2022-06-03 16:02:11 -07:00
Scott Anderson 41ec990f38
remove not about auto-creating kapa flux db, closes influxdata/DAR#275 (#3974) 2022-04-22 16:55:41 -06:00
lwandzura b6bc0647cd
Add to template (#3886)
* added TICK script example

* add toTemplate info and example
2022-03-28 15:11:20 -05:00
lwandzura 29fc5c8733
Add SASL description and config options (#3885)
* Add SASL description and config options

* Update content/kapacitor/v1.6/event_handlers/kafka.md

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-03-25 08:15:20 -05:00
lwandzura 3dcda9150b
remove TLS 1.0 and 1.1 references (#3882) 2022-03-23 08:13:54 -05:00
lwandzura 2deea652bf
Kapa v1.6.4 realese notes (#3876)
* added features to release notes

* add Kapa 1.6.4 release notes

* changed some formatting

* cleaned up formatting

* updates based on feedback
2022-03-22 14:41:34 -05:00
lwandzura 0782127bf0
correct the command to kapacitord (#3853)
* correct the command to kapacitord

* Update content/kapacitor/v1.6/administration/security.md

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

* Update content/kapacitor/v1.6/administration/security.md

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

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2022-03-14 11:34:41 -05:00
pierwill 348c099f29
Kapacitor: Clean up configuration file locations (#3836)
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2022-03-07 13:57:06 -06:00
Scott Anderson fed1488e7d fix menu items with external URLs, closes #3797 2022-02-22 10:00:03 -07:00