Commit Graph

9 Commits (api-docs-uplift)

Author SHA1 Message Date
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
Jason Stirnaman 42ae0fbf6b
dar issue 563 - Cloud 1 documentation, support, and migration (#6729)
* docs(v2): Specify versions for v2 Cloud and OSS

* docs(v2): Use specific version for OSS v2, add ToC

* docs(v1): Use specific versions and names. Replace Enterprise v1 with 3
Ent.

* docs(v1): More detailed description for OSS v1 release notes. Repetition
fixes.

* docs(v1): Update Download instructions. Add version specificity

* docs(v1): OSS v1 specificity, fix config commands, cleanup lists

* docs(cloud1): Shared note shortcode to guide Cloud 1 users to Enterprise
documentation, Cloud 1 support, and v3 migration

* Provide Cloud 1.x in version detector and product selector menu,
simplify InfluxDB 1.x section

- Simplify InfluxDB 1.x section on platform page to product links and
  migration guidance
- Remove detailed TICK stack and Enterprise feature descriptions
- Update all Cloud 1 links to point to /platform/#influxdb-cloud-1

- Keep Cloud 1 infrastructure intact:
  - products.yml configuration
  - Product selector entry (links to platform page section)
  - Version detector for *.influxcloud.net service URLs
  - Ask AI integration

Files changed:
- content/platform/_index.md (simplified, updated links)
- content/shared/identify-version.md (updated links)
- layouts/shortcodes/influxdb-cloud1-note.html (updated links)
- assets/js/utils/product-mappings.ts
- assets/js/influxdb-version-detector.ts

Closes /influxdata/dar/issues/563

* Delete content/influxcloud/v1/_index.md

* Update content/enterprise_influxdb/v1/_index.md

* Update content/influxdb/v1/introduction/install.md

* Fix PR Preview skipping when layout changes include wildcard URL patterns (#6725)

* Initial plan

* Fix: Strip wildcards from URL paths in PR Preview detection

- Update normalizeUrlPath() to remove asterisk wildcards
- Collapse multiple consecutive slashes after wildcard removal
- Add backtick as valid URL delimiter for code-wrapped URLs
- Add comprehensive test cases for wildcard handling
- Update backtick test to reflect safer truncation behavior

Fixes issue where PR descriptions with wildcard patterns like
`/influxdb3/enterprise/*` were not properly extracted, causing
PR Preview to skip even when URLs were provided.

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

* docs: Clarify backtick handling in URL validation

Add comment explaining that backticks act as delimiters in regex
extraction, preventing them from appearing in extracted paths even
though they're in the rejection pattern.

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

* docs: Improve comments explaining normalization and regex logic

- Clarify why wildcards are removed before slash collapsing
- Document the defense-in-depth backtick handling
- Add examples of the normalization process

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>

* Update content/platform/_index.md

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

* refactor: organize cloud1-note shortcode into influxdb directory (#6734)

Move the Cloud 1 note shortcode from influxdb-cloud1-note.html
to influxdb/cloud1-note.html to follow the existing organizational
pattern in layouts/shortcodes/influxdb/.

This change also applies the Cloud 1 content updates from PR #6729
using the new organized shortcode path: {{< influxdb/cloud1-note >}}

closes influxdata/docs-v2#6729

Co-authored-by: Claude <noreply@anthropic.com>

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Claude <noreply@anthropic.com>
2026-01-15 14:55:06 -06:00
Jason Stirnaman 74c33e9483
fix(ci): add path offset for PR preview subdirectory baseURL (#6662)
When PR preview builds use a subdirectory baseURL like
/docs-v2/pr-preview/pr-XXXX/, shortcodes that parse .RelPermalink
to detect product context fail because the path has extra segments.

This fix:
- Adds config/pr-preview/params.yml with prPreviewPathOffset: 3
- Updates workflow to use -e pr-preview environment
- Updates api-endpoint, influxdb/host, and children shortcodes to
  use the offset when indexing path segments
- Adds nil-safety with default fallback for placeholder_host

Normal builds are unaffected (offset defaults to 0).
2025-12-22 10:03:27 -06: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
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
Scott Anderson 471ee4561d
InfluxDB Clustered documentation (#5126)
* WIP base changes for clustered docs

* WIP clustered docs

* Add new influxdb/host shortcode and implement it in 3.0 docs (#5077)

* add new influxdb/host shortcode and implement it in 3.0 docs

* remove oss- cloud-only shortcodes from serverless

* Apply suggestions from code review

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

* updated urls js to PR suggestion

* Updated JavaScript, templates, and styles for Clustered URLs (#5079)

* updated js, templates, and styles for clustered urls

* Apply suggestions from code review

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

---------

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

---------

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

* restructure product dropdown template to be more extensible

* fixed more page template bugs

* fixed references to cloud in clustered

* updated docsearch templates

* added early access flagging and cta-link shortcode

* minor content updates in clustered

* updated staging config

* fixed typo in clustered description

* ported influxctl 2.0.1 to clustered

* ported get started changes to clustered

* ported 3.0 admin docs to clustered

* port null tag content to clustered

* ported influxctl note to clustered

* ported query reorg changes to clustered

* updated early access to limited availability, updated clustered landing content

* ported new content to clustered

* ported new content to clustered

* updated cta on clustered landing page

* Updated notifications and added InfluxDB Clustered announcement notification (#5125)

* updated notifications, added clustered announcement notification

* updated cta in clustered notification

* updated influxctl profile configs

* update clustered search attributes

* updated learn more link in clustered notification

* Apply suggestions from code review

* fixed typos

* fixed typos

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-09-06 06:21:47 -06:00
Scott Anderson 8adade5927
updated api-endpoint shortcodes with api-refs and new styles (#4834) 2023-03-28 12:44:52 -06:00
Scott Anderson 869a6efbaf
Add info about bucket naming restrictions, update api-endpoint shortcode (#4833)
* add info about bucket naming restrictions, updated api-endpoint shortcode

* Update content/influxdb/cloud-iox/admin/buckets/create-bucket.md

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

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-03-28 08:15:00 -06:00
Scott Anderson 986077c581
Kapacitor 1.6.0 (#2756)
* base changes and cleanup for kapa 1.6

* Kapacitor 1.6.0 jstirnaman (#2684)

* update: add kapacitor/v1/users to API doc (#2617).

* fix: spelling

* update: cleanup user API.

* Apply suggestions from code review

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

* Update content/kapacitor/v1.6/working/api.md

* Update content/kapacitor/v1.6/working/api.md

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

* Kapacitor 1.6.0 release notes (#2682)

* Fix headings in Kapacitor release notes
* Add 1.6.0 release notes


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

* Kapacitor Flux tasks (#2687)

* kapacitor flux task setup

* added crud docs for kapacitor flux tasks

* added kapacitor flux task cli commands

* Apply suggestions from code review

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Update content/kapacitor/v1.6/working/flux/_index.md

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* Kapacitor TrickleNode (#2694)

* closes #2691

* WIP TrickleNode

* add Trickle chaining methods

* remove unused back-to-top links in kapacitor docs

* Kapacitor 1.6 new configuration settings (#2693)

* kapacitor config doc cleanup

* updated heading and links

* added new kapacitor 1.6 config options, closes #2616, closes #2609

* updated slack instructions

* Kapacitor Zenoss event handler (#2695)

* added zenoss event handler to kapacitor, closes #2271

* updated descriptions and removed defaults from zenoss event handler

* updated kapacitor release notes

* Updated Kapacitor Kafka event handler partitioning options (#2697)

* updated kafka partitioning behavior, closes #2263

* fixed typos in kapacitor kafka content

* Apply suggestions from code review

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>

* added kafka link to release notes

* Kapacitor API updates (#2718)

* clean up kapacitor api headings

* add flux task api endpoints to kapacitor api doc

* Kapacitor authorization and authentication (#2717)

* ported and revamped kapacitor authentication content, closes #2690

* Apply suggestions from code review

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

* updated comment in kapacitor auth example

* Apply suggestions from code review

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

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

* updated edge.js

* Add default kapacitor.conf locations (#2782)

* added default kapacitor config locations, closes #2779

* Apply suggestions from code review

* updated data for kapacitor 1.6.0 changelog

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
2021-06-28 14:57:05 -06:00