Commit Graph

535 Commits (api-docs-uplift)

Author SHA1 Message Date
Jason Stirnaman b7c21a35b8 fix(api-docs): remove stale tags-landing pages that crash Hugo rebuild
These v2/cloud tags pages use an old layout that causes Hugo to panic
during live rebuilds when generated API content is present.
2026-03-16 18:11:56 -05:00
Jason Stirnaman f5535c9d5c feat(api): Hugo-native API reference rendering
Hugo-native templates for API
reference documentation. Operations render as server-side HTML instead
of client-side Redoc, providing faster page loads, full SEO
indexability, and consistent styling.

Architecture:
- Tag-based navigation: operations grouped by OpenAPI tag, accessed
  via tag pages only (no individual operation URLs)
- Generation script auto-discovers products from .config.yml files,
  deriving Hugo paths and menu keys from directory structure
- Per-tag JSON/YAML chunks for fast Hugo template rendering
- Inline curl examples generated from OpenAPI specs at build time

Templates (layouts/api/, layouts/partials/api/):
- tag-renderer.html: renders all operations for a tag
- operation.html: individual operation with parameters, request body,
  responses, and schema rendering
- code-sample.html: curl examples with Ask AI integration
- section-children.html: tag listing on section index pages
- all-endpoints-list.html: all operations sorted by path

Generation (api-docs/scripts/generate-openapi-articles.ts):
- Auto-discovery from .config.yml replaces hardcoded productConfigs
- Each API section generates independently (no cross-spec merging)
- Frontmatter-driven template data (specDownloadPath, articleDataKey)
- Link transformation: /influxdb/version/ placeholders resolved to
  product-specific paths

Removed:
- Redoc renderer, JavaScript components, and CSS
- Shadow DOM test infrastructure (~160 lines)
- Operation page generation (dead generatePathPages function)
- mergeArticleData() and slugifyDisplayName()

Styles (assets/styles/layouts/_api-*.scss):
- 3-column layout: sidebar, content, sticky TOC
- Theme-aware code blocks for curl examples
- Method badges (GET/POST/PUT/DELETE) with color coding
- Collapsible schema sections with depth tracking

