Commit Graph

62 Commits (api-docs-uplift)

Author SHA1 Message Date
ritwika314 5fe6e6287e
docs: add autoscaling configuration guide for InfluxDB Cloud Dedicated (#6881)
* docs: add autoscaling configuration guide for InfluxDB Cloud Dedicated

* fix: correct frontmatter delimiter and trailing whitespace in autoscaling.md (#6882)

* Initial plan

* fix: add missing frontmatter delimiter and remove trailing whitespace

Co-authored-by: ritwika314 <3454653+ritwika314@users.noreply.github.com>

---------

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

* docs: refine autoscaling documentation for clarity and detail

* docs: refine autoscaling documentation for clarity and detail

* docs: enhance clarity and detail in autoscaling documentation

* [WIP] Add autoscaling configuration guide for InfluxDB Cloud Dedicated (#6886)

* Initial plan

* fix: remove trailing whitespace and re-enable Vale.Terms rule in autoscaling.md

Co-authored-by: ritwika314 <3454653+ritwika314@users.noreply.github.com>

---------

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

* Apply Jason's suggestions

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

* Apply suggestion from @jstirnaman

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

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: ritwika314 <3454653+ritwika314@users.noreply.github.com>
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2026-02-27 21:31:29 -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
Mohammad Naqvi 9023261c73 chore: address comments 2026-01-15 14:25:27 -05:00
Mohammad Naqvi d3a64820fe docs: update tables docs 2026-01-15 14:25:27 -05:00
Mohammad Naqvi b1ca174b13 chore: address comments 2026-01-06 16:10:25 -05:00
Mohammad Naqvi b4debb4fef chore: consolidate points 2026-01-06 12:28:25 -05:00
Mohammad Naqvi 30c0aecbd3 chore: update docs to reflect DB undelete addition 2026-01-06 09:50:26 -05:00
Bill O'Connell 67b05a4baf
fix: dedicated docs adjustments (#6562)
* docs: fix dedicated admin ui doc adjustments

* merge identity version under one heading

* docs: fix links in one location shortcode does not work

* chore: remove extra space from editor in admin ui access layout shortcode
2025-11-21 12:47:58 -06:00
Bill O'Connell d14cc75096
Merge branch 'master' into chore/update_admin_ui_images 2025-11-20 13:59:55 -05:00
Bill OConnell 4e71b963d6 docs: admin ui uses macro for intro 2025-11-20 11:13:10 -05:00
Bill O'Connell 0726900784
Update content/influxdb3/cloud-dedicated/admin/tokens/database/list.md
Co-authored-by: ritwika314 <mim.ghosh@gmail.com>
2025-11-19 17:02:15 -05:00
Bill O'Connell fdc1ad2b74
Update content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md
Co-authored-by: ritwika314 <mim.ghosh@gmail.com>
2025-11-19 17:01:41 -05:00
Bill O'Connell 9dba2c8560
Update content/influxdb3/cloud-dedicated/admin/tokens/management/list.md
Co-authored-by: ritwika314 <mim.ghosh@gmail.com>
2025-11-19 17:01:32 -05:00
Bill O'Connell 09cd1f2fc7
Update content/influxdb3/cloud-dedicated/admin/tables/list.md
Co-authored-by: ritwika314 <mim.ghosh@gmail.com>
2025-11-19 17:01:23 -05:00
Bill O'Connell c7fc09b2e6
Update content/influxdb3/cloud-dedicated/admin/clusters/get.md
Co-authored-by: ritwika314 <mim.ghosh@gmail.com>
2025-11-19 17:01:15 -05:00
Bill O'Connell 480ee39829
Update content/influxdb3/cloud-dedicated/admin/account/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-11-19 17:00:34 -05:00
Bill O'Connell 36e8563884
Update content/influxdb3/cloud-dedicated/admin/account/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-11-19 17:00:23 -05:00
Bill O'Connell 2ff1b2484d
Update content/influxdb3/cloud-dedicated/admin/account/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-11-19 17:00:11 -05:00
Bill O'Connell bb434e7ba6
Update content/influxdb3/cloud-dedicated/admin/account/_index.md
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-11-19 16:59:58 -05:00
Bill OConnell 365a1c1c23 docs: replace admin ui reference docs with inline docs 2025-11-19 16:13:36 -05:00
Scott Anderson fb4dcdef93
chore: update dedicated hard delete grace period (#6554) 2025-11-19 12:58:39 -07:00
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
Beth Legesse 84b196b9ca fix: update View account information to use new design and info 2025-11-10 16:15:08 -06:00
meelahme 142b82785b updating broken link in _index.md 2025-10-20 09:48:31 -07:00
Jameelah Mercer d72ab4bf38
Merge branch 'master' into feature/cloud-dedicated-user-management-docs 2025-10-15 10:34:25 -07:00
Scott Anderson c20b770814 hotfix: explain token permissions for db rename in distributed 2025-09-30 10:17:59 -06:00
Joel Abshier 083abc318b
Release influxctl v2.10.4 (#6411)
* Release influxctl v2.10.4

* feat(influxctl): influxctl 2.10.4 release notes, cli docs, and admin guides (#6412)

* feat(influxctl): release notes, cli docs, and admin guides for influxctl 2.10.4

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore(influxctl): hide clustered table undelete pages

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-09-23 09:48:57 -06:00
Jameelah Mercer 72bea7e810
Fix formatting of role permissions note 2025-09-12 13:21:43 -07:00
Jameelah Mercer c498579c5a
Adding an extra period at the end for a test
Clarified permissions for Auditor and Member roles in user management.
2025-09-12 12:47:36 -07:00
Jameelah Mercer 48f1e40b5a
Update content/influxdb3/cloud-dedicated/admin/users/admin-ui.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-09-05 14:12:38 -07:00
Jameelah Mercer 01bd7b29b7
Update content/influxdb3/cloud-dedicated/admin/users/admin-ui.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-09-05 14:12:32 -07:00
Jameelah Mercer 8e2e2eca2c
Update content/influxdb3/cloud-dedicated/admin/users/_index.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-09-05 14:12:25 -07:00
Jameelah Mercer df51d8c942
Update content/influxdb3/cloud-dedicated/admin/users/_index.md
Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-09-05 14:12:18 -07:00
meelahme 29eb2ce062 fix: update to TOC 2025-09-03 17:09:37 -07:00
meelahme 0c62fd2aed fix: correct influxctl CLI reference URL in user management docs 2025-09-03 16:35:40 -07:00
Jameelah Mercer 526a098dee
Update content/influxdb3/cloud-dedicated/admin/users/admin-ui.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-29 12:52:20 -07:00
Jameelah Mercer dde285411b
Update content/influxdb3/cloud-dedicated/admin/users/_index.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2025-08-29 12:52:09 -07:00
Jameelah Mercer 635af32117
Merge branch 'master' into feature/cloud-dedicated-user-management-docs 2025-08-29 12:51:04 -07:00
meelahme fad1866782 docs: updates to admin-ui.md content 2025-08-29 12:48:35 -07:00
meelahme 7e4e2e9b53 revising user management section in index.md 2025-08-29 12:30:23 -07:00
meelahme 8b36a3ca67 revising index.md and updating content 2025-08-29 10:31:45 -07:00
Jason Stirnaman f587fbaf48 fix: links containing hostname 2025-08-24 21:32:26 -05:00
meelahme 8993037547 adding content 2025-08-22 12:52:39 -07:00
meelahme db8f70a26b adding intro and TOC 2025-08-22 12:50:55 -07:00
meelahme 14eee40632 changing file name 2025-08-22 12:45:53 -07:00
Joel Abshier 5bb4f14f39
Release influxctl v2.10.3 (#6270)
* Release influxctl v2.10.3

* add influxctl 2.10.3 release notes and feature docs

---------

Co-authored-by: Scott Anderson <scott@influxdata.com>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2025-08-01 23:43:54 -05:00
Jason Stirnaman beeb428470 feat(v3): Add naming restrictions reference and guidelines:
- Fixes influxdata/DAR#515: discourages the use of a leading underscore in database and table names in all InfluxDB 3 versions, but doesn't disallow it
- Add detailed naming restrictions reference for all InfluxDB 3 versions
- Add basic guidelines in table and database creation guides.
- Core and Ent table guides are forthcoming in a separate PR
2025-07-10 16:10:27 -05:00
Scott Anderson ec6e28d0e2
Add MCP server documentation to Core, Enterprise, and Cloud Dedicated (#6200)
* add mcp server documentation for core, enterprise, and cloud-dedicated

* Apply suggestions from code review

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

* updated mcp server npm/docker package names, updated environment variables

* updated the mcp server instructions to be correct

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2025-07-09 15:23:48 -05:00
Scott Anderson 1e4f69bf6a task-based table and db management docs for dedicated and clustered 2025-06-30 16:13:30 -06:00
Jason Stirnaman 2169935012 fix(influxdb3): replace {{< product-name in headers with {{% to avoid the hahahugo anchor link bug.
- Still need to track down the root cause
2025-05-29 00:47:33 -05:00