Skip to content

Conversation

@jstirnaman
Copy link
Contributor

API reference uplift:

  • Improved integration with site, metadata, navigation
  • Improved look and feel
  • Improved performance
  • New right sidebar with in-page nav

Latest screenshot:
image

Replace legacy API documentation approach with modern Scalar-based rendering:

## Architecture Changes
- Add renderer abstraction (`layouts/partials/api/`) supporting Scalar and RapiDoc
- Create `api` layout type for API reference pages (single.html, list.html)
- Configure renderer via `site.Params.apiRenderer` (default: scalar)

## OpenAPI Processing Pipeline (TypeScript)
- `api-docs/scripts/generate-openapi-articles.ts` - Main generation script
- `api-docs/scripts/openapi-paths-to-hugo-data/` - OpenAPI to Hugo data converter
- Generates per-endpoint path fragments for AI agent access
- Creates Hugo content pages with `type: api` frontmatter

## AI Agent Accessibility
- Full specs at `/openapi/influxdb-{product}.yml` and `.json`
- Per-endpoint fragments at `/openapi/influxdb-{product}/paths/`
- `<link rel="alternate">` tags in HTML for machine discovery

## Scalar Features
- Dark/light theme support synchronized with site theme
- InfluxData brand colors
- Responsive layout
- Download link for OpenAPI spec

## Products Supported
- cloud-v2, oss-v2
- influxdb3-core, influxdb3-enterprise
- cloud-dedicated, cloud-serverless, clustered

Usage: node api-docs/scripts/dist/generate-openapi-articles.js [product]
- latest-patch.html: Replace deprecated .Store with local variable
  assignment. The .Store method was removed from shortcode context
  in newer Hugo versions.

- api-endpoint.html: Add nil check for productRef lookup to prevent
  index errors when productKey is not in productAliases dictionary.
  Falls back to "influxdb" as default product reference.
- yarn build:api-docs: Generate API docs for all products
- yarn build:api-docs cloud-v2: Generate for specific product
- yarn build:api-docs:compile: Recompile TypeScript if modified
…. Split ui-dev subagent into hugo-, ts-, and testing-specific agents.
- Add CSS for operations list cards with method badges, paths, and summaries
- Remove duplicate Overview section from list.html (was duplicating summary)
- Split "Data Operations" into separate nav groups: Write data, Query data, Cache data
- Add support for tag-based article generation with operations metadata
- Generate articles.yml data files with tag, menuName, and isConceptual fields
- Include operations array in frontmatter for tag pages
- Rewrite single.html for operation pages with RapiDoc integration
- Simplify rapidoc.html partial for tag-based rendering
- Add sidebar-nav include to sidebar.html for API navigation
- Add tab-panels.html and tabs.html for content organization
- Add api-nav.ts for sidebar navigation collapse/expand
- Add api-scalar.ts for Scalar API renderer integration
- Add api-tabs.ts for tab switching functionality
- Add api-toc.ts for table of contents generation
- Register components in main.js
- Add YAML article data files for all InfluxDB products
- Add sidebar-nav.html partial for API navigation rendering
- Rename data directory from article-data to article_data for Hugo compatibility
- Remove obsolete JSON articles file
- Update hugo.yml config for API docs settings
- Simplify _api-overrides.scss (removed hardcoded content styles)
- Import _api-layout.scss in styles-default.scss
- Update API landing pages for Core and Enterprise with redirects
- Update OpenAPI spec files
- Update dependencies
- Update tests for new tag-based API page structure
- Add tests for operations list rendering
- Add tests for sidebar navigation groups
…tion

- Header summary now shows only the first sentence from description
  using regex extraction with fallback to first line for descriptions
  without sentence-ending punctuation
- Added Overview section with full description after endpoints list
- Sidebar nav now shows operations with method badges and paths instead
  of duplicating tag names when groups are expanded
- Added background color to nav group items to match sidebar
- Increased max-height for expanded groups to accommodate all operations
- Added styles for operation items in sidebar nav (.api-nav-operation)
- Fixed summary paragraph width by setting flex-basis to 100%
- Changed operation link font-size from 0.85rem to 0.95rem to match sidebar
- Changed path code font-size from 0.75rem to 0.85rem for consistency
- Adjusted method badge font-size from 0.55rem to 0.6rem for readability
…size

