Commit Graph

3 Commits (api-docs-uplift)

Author SHA1 Message Date
Daniel Campbell fafc37543a
docs(chronograf): add instructions for use with InfluxDB3 products (#6730)
* docs(chronograf): add instructions for use with InfluxDB3 products

* docs(chronograf): add images and update text

* Claude/review pr 6730 pd m hs (#6732)

* fix(chronograf): address review feedback in PR #6730

- Reorganize InfluxDB connection options with nested structure
- Add expand-wrapper for optional management and database fields
- Format placeholders in CLI examples using docs placeholders command

Addresses @claude tasks in review comments:
- Comment 2688897045: Reorganize content sections
- Comment 2688946374: Wrap optional fields in expand-wrapper
- Comments 2688955219, 2688955604: Format placeholders

* fix(influxdb3): format placeholders in remaining chronograf CLI examples

Add placeholder syntax to CLI configuration examples across all InfluxDB 3 products:
- Cloud Serverless: API_TOKEN, BUCKET_NAME
- Clustered: DATABASE_NAME, DATABASE_TOKEN, MANAGEMENT_TOKEN
- Core: DATABASE_TOKEN
- Enterprise: DATABASE_NAME, DATABASE_TOKEN

Addresses @claude tasks in review comments:
- Comment 2688983661: cloud-serverless placeholders
- Comment 2688990379: clustered placeholders
- Comment 2688998186: core placeholders
- Enterprise file (not in review but follows same pattern)

---------

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

* Replace inline img tags with img-hd shortcode in Chronograf docs (#6731)

* Initial plan

* docs(chronograf): replace img tags with img-hd shortcode

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

* docs(influxdb3): improve Chronograf prerequisites and add placeholder descriptions

- Replace 'running and accessible' with clearer prerequisite structure
- Add structured prerequisites matching cloud variants' pattern
- Add 'Replace the following' sections with placeholder descriptions
- Use token-link shortcode for consistent token references across products
- Fix code-placeholder-key shortcode usage

* fix(influxdb3): correct database token link paths in Chronograf placeholder descriptions

---------

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>

---------

Co-authored-by: Jason Stirnaman <jstirnaman@influxdata.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
2026-01-15 13:24:09 -06:00
Jason Stirnaman 936913c3cb
refactor(influxdb3): consolidate ODBC content into Power BI documentation (#6546)
- Migrate comprehensive ODBC driver installation instructions to Power BI guide
  - Add Windows (PowerShell and Manual) installation steps with verification
  - Add macOS and Linux installation steps with configuration details
  - Include platform-specific verification procedures
- Enhance Power BI troubleshooting section with ODBC-specific guidance
  - Add driver not found troubleshooting for all platforms
  - Expand connection, authentication, and query error troubleshooting
  - Add query performance optimization recommendations
- Restructure Power BI documentation for clarity
  - Elevate ODBC driver installation to top-level section
  - Add explicit sequencing: install driver before connector
  - Improve section flow and subheading descriptiveness
- Remove standalone ODBC documentation pages
  - Delete shared ODBC guide and product-specific ODBC pages
  - Add aliases in Power BI frontmatter to redirect old ODBC URLs
- Apply changes across all InfluxDB 3 products:
  core, enterprise, cloud-dedicated, cloud-serverless, clustered
2025-11-17 22:28:46 -05:00
Jason Stirnaman 96c5fa3a72 feat(influxdb3): add ODBC and Power BI documentation with product-specific examples
- Add ODBC driver installation and configuration docs
- Add Power BI Desktop custom connector setup docs
- Configure host, port, and token conditionals for all InfluxDB 3 products
- Set frontmatter with proper metadata and related content

The shared content files (content/shared/influxdb3-query-guides/execute-queries/odbc.md
and content/shared/influxdb3-visualize/powerbi.md) contain product-specific conditionals
for server URLs, ports, and tokens. Each product version sources these shared files.

Next steps: Edit the content/shared files to update any remaining product-specific
instructions in the step-by-step procedures if needed. Server, port, and token
conditionals are already configured throughout the documentation.
2025-10-06 17:43:54 -05:00