docs-v2/layouts/shortcodes
Jason Stirnaman f084fe3a31
Ask AI group filters (#6529)
* feat(askai): add Kapa.ai source group filtering for InfluxDB v3

- Add ai_source_group_ids field to all InfluxDB v3 products in data/products.yml
- Add getProductSourceGroupIds() function to retrieve source group IDs from product data
- Enables filtered AI responses using Kapa source groups for documentation pages
- Follows existing pattern for dynamic product configuration
- Implement version-specific config support (__v1, __v2 suffixes)
- Append version hints to example questions for InfluxDB database products only
- Make example questions generic (remove product-specific names)
- Tools (Telegraf, Chronograf, Kapacitor, Flux, Explorer) display questions without version hints
- Pre-fills chat input with [version: /path/] for InfluxDB database products
- Users can easily edit or remove the pre-filled text
- Works for manual opens (Cmd+K) and programmatic opens
- Converts module to TypeScript

* refactor(ask-ai): change version format to 'My version: <product name>'

Use human-readable product names instead of URL paths for better UX.
Example: 'My version: InfluxDB 3 Core' instead of '[version: /influxdb3/core/]'

* fix(ask-ai): restore working Kapa.open() pre-fill implementation

- Replace textarea detection with direct Kapa.open() call
- Add Kapa preinitialization code
- Use click handler on .ask-ai-open button with capture phase
- Handle conversation reset event to re-fill version context
- Remove console logging for cleaner production code

* fix(ask-ai): remove parentheses from example questions for consistency

Make example question format match the pre-fill format:
- Before: 'question (My version: product)'
- After: 'question My version: product'

This ensures users don't think there's a difference between the two formats.

* fix(askai): add Explorer product mapping for Ask AI widget

- Add influxdb3_explorer mapping to getCurrentProductData()
- Add explorer context to getContext() function
- Ensures Explorer pages use correct ai_sample_questions from products.yml
- Reorder Explorer questions with 'install and run' first

This fixes the issue where Explorer Ask AI widget was showing wrong
example questions by properly loading the influxdb3_explorer config.

* test(page-context): add comprehensive e2e tests for product mappings

Add Cypress tests to validate page-context.js correctly identifies:
- Product context values for all InfluxDB products
- Product data from products.yml configuration
- Version information
- AI sample questions and source group IDs
- Placeholder host values

Tests cover:
- InfluxDB 3 (Core, Enterprise, Explorer, Cloud variants, Clustered)
- InfluxDB v2 and v1
- InfluxDB Cloud (TSM)
- Tools (Telegraf, Chronograf, Kapacitor, Flux)

Validates the fix for Explorer Ask AI showing correct example questions.

Related to #jts-askai-group-filters branch work.

* feat(test): add --no-mapping flag to e2e test runner

Allow running functionality tests without requiring content file paths.
The --no-mapping flag skips content-to-URL mapping, making it easier
to run tests that don't depend on specific content files.

Usage:
  # With content mapping (for content-specific tests)
  node run-e2e-specs.js content/influxdb3/core/_index.md

  # Without content mapping (for functionality tests)
  node run-e2e-specs.js --spec cypress/e2e/page-context.cy.js --no-mapping

Benefits:
- Simplifies running functionality tests like page-context.cy.js
- Reduces test startup time by skipping unnecessary file mapping
- Makes test commands clearer about their purpose

The page-context test was updated to work correctly with this flag.

* deps: update caniuse and related hook files

* test: Add a `--no-mapping` flag to run tests without specific content files (i.e., test contains all the URLs it needs)

* chore(ask-ai): Format example questions

* test(page-context): add comprehensive e2e tests for all products in products.yml

- Expanded test suite from 6 to 27 tests covering all products
- Added tests for InfluxDB 3 products (Explorer, Core, Enterprise, Cloud Serverless, Cloud Dedicated, Clustered)
- Added tests for InfluxDB v2 and Cloud (TSM)
- Added tests for InfluxDB v1 and Enterprise v1
- Added tests for other products (Telegraf, Chronograf, Kapacitor, Flux)
- Validates page mappings in page-context.js
- Validates AI sample questions configuration in products.yml
- All 27 tests passing

* fix(page-context): correct enterprise_influxdb URL pattern matching

- Changed pattern from /enterprise_v1/ to /enterprise_influxdb/
- Fixes Ask AI example questions not showing correctly for Enterprise v1
- Pattern now matches actual URL structure /enterprise_influxdb/v1/
- All 27 e2e tests passing

* test(page-context): add UI validation for Ask AI widget configuration

- Added 4 tests checking Kapa widget script data attributes
- Tests verify data-modal-example-questions contains correct product-specific questions
- Validates Explorer, Core, Enterprise, and Enterprise v1 configurations
- All 31 tests passing (27 existing + 4 new UI tests)

* feat(ask-ai): add help in Ask AI widget placeholder

- InfluxDB placeholder recommends specifying product and version
- Fix page-context.js to use products.influxdb_cloud instead of products.cloud
- Add UI tests verifying version-specific naming in Kapa widget script tags

* feat(ask-ai): Tailors placeholder for each version/product. Disables "Viewing <product>" in disclaimer note.
2025-11-18 16:43:02 -06:00
..
api fix(v3): remove v2-prefer note, replace with specific recommendations (#5195) 2023-10-26 14:45:38 -05:00
bucket-schema 4758 link to explicit bucket schemas leads to 404 (#4783) 2023-03-10 17:05:14 -06:00
cli InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
datetime Document v3 custom partitions (#5309) 2024-03-04 09:15:10 -07:00
flux Merge pull request #6079 from influxdata/chore-js-refactor-footer-scripts-modules 2025-06-09 14:40:37 -05:00
html-diagram InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
influxdb InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
influxdb3 hotfix: updated influxdb3 table limits 2025-04-15 08:44:41 -06:00
influxql Add InfluxDB 3 query guides (#5798) 2025-01-23 10:18:45 -07:00
resources Bump hugo to latest version v0.121.2 (#5293) 2024-01-17 09:15:00 -07:00
sql add sql window functions and new shortcodes 2025-02-21 14:11:32 -07:00
telegraf chore: document and use modern influxdata-archive.gpg 2025-07-08 12:39:23 -05:00
ui Create ui/timestamp-formats shortcode (#2259) 2021-03-19 16:36:51 -06:00
api-endpoint.html InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
ask-ai-link.html Ask AI group filters (#6529) 2025-11-18 16:43:02 -06:00
bucket-schema-requires.html Feature/2470 bucket schema (#2765) 2021-07-07 11:53:54 -05:00
caps.html InfluxDB 2.1 (#3367) 2021-11-08 09:48:11 -08:00
caption.html Influxdb 2.0.6 (#2459) 2021-04-29 14:04:33 -06:00
children.html chore(hugo): Update shortcodes and templates to avoid calling isset on <nil> 2025-05-19 14:57:15 -05:00
cite.html Work with Prometheus metrics in Flux (#3232) 2021-10-18 16:25:20 -06:00
cloud-token-auth.html Fix/2759 1.x query api (#2841) 2021-07-14 16:59:39 -05:00
cloud_regions.html IOx documentation (#4730) 2023-01-31 11:07:26 -07:00
code-callout.html Cloud Dedicated InfluxQL reference (#4959) 2023-05-26 10:30:08 -06:00
code-placeholder-key.html Dedicated influxql (#4976) 2023-06-07 12:55:09 -06:00
code-placeholders.html fix(code-placeholders): Store escaped expression in a data attribute 2025-04-23 10:25:25 -05:00
code-tab-content.html upgraded to hugo 0.55.1 and made necessary adjustments 2019-04-16 10:05:16 -06:00
code-tabs-wrapper.html upgraded to hugo 0.55.1 and made necessary adjustments 2019-04-16 10:05:16 -06:00
code-tabs.html upgraded to hugo 0.55.1 and made necessary adjustments 2019-04-16 10:05:16 -06:00
columns.html Document v3 custom partitions (#5309) 2024-03-04 09:15:10 -07:00
cta-link.html hotfix: fix influxdb3 cta links 2025-05-12 14:08:29 -06:00
current-version.html Version restructure (#5133) 2023-09-12 23:33:31 -06:00
diagram.html Merge pull request #6079 from influxdata/chore-js-refactor-footer-scripts-modules 2025-06-09 14:40:37 -05:00
enterprise-warning-authn-b4-authz.md Version restructure (#5133) 2023-09-12 23:33:31 -06:00
expand-wrapper.html Update Grafana docs for OSS 2.0 and Cloud (#2210) 2021-02-26 18:31:19 -07:00
expand.html Enterprise 1.11 (#5177) 2023-10-18 15:11:52 -06:00
filesystem-diagram.html Influxdb 2.0.6 (#2459) 2021-04-29 14:04:33 -06:00
flex-content.html SAL operators (#5225) 2023-11-13 09:12:50 -07:00
flex.html Work with Prometheus metrics in Flux (#3232) 2021-10-18 16:25:20 -06:00
get-leaf-text.html Feature/2470 bucket schema (#2765) 2021-07-07 11:53:54 -05:00
get-shared-text.html Fix shared files (#2856) 2021-07-15 17:21:52 -05:00
hide-in.html Add 'show-in' and 'hide-in' shortcodes (#5946) 2025-04-01 15:41:32 -06:00
icon.html chore(hugo): Update shortcodes and templates to avoid calling isset on <nil> 2025-05-19 14:57:15 -05:00
img-hd.html Work with Prometheus metrics in Flux (#3232) 2021-10-18 16:25:20 -06:00
influxdb-version-detector.html Ask AI group filters (#6529) 2025-11-18 16:43:02 -06:00
influxdbu.html Add the influxdbu shortcode for diplaying InfluxDB University banners (#4083) 2022-06-03 13:26:25 -05:00
keep-url.html update influxdb urls on window focus, exempt code blocks from being updated, added info to contributing.md 2020-04-20 14:47:04 -06:00
keybind.html Merge pull request #6079 from influxdata/chore-js-refactor-footer-scripts-modules 2025-06-09 14:40:37 -05:00
latest-cli.html Add influx CLI 2.1 release notes (#2944) 2021-07-30 10:35:40 -07:00
latest-influxctl.html InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
latest-patch.html Update latest-patch shortcode for InfluxDB3 (#5998) 2025-04-17 11:15:40 -06:00
list-filters.html Merge pull request #6079 from influxdata/chore-js-refactor-footer-scripts-modules 2025-06-09 14:40:37 -05:00
nav-icon.html chore(hugo): Update shortcodes and templates to avoid calling isset on <nil> 2025-05-19 14:57:15 -05:00
note.html restructured article css files, fixed cloud-msg styles, resolves #224 2019-05-09 15:13:53 -06:00
page-nav.html InfluxDB Clustered Helm install (#5540) 2024-08-02 20:27:02 -06:00
product-key.html fix(shortcode): (Closes #5948) extra line ending in shortcode file breaks code samples 2025-04-02 16:35:04 -05:00
product-name.html update: start explorer docs (#6102) 2025-05-29 18:29:16 -05:00
release-toc.html Merge pull request #6079 from influxdata/chore-js-refactor-footer-scripts-modules 2025-06-09 14:40:37 -05:00
req.html Kapacitor 1.6.0 (#2756) 2021-06-28 14:57:05 -06:00
show-in.html Add 'show-in' and 'hide-in' shortcodes (#5946) 2025-04-01 15:41:32 -06:00
svg.html Procedural documentation for the join package (#4466) 2022-09-23 14:42:19 -06:00
tab-content.html upgraded to hugo 0.55.1 and made necessary adjustments 2019-04-16 10:05:16 -06:00
tabs-wrapper.html upgraded to hugo 0.55.1 and made necessary adjustments 2019-04-16 10:05:16 -06:00
tabs.html influxctl v2.8.0 (#5413) 2024-04-11 11:17:49 -06:00
token-link.md Apply suggestions from code review 2025-04-23 09:47:04 -06:00
tooltip.html added tooltip shortcode, updated data elements doc with tooltip shortcode 2020-07-06 14:36:19 -06:00
truncate.html InfluxDB get started (#4628) 2022-11-21 15:44:14 -07:00
warn.html restructured article css files, fixed cloud-msg styles, resolves #224 2019-05-09 15:13:53 -06:00
youtube.html fix frontmatter causing build issues, add custom youtube shortcode, add video to demo data section, resolves #1135 2020-06-23 13:54:02 -06:00