- Add button reset styles to .api-nav-group-header for dark mode
  compatibility (background: none, border: none, width: 100%)
- Increase operation link font-size from 0.95rem to 1rem to match
  sidebar nav-item font size (18px base)
- Increase api-path code font-size from 0.85rem to 0.9rem
Add API nav items as children of "InfluxDB HTTP API" menu item:
- New api-menu-items.html partial generates nav from data/articles.yml
- Modified nested-menu.html to inject API nav for API parent menu item
- Updated api_nav_groups.yml to add url for Administration group
- Created Administration landing pages for Core and Enterprise
- Updated .gitignore to allow hand-crafted API conceptual pages

The Administration page uses layout: list and isConceptual: true to render
content directly without RapiDoc wrapper.
Now that API navigation is integrated into Hugo's menu system:
- Remove api-nav.ts component (no longer needed)
- Remove api/sidebar-nav.html partial (replaced by api-menu-items.html)
- Remove api-nav component registration from main.js
- Update sidebar.html to pass siteData to nested-menu for API nav
- Fix anchor ID handling for special characters (like / in operation IDs)
Remove multi-tag groups (Administration, Concepts) and flatten to
single-tag groups for direct linking. Each API tag now renders as
a direct nav item instead of being nested under a parent group.

- Update api_nav_groups.yml to use single-tag groups only
- Delete Administration landing pages (not needed without nesting)
- Improve SCSS styling for API nav visibility and active states
Add visual badges to distinguish v1-compatible and v2-compatible API
endpoints in the sidebar navigation. This helps users migrating from
InfluxDB v1 or v2 quickly identify which compatibility layer each
endpoint belongs to.

Changes:
- Add x-compatibility-version extension to compatibility operations
- Add externalDocs links to reduce verbose descriptions in specs
- Update generator to extract compatVersion and externalDocs fields
- Display colored badges (purple for v1, cyan for v2) in sidebar nav
- Strip redundant "(v1-compatible)" text when badge is shown
- Add hover tooltips explaining compatibility context
The feature is shippable, but needs a few small fixes and we'll need to update or alias all API docs links for Core and Ent3.

- Add rapidoc-mini.ts TypeScript component with CDN loading and theme sync
- Add api-operation layout for standalone operation pages
- Add rapidoc-mini.html partial for reusable RapiDoc rendering
- Add rapidoc-custom.css for RapiDoc style overrides
- Register rapidoc-mini component in main.js
- Add article data for cloud-dedicated and clustered products
- Update API reference Cypress tests
@jstirnaman jstirnaman marked this pull request as draft December 11, 2025 23:45
@jstirnaman jstirnaman added Feature-WIP Feature is still a work in progress and is not yet merged. API ui labels Dec 11, 2025
@jstirnaman jstirnaman added this to the API reference uplift milestone Dec 11, 2025
…uality

- Restore original RapiDoc match-paths format (method /path) for proper filtering
- Restrict operation tags to primary tag in tag-specific specs to prevent duplicates
- Rename Token tag to Auth token for clarity in Core and Enterprise specs
- Remove Table tag from cache operations (distinct_cache, last_cache)
- Add build script combining API docs, Hugo, and Markdown generation
- Skip summary rendering for conceptual pages
- Add isConceptual check to hide operations in nav for conceptual pages
- Update api_nav_groups.yml to use "Auth token" instead of "Token"
- Remove x-tagGroups from Core and Enterprise specs (Redoc-specific, not needed for RapiDoc)
- Add migration notes to plan document for future product migrations
…habetically

- Remove api_nav_groups.yml config file (no longer needed)
- Update api-menu-items.html to derive order from article data
- Sort: conceptual tags (traitTags) first, then other tags alphabetically
- Reduces template from 255 to 152 lines
jstirnaman and others added 30 commits December 22, 2025 13:40
Add related frontmatter links from configure_plugins pages to the
dedicated plugin directory pages for easier navigation.

closes #6415
* Document use-hashed-tokens configuration option

Added documentation for the use-hashed-tokens option, including its benefits, default value, and configuration methods.