Tests (cypress/e2e/content/api-reference.cy.js):
- Tag page rendering with operation structure
- Download button verification per section
- All-endpoints page with operation cards
- Related links from x-related OpenAPI extension
- Code sample and Ask AI link validation
2026-03-15 22:17:33 -05:00
Jason Stirnaman c9708a18fa
chore(spell-check): improve Vale spell checking for code comments (#6876)
* chore(spell-check): improve Vale spell checking for code comments

- Enable spell checking in code blocks by removing ~code exclusion from InfluxDataDocs Spelling rule
- Add comprehensive filters to avoid false positives from:
  - camelCase and snake_case identifiers
  - hexadecimal values and version numbers
  - URL paths and URLs
  - shortcode attributes
  - code punctuation and symbols
- Fix spelling errors in code comments:
  - "includimng" → "including" in 3 files
  - "continously" → "continuously" in 5 files

This allows Vale to catch typos and spelling mistakes in code comments and documentation strings while avoiding false positives on actual code syntax and identifiers.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* chore(spell-check): add codespell configuration

- Add .codespellrc with 'clear' builtin dictionary to catch unambiguous spelling errors
- Add .codespellignore for technical terms and product names
- Configuration prevents false positives while enabling comprehensive spell checking for code comments

This enables codespell for automated spell checking via CI/CD, complementing the Vale configuration.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* fix(reference): correct 6 spelling errors across reference pages

Fixes identified through codespell analysis of reference documentation:

- influxdb/v2/config-options: useable → usable
- influxdb3/clustered/release-notes: provid → provide, certficate → certificate, memeory → memory, Geting → Getting
- kapacitor/v1/release-notes: auotmatically → automatically

Note: "invokable" is excluded as a branding term; "fpr" in GPG code is a legitimate field name.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* docs(spell-check): improve validation rules and documentation

Core improvements to spell-checking rules:

CODESPELL CONFIGURATION (.codespellrc):
- Use only 'clear' dictionary (removes 'rare', 'code' for fewer false positives)
- Add 'api-docs' to skip list (avoids false positives in generated specs)
- Add 'invokable' to ignore list (product branding term)
- Remove unclear 'tage' term
- Add documentation explaining each setting

VALE CONFIGURATION (Spelling.yml):
- Expand scope documentation explaining why code blocks are included
- Add comprehensive comments for each filter pattern
- Include examples for each regex pattern
- Document limitations and edge cases
- Organize filters by category (branding, URLs, code, literals)

NEW DOCUMENTATION (SPELL-CHECK.md):
- Tool comparison and use cases
- Detailed explanation of each filter pattern
- Troubleshooting guide
- Running instructions for both tools
- Contribution guidelines
- References and related files

These changes ensure:
 Minimal false positives (8.5-9/10)
 Strong true positive detection (8.5-9.5/10)
 Clear, maintainable rules
 Easy to extend and modify
 Well-documented for team use

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* refactor(spell-check): consolidate ignore words to single source

Consolidate duplicate ignored words configuration:

BEFORE:
- .codespellignore: AKS, aks, invokable, tagE
- .codespellrc: inline ignore-words-list = aks,invokable
- Problem: Maintenance duplication and confusion

AFTER:
- .codespellignore: authoritative list (aks, AKS, invokable with docs)
- .codespellrc: references .codespellignore via 'ignore-words' config
- Benefit: Single source of truth, cleaner configuration

Also removed:
- 'tagE' from ignore list (unclear, possibly a typo)
- Inline word list from .codespellrc (now external)

This follows codespell best practices and reduces maintenance burden.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* docs(spell-check): correct version number regex documentation

Fix incorrect limitation note in SPELL-CHECK.md:

The regex pattern \d+\.\d+(?:\.\d+)* actually DOES match
4-part versions like 1.2.3.4 (and any number of parts).

The (?:\.\d+)* part is a repeating group that matches
zero or more additional dot-separated version components.

Updated documentation to clarify that the pattern handles
any number of version parts, not just 2-3 part versions.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* Update SPELL-CHECK.md

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

* fix(spell-check): tighten camelCase regex to prevent false negatives

The original camelCase regex pattern was too permissive and would match
any word starting with lowercase (e.g., 'provide', 'database', 'variable'),
causing Vale to skip spell-checking normal prose words.

Improved pattern now requires:
- camelCase: at least one uppercase letter (myVariable ✓, provide ✗)
- snake_case: at least one underscore (my_variable ✓, variable ✗)

This prevents common prose words from being silently excluded from
spell-checking while still properly handling code identifiers.

Combined pattern: (?:_*[a-z]+(?:[A-Z][a-z0-9]*)+(?:[A-Z][a-zA-Z0-9]*)*|[a-z_][a-z0-9]*_[a-z0-9_]*)

Updated files:
- SPELL-CHECK.md: Added detailed explanation and test cases
- .ci/vale/styles/InfluxDataDocs/Spelling.yml: Updated filter pattern

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

* fix(spell-check): expand URL scheme pattern to match documentation comment

The comment said the URL filter ignores 'http, https, ftp, etc.' but the
regex only matched http and https. Expanded the pattern to match:

- http/https (as before)
- ftp/ftps (file transfer protocols)
- ssh (secure shell)
- file (local file URLs)

Updated pattern: (?:https?|ftp|ftps|ssh|file)://[^\s\)\]>"]+

This ensures the filter matches the documented behavior.

https://claude.ai/code/session_01TYWR7wb5MUkzjVsK4mtNjA

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-28 14:24:23 -06:00
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
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
Jason Stirnaman b4a0eea0a3
feat: add InfluxDB documentation MCP server integration (#6830)
* chore(deps): update yarn dependencies

Run yarn to update lockfile with latest compatible versions.

* feat: add InfluxDB documentation MCP server integration

- Enable MCP widget in Ask AI (data-mcp-enabled, data-mcp-server-url)
- Restructure mcp-server.md with anchor TOC for database and docs MCP
- Add documentation MCP server page for products without database MCP:
  - cloud-serverless, clustered, v2, cloud (TSM), telegraf
  - Place in Reference section (or telegraf_v1_ref menu)
- Add shared content file for docs-only MCP server
- Add "Connect to documentation MCP" link in format-selector dropdown
- Add related MCP links to all get-started/setup pages

* fix: correct JSON syntax and product-aware MCP docs URL

- Fix JSON syntax errors in Cloud Dedicated config examples (= → :)
- Add missing comma in Docker args array for local server config
- Make format-selector MCP docs URL product-aware using Hugo path detection

* docs: add MCP pages for v1 products, fix menu, add screenshot

- Fix cloud-serverless identify-version menu parent to "Administer InfluxDB Cloud"
- Add MCP server pages for influxdb/v1 and enterprise_influxdb/v1 in Tools menu
- Update format-selector with v1 and enterprise_influxdb/v1 MCP docs paths
- Add MCP tool search screenshot showing search_influxdb_knowledge_sources

* Update content/influxdb3/cloud-serverless/get-started/setup.md

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

* Update content/telegraf/v1/mcp-server.md

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

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-02-17 20:42:56 -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 4caaa42887
fix(v2): broken links to Grafana guides for Cloud and OSS v2. (#6692)
- Add expected aliases (more descriptive URLs) for the Grafana pages
2026-01-03 13:50:38 -06: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
Jason Stirnaman 87a5662833 fix(grafana): update Grafana documentation across all InfluxDB versions 2025-10-06 18:54:04 -05:00
Jason Stirnaman 1b3a284432 docs(grafana): add version detector and complete alt_links
- Add InfluxDB version detector shortcode to all Grafana pages
- Add comprehensive alt_links to v2 and Cloud Grafana pages
- Include links to all InfluxDB versions (v1, enterprise_v1, v2, cloud, and all v3 products)
- Improve cross-product navigation for Grafana documentation
2025-10-06 15:19:57 -05:00
Jason Stirnaman f587fbaf48 fix: links containing hostname 2025-08-24 21:32:26 -05:00
Jason Stirnaman a21c06bb4f fix(v2): OSS replication:- Fix (simplify) list formatting; remove nested lists.- Convert numbered list to numbered headers to replace nested lists- Add additional headers to show alternatives- Specify Enterprise v1- Update callouts 2025-08-18 15:16:38 -05:00
Jason Stirnaman 48380fd168 fix(influxdb3): Auth schemes in 3core, 3ent, cloud-dedicated, and clustered:Explains compatibility for different schemasProvides more auth examplesFills missing schemes in API refFixes placeholdersShows that username is optional 2025-07-07 23:10:37 -05:00
Jason Stirnaman 36cfabae9c fix: broken links
- Flux links in Kapacitor and others: flux/v0.x/ -> flux/v0/
- influxdb/v2%2E0/ -> influxdb/v2/
2025-06-04 17:05:46 -05:00
Jason Stirnaman 3bf419fb1d fix: links missing leading slash 2025-05-29 09:06:42 -05:00
Jason Stirnaman 8d0d4acf55 fix(oss2): Troubleshoot partial writes for v2 and Cloud
- OSS v2 supports partial writes and returns a 422 that describes rejected points, depending on the problem.
- Update API spec
- Move file to content/shared for Cloud
2025-05-22 16:30:41 -05:00
Jason Stirnaman 88fc48888c hotfix(v2): broken downloaded link, replace latest-cli shortcode with latest-patch 2025-04-30 10:48:15 -05:00
Jason Stirnaman 38f53620dd chore(vsflux): Remove Flux VSCode pages, add notice that vsflux is removed from Marketplace extensions, and vsflux and flux-lsp are archived
Closes #5990. Fix broken links.
2025-04-17 13:58:33 -05:00
Scott Anderson 1522e734b9
Update shared content usage in v2 docs and more (#5953)
* replaced all oss- and cloud-only shortcodes

* removed duplicate oss calls and replaced with shared source

* base changes for shared v2 content

* restored shared grafana content

* removed frontmatter from shared v2 content

* WIP fixing lists with show-in shortcode

* fix lists that use show-in shortcode

* updated all v2 files to remove duplicate-oss and use source sharing

* update prepend and append frontmatter to just use string input

* fixed broken menu keys
2025-04-02 15:54:32 -06:00
Jason Stirnaman 3d4f78f5c4 fix(cloudv2): Doesn't support environment references in templates 2025-03-14 18:11:16 -05:00
Jason Stirnaman 4403dd9a18 fix: LInks and headings. Replace `latest` with `v2`. Specify OSS v2 in headings. Closes fix(api-refs): specify v2 in InfluxDB OSS headings #5866, Closes Flux docs: replace `/influxdb/latest` with `/influxdb/v2` #5864. Linting cleanup, removing terminal prompt from examples 2025-02-27 17:50:16 -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
Daniel Lo 0e5a967ea4
Update bucket-schema.md
ndjson.org goes to some sort of sports betting site.

https://jsonlines.org/ is probably a better site.
2025-01-09 22:53:59 -08:00
meelahme 7e094dbfe9 Update to sign-up.md naming fix 2025-01-03 10:15:40 -08:00
meelahme b8509b7961 Removed Sign up section and replaced it with new InfluxDB cloud note 2025-01-02 14:55:29 -08:00
meelahme 1cdda86d33 Revert "Removed Sign Up section and repleaced it a note"
This reverts commit 8f7685e356.
2025-01-02 14:47:03 -08:00
meelahme 8f7685e356 Removed Sign Up section and repleaced it a note 2025-01-02 14:41:14 -08:00
meelahme cf2090102d Update content/influxdb/cloud/sign-up.md 2025-01-02 14:01:33 -08:00
meelahme bd26c2493d Revised sign up section 2025-01-02 13:46:15 -08:00
meelahme c46052c49e update to format and simplified deployment section (closes #5720) 2024-12-31 16:44:22 -08:00
meelahme c75e29df64 Added notes on v2 OSS (5720) 2024-12-31 15:14:22 -08:00
meelahme 0f5038f30d Noted new sign ups for version 3.0 (5720) 2024-12-31 15:03:48 -08:00
meelahme 564527eace removed start for free section 2024-12-31 14:45:16 -08:00
Scott Anderson 5122847981
consolidate v3 InfluxQL docs into shared docs (#5715) 2024-12-16 16:59:39 -07:00
Scott Anderson ddc921c4fc
Add support for GitHub style alerts (#5667)
* implement github style markdown alerts

* hide example doc

* swapped note and tip color schemes

* fixed broken v2 icons

* marked example as draft

* Apply suggestions from code review

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

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
2024-11-07 14:54:01 -07:00
Jason Stirnaman 7462c7e3e8 fix(v1,v2): bad aliases causing 404s
- Cleanup use of alias singular
- Fix lint error
Closes #5632
2024-10-03 16:18:34 -05:00
Jason Stirnaman ed0586cd13 fix(v2): API nav items:
- Fixes sidebar navigation for API pages, moving the v1-compatibility Hugo page into Develop with the API.
- Makes titles consistent for API reference docs.
- Disables linkify autolinking of URLs and email addresses to prevent autolinking example email addresses (I audited content to make sure we don't rely on the autolinking behavior; we use explicit HTML/MD syntax for links)
- Uses standard placeholders and adds test setup for v1-compat write and query.
- Clean up Markdown
- Adds home-sensor-data.lp to Downloads (thought it was already there)
2024-09-18 10:18:17 -05:00
Jason Stirnaman 115aa059f5
Revert "chore(cloud): Warning for possible problems with Usage data." 2024-08-29 13:14:59 -05:00
Jason Stirnaman 64295117e9 chore(cloud): Add warning to main billing pages as well, add notice that billing records aren't affected. 2024-08-26 18:08:19 -05:00
Jason Stirnaman 4961aac9ff chore(cloud): Warning for possible problems with Usage data. 2024-08-26 17:58:33 -05:00
Jason Stirnaman 4408a43de3 fix: failing tests, skip tests for unsupported code samples, typos and updates 2024-07-23 15:41:16 -05:00
Steve 64b202332b
Adding alternative downsampling examples - Using Quix (#5451)
* Downsampling InfluxDB2 data with Quix

* Minor updates

* Adjust weight

* WIP - Added downsample with Quix

* Update menu

* Update menu for v2 downsampling with Flux and Quix

* v2 downsampling page ordering

* Add Quix downsample example to clustered

* Add Quix downsample example to cloud

* Update content/influxdb/cloud-dedicated/process-data/downsample/downsample-quix.md

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

* Update content/influxdb/cloud/process-data/common-tasks/downsample/downsample-data-quix.md

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

* Update content/influxdb/cloud/process-data/common-tasks/downsample/downsample-data.md

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

* Update content/influxdb/cloud/process-data/common-tasks/downsample/downsample-data.md

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

* Update content/influxdb/cloud/process-data/common-tasks/downsample/downsample-data-quix.md

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

* Update content/influxdb/cloud/process-data/common-tasks/downsample/downsample-data-quix.md

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

* Update content/influxdb/clustered/process-data/downsample/_index.md

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>

* Updates based on review comments

* Update Cloud downsampling with Quix page title

* Task/influx quix updates (#3)

Adding alternative downsampling examples - Using Quix.

This PR includes changes to:

Dedicated
Cloud(TSM)
OSS
Clustered
Quix is collaborating with Influxdata to act as a pure Python alternative to Kapacitor+Flux.

The audience is folks who:

Know Python already and/or don't want to learn a DSL, and possibly those who want to process data more "Pythonically" rather than mixing SQL syntax and Python.
FYI: Quix is both a runtime platform (Quix Cloud) and data processor (Quix Streams Python library). The aim of the articles is to show how downsampling can be done in a continuous real-time process using pure Python.

[x] Signed the InfluxData CLA
(if necessary)
[x] Rebased/mergeableAdding alternative downsampling examples - Using Quix.

* Update content/influxdb/cloud-serverless/process-data/downsample/quix.md

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

* Update content/influxdb/cloud-dedicated/process-data/downsample/downsample.md

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

* Update content/influxdb/cloud-serverless/process-data/downsample/quix.md

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

* Update layouts/shortcodes/html-diagram/influxdb-v3-quix-downsample-pipeline.html

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

* Update layouts/shortcodes/html-diagram/influxdb-v3-quix-downsample-pipeline.html

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

* Update layouts/shortcodes/html-diagram/influxdb-v3-quix-downsample-pipeline.html

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

* Review updates (#4)

Updates from review. thanks.

* Update content/influxdb/cloud-dedicated/process-data/downsample/downsample-quix.md

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

* Update content/influxdb/v2/tools/downsample-data-quix.md

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

* Update content/influxdb/v2/tools/downsample-data-quix.md

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

* Update content/influxdb/v2/tools/downsample-data-quix.md

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

* Update content/influxdb/v2/tools/downsample-data-quix.md

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

* Update content/influxdb/v2/tools/downsample-data-quix.md

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

* Update content/influxdb/v2/tools/downsample-data-quix.md

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

* Update content/influxdb/clustered/process-data/downsample/quix.md

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

* Update content/influxdb/clustered/process-data/downsample/quix.md

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

* Update content/influxdb/clustered/process-data/downsample/client-libraries.md

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

* Update content/influxdb/cloud-serverless/process-data/downsample/quix.md

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

* Update content/influxdb/cloud/process-data/common-tasks/downsample-data-quix.md

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

* Update content/influxdb/cloud/process-data/common-tasks/downsample-data-quix.md

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>

* Updates from review (#5)

Updates from review

---------

Co-authored-by: steverosam <steve@quix.ai>
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-05-16 13:12:15 -06:00
Scott Anderson da1b1105ea
Update v3 token management docs and add management tokens (#5373)
* new token management structure, updated links

* task-based management token docs

* added related links to influxctl management docs

* remove draft status from management token admin docs

* standardize references to identity provider

* Apply suggestions from code review

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

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2024-03-21 13:42:41 -06:00
Jason Stirnaman 85dcebba43
v2: move setup process instructions to get-started/setup page (#5355)
* chore(v2 cloud): Capitalization

* chore(v2 cloud): Capitalization

* chore(v2 cloud): Punctuation

* chore(v2): Move set up process to get-started/setup page:

- Moves setup process section from the install page to the get-started/setup page.
- Clean up and style updates.
- Add API set up example.

* chore(v2): Cleanup

* Update content/influxdb/v2/get-started/setup.md

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

* Update content/influxdb/v2/get-started/setup.md

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

* Update content/influxdb/v2/get-started/setup.md

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

* Update content/influxdb/v2/get-started/setup.md

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

* Update content/influxdb/v2/get-started/setup.md

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

* Update content/influxdb/v2/get-started/setup.md

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

* Update content/influxdb/v2/get-started/setup.md

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

* Update content/influxdb/v2/install/_index.md

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

* fix: update influxdb/host shortcode

* chore(oss-v2): Consistent use of All Access as token name

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
Co-authored-by: Scott Anderson <scott@influxdata.com>
2024-03-12 09:32:25 -05:00
Jason Stirnaman 4663a4f0f5
chore(v2): Add Docker Hub `influx-configs` file path, fix spelling. (#5353)
Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-03-11 15:06:15 -05:00
Andreas Deininger 476a73e95e
Fixing typos (#5315)
* Fix typos

* Bump hugo to latest version v0.122.0

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2024-02-05 09:51:51 -07:00
Scott Anderson cbd2a0b72a
Update mentions of IOx to v3 (#5256)
* update mentions of IOx to v3

* Apply suggestions from code review

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

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-11-30 11:52:40 -07:00
Andreas Deininger c9488e3465
Fixing typos (#5242)
* Fixing typos

* Update content/enterprise_influxdb/v1/flux/guides/rate.md

---------

Co-authored-by: Scott Anderson <sanderson@users.noreply.github.com>
2023-11-27 09:32:55 -07:00
Scott Anderson 92db741681
Flux migration troubleshooting and IOx naming cleanup (#5249)
* adds error to migration troubleshoot, some IOx cleanup, closes influxdata/DAR#387

* Apply suggestions from code review

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

* Apply suggestions from code review

---------

Co-authored-by: Jason Stirnaman <stirnamanj@gmail.com>
2023-11-22 12:30:24 -07:00