docs-v2/layouts/shortcodes
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
..
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 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
datetime Document v3 custom partitions (#5309) 2024-03-04 09:15:10 -07:00
flux refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
html-diagram refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
influxdb refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
influxdb3 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
influxql refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
resources Bump hugo to latest version v0.121.2 (#5293) 2024-01-17 09:15:00 -07:00
sql refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
telegraf refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
ui Create ui/timestamp-formats shortcode (#2259) 2021-03-19 16:36:51 -06:00
admin-ui-access.html docs: admin ui uses macro for intro 2025-11-20 11:13:10 -05:00
api-endpoint.html refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06: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 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06: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 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
current-version.html refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -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 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
icon.html refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
img-hd.html Work with Prometheus metrics in Flux (#3232) 2021-10-18 16:25:20 -06:00
influxdb-cloud1-note.html dar issue 563 - Cloud 1 documentation, support, and migration (#6729) 2026-01-15 14:55:06 -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 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
latest-influxctl.html InfluxDB 3 Core & InfluxDB 3 Enterprise alpha release (#5760) 2025-01-13 07:21:11 -07:00
latest-patch.html refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -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 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06: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 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
product-name.html refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
release-toc.html refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -06:00
req.html Kapacitor 1.6.0 (#2756) 2021-06-28 14:57:05 -06:00
show-in.html refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -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 refactor: replace URL-parsing in shortcodes with cascade product data (#6883) 2026-02-27 09:46:57 -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