* Update documentation for use-hashed-tokens option

Clarify default behavior for hashed API tokens in version 2.8 and future versions.

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
#6614)

* chore(claude): Add claude skill for Hugo development/testing workflow. Split ui-dev subagent into hugo-, ts-, and testing-specific agents.

* chore(claude): Update ui-testing agent and hugo-template-dev skill

* docs(plans): add docs-cli-workflow skill design

Design for a Claude Code skill that guides when to use
docs create/edit CLI tools versus direct file editing.

* feat(claude): add docs-cli-workflow skill

Guides Claude to suggest docs create/edit CLI tools when appropriate:
- Keyword-triggered activation (new page, edit URL, etc.)
- Decision matrix for create vs edit vs direct editing
- Suggestion templates with user confirmation
- Edge case handling

Addresses under-utilization of CLI scaffolding tools.

* chore(claude): add console error testing pattern to hugo-template-dev skill

Add Cypress pattern for catching JavaScript console errors during
component testing - useful for runtime errors, JSON parsing failures,
and template data binding issues.
…nds (#6584)

* docs(influxdb3): document duplicate point write ordering and workarounds

Expand duplicate points documentation for Cloud Dedicated and Clustered
to address non-deterministic write ordering when duplicate points are
flushed together.

Changes:
- Add warning callout explaining duplicate point overwrites are non-deterministic
- Add recommended patterns section with append-only approaches
- Add SQL and InfluxQL query examples for getting latest state
- Add anti-patterns section with common mistakes to avoid
- Add retention guidance for last-value tables (Cloud Dedicated only)
- Add performance considerations for append-only patterns
- Add cross-links from schema-design and optimize-writes pages

closes influxdata/DAR#560

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* Apply suggestion from @jstirnaman

* fix(influxdb3): broken links and aliases:

The link in the cloud-serverless schema-design page was pointing to /influxdb3/cloud-serverless/reference/line-protocol/#duplicate-points, but the actual file is located at /influxdb3/cloud-serverless/reference/syntax/line-protocol/
Core/Ent3 aliases were missing trailing slash, preventing navigating directly from other product line protocol docs

* chore: cleanup

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
* feat: Add v2.8.0 release notes

* feat: add token hashing doc

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* feat: Update content/influxdb/v2/reference/release-notes/influxdb.md

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

* chore(influxdbv2): Revise release notes and bump version to 2.8.0.

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
* Apply suggestions from code review
Apply to cloud-serverless

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

* fix(influxdb3): broken links and aliases:

The link in the cloud-serverless schema-design page was pointing to /influxdb3/cloud-serverless/reference/line-protocol/#duplicate-points, but the actual file is located at /influxdb3/cloud-serverless/reference/syntax/line-protocol/
Core/Ent3 aliases were missing trailing slash, preventing navigating directly from other product line protocol docs

* chore: cleanup

* fix(ci): skip fragment validation for local file URLs in link-checker

Workaround for link-checker Hugo pretty URL bug where /path/to/page#fragment
is converted to file:///path/to/page#fragment instead of
file:///path/to/page/index.html#fragment.

All 60 'broken' fragments reported by CI actually exist in the HTML files.

---------

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

* Add pprof-auth-enabled configuration option to Enterprise v1 data nodes

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>
* Initial plan

* Add v1.12.2 FUTURE LIMIT and PAST LIMIT callouts

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

* fix(v1): Remove patch from Enterprise v1 name

* fix(ent1): Remove version from `PAST LIMIT` and `FUTURE LIMIT` callout

---------

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>
* Initial plan

* feat: enhance Copilot instructions with style guidelines and navigation

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

* fix: correct .claude/agents link in INSTRUCTIONS.md

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

* refactor: remove duplication and app-specific references from instructions

- Simplified INSTRUCTIONS.md from 118 to 76 lines by removing duplicate content
- Changed "Claude Desktop app" to "Claude with MCP" throughout
- Removed file pattern table (already in copilot-instructions.md)
- Removed specialist agents table (already in copilot-instructions.md)
- Removed general documentation table (already in copilot-instructions.md)
- INSTRUCTIONS.md now serves as simple navigation guide without duplication

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

* Update README.md

---------

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>
Add the undocumented retention_period parameter to the database
creation API for InfluxDB 3 Core.

closes #6610
* Initial plan

* Change token type headings from h4 to h3 to fix fragment detection

Changed heading levels for Operator token, All Access token, and Read/Write token from level 4 to level 3. This ensures better compatibility with link checkers that may have issues detecting fragments in h4 headings.

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

* fix(v2): Clarify operator token auto- vs manual- generation

---------

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>
Add trigger configuration and cluster targeting parameters to API specs:

Core:
- TriggerSettings schema (run_async, error_behavior)
- trigger_settings field in ProcessingEngineTriggerRequest (required)
- Updated all trigger creation examples

Enterprise:
- TriggerSettings schema (run_async, error_behavior)
- ApiNodeSpec schema for cluster node targeting
- trigger_settings and node_spec fields in ProcessingEngineTriggerRequest
- node_spec field in cache creation requests (DistinctCache, LastCache)
- force parameter description for trigger deletion
- Request body schemas for plugin test/update endpoints:
  - WALPluginTestRequest
  - SchedulePluginTestRequest
  - PluginFileRequest
  - PluginDirectoryRequest
  - PluginFileEntry
- Updated all trigger creation examples

closes #6610
Add the show_deleted query parameter to the list databases endpoint
in the Enterprise API spec. This parameter allows users to include
soft-deleted databases in the response.

closes #6610
Add missing documentation for the template output data format
(serializer) that allows formatting metrics using custom Go templates.

Includes configuration examples, template method reference,
batch mode usage, and Sprig function support.

closes #5522
Fix broken download links. Revert mistakenly updated CLI version.
- latest-patch shortcode doesn't work in cloud-serverless code samples
- reverted to hardcoded CLI version in shared file and Serverless-specific file
…#6647)

* docs(influxdb3): release documentation for Core and Enterprise v3.8.0

- Update latest_patch to 3.8.0 in products.yml
- Add placeholder release notes for v3.8.0
- Update site notification for v3.8.0 release

* chore: add 3.8 release notes (#6638)

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

* feat(influxdb3): update install for DEB/RPM and add admin/security (#6643)

* feat(influxdb3): add shared/influxdb3-admin/security.md

* feat(influxdb3): update install for DEB/RPM

* chore: fix hard-coded 'enterprise' in influxdb3 install

* Update content/shared/influxdb3/install.md

Love it!

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

* Update content/shared/influxdb3/install.md

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

* Update content/shared/influxdb3/install.md

* Update content/shared/influxdb3/install.md

* Update content/shared/influxdb3/install.md

* Update content/shared/influxdb3/install.md

* Update content/shared/influxdb3/install.md

---------

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

* Update content/shared/influxdb3/install.md

* chore: add influxdb 3.8 notification (#6645)

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

---------

Co-authored-by: peterbarnett03 <peter.barnett03@gmail.com>
Co-authored-by: Jamie Strandboge <jamie@influxdata.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
…age (#6648)

Change menu key from influxdb3_core to influxdb3_enterprise.
* hotfix(influxdb3): fix duplicate menu entry for Enterprise security page

Change menu key from influxdb3_core to influxdb3_enterprise.

* chore(influxdb3) Security: style and cleanup: intro, requirements, callouts
* docs(ci): add PR preview system design

Document the design for GitHub Pages PR previews including:
- Selective deployment of changed pages only
- Reuse of existing content-utils.js change detection
- URL parsing from PR descriptions for layout/asset changes
- Automatic cleanup on PR close
- Storage budget management

* docs(ci): add PR preview implementation plan

Detailed task-by-task implementation plan including:
- 8 tasks with complete code and exact file paths
- Reuses existing content-utils.js for change detection
- Scripts for URL parsing, change detection, file staging
- Main workflow and cleanup workflow
- Setup documentation and testing steps

* feat(ci): add PR URL parser for preview page detection

* fix(ci): harden PR URL parser against malicious input

- Add path validation to reject path traversal attacks (..)
- Add validation to reject HTML/script injection attempts
- Add validation to reject URL-encoded characters
- Update regex to capture markdown link paths: [text](/path/)
- Add comprehensive test suite with 27 security and functionality tests

Security improvements:
- Reject paths containing '..' to prevent directory traversal
- Reject paths with suspicious characters: <, >, |, {, }, `, etc.
- Reject URL-encoded characters to prevent encoding attacks
- Validate all paths against known product prefixes

Functionality improvements:
- Support markdown link syntax: [text](/influxdb3/core/)
- Support reference-style markdown links
- Maintain existing support for production URLs, localhost URLs, and relative paths

* feat(ci): add change detection script for PR previews

* fix(ci): remove unused import from detect-preview-pages.js

* feat(ci): add preview file staging script for selective deployment

* fix(ci): add input validation to preview file staging script

- Add path traversal validation to urlToHtmlPath() to reject paths containing '..'
- Add array validation at start of preparePreviewFiles() with clear error message
- Fix copiedCount to only increment when safeCopy() actually succeeds
- Add return value to copyPage() to track success/failure

Addresses security vulnerabilities and improves accuracy of preview stats.

* feat(ci): add preview comment manager for sticky PR comments

* fix(ci): sanitize user input in preview comments to prevent XSS

* feat(ci): add PR preview workflow for GitHub Pages deployment

* fix(ci): correct environment variables and checkout in PR preview workflow

* feat(ci): add weekly stale preview cleanup workflow

* docs(ci): add PR preview setup guide

* Delete docs/plans/2025-12-16-pr-preview-design.md

* Delete docs/plans/2025-12-16-pr-preview-implementation.md

* fix(ci): add input validation for PR preview security

- Add single quote to rejected characters in URL path validation
  to prevent JavaScript injection in workflow string interpolation
- Add BASE_REF validation regex to prevent command injection,
  allowing slashes for feature branches (e.g., feature/new-auth)
- Add PR_NUM numeric validation in cleanup workflow
- Add tests for single quote handling and BASE_REF validation
* fix: remove a couple of mis-merges and clarify DEB/RPM is non-Docker

* chore: update install and license info for DEB/RPM

* chore: incorporate formatting and style feedback from Jason

* fix(influxdb3): Install: ToC and merge cleanup

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
…hell source is for quick install (#6652)

* fix: add a few missing DEB/RPM instructions for license activation

* fix: sourcing shell config only needed with quick installs

* chore: address review feedback from Jason
)

- Load product prefixes from data/products.yml (single source of truth)
- Build regex pattern dynamically from loaded namespaces
- Fix CSS copying: Hugo outputs fingerprinted CSS at root level
- Generate index.html with clickable links to preview pages
- Add test for influxdb3_explorer namespace

This keeps the URL parser in sync as new products are added and
provides a better preview experience with navigable links.
* refactor(ci): improve PR preview with products.yml and index page

- Load product prefixes from data/products.yml (single source of truth)
- Build regex pattern dynamically from loaded namespaces
- Fix CSS copying: Hugo outputs fingerprinted CSS at root level
- Generate index.html with clickable links to preview pages
- Add test for influxdb3_explorer namespace

This keeps the URL parser in sync as new products are added and
provides a better preview experience with navigable links.

* fix(ci): set baseURL for preview subdirectory deployment

Hugo generates absolute paths for fingerprinted assets based on baseURL.
When deploying to GitHub Pages subdirectory (pr-preview/pr-XXXX/), assets
were incorrectly resolving to the root instead of the preview path.

This sets --baseURL to the correct preview URL so all asset paths work.
* docs(telegraf): add Helm chart links and ToC updates

Add Kubernetes/Helm deployment section with links to:
- telegraf: single instance deployment
- telegraf-ds: DaemonSet deployment
- telegraf-operator: operator-based management

Also add missing ToC links for Kubernetes and configuration sections.

* chore(telegraf): revise install intro and description
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).
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).
* Initial plan

* docs: move perf-debug example output to query command reference

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

* docs: update placeholder syntax and add link to query command

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

* docs: add disclaimer for example performance statistics output

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

* fix(influxdb3): update --perf-debug example output to match documented query

Regenerate example performance statistics output using the documented
query (SELECT SUM(temp) FROM home). Tested influxctl query --perf-debug
command to verify output format and values.

---------

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

API Feature-WIP Feature is still a work in progress and is not yet merged. ui

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants