fafc37543a
* 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> |
||
|---|---|---|
| .. | ||
| influxctl | ||
| influxdb-client-libraries-reference | ||
| influxdb-v2 | ||
| influxdb3 | ||
| influxdb3-admin | ||
| influxdb3-api-reference | ||
| influxdb3-cli | ||
| influxdb3-get-started | ||
| influxdb3-internals | ||
| influxdb3-internals-reference | ||
| influxdb3-plugins | ||
| influxdb3-query-guides | ||
| influxdb3-reference | ||
| influxdb3-sample-data | ||
| influxdb3-visualize | ||
| influxdb3-write-guides | ||
| influxql-v3-reference | ||
| sql-reference | ||
| v3-core-enterprise-release-notes | ||
| v3-distributed-admin-custom-partitions | ||
| v3-distributed-internals-reference | ||
| v3-process-data/visualize | ||
| README.md | ||
| _index.md | ||
| identify-version.md | ||
| v3-line-protocol.md | ||
README.md
Shared content
This section is for content shared across multiple products and versions.
The /shared/_index.md frontmatter marks the /shared directory (/content/shared) and its
children as draft so they don't get rendered independently when the site is built.
The content of each shared document is included and rendered in pages that reference the
file as a source in their frontmatter.
Use shared content
-
Create a new folder for the content in the
/content/shared/directory. -
Copy the markdown files into the new folder.
-
Remove any frontmatter from the markdown files in the shared directory. If the first line starts with a shortcode, add an HTML comment before the first line, otherwise Hugo will err.
-
In each of the files that use the shared content, add a source to the frontmatter that points to the shared markdown file—for example:
source: /shared/influxql-v3-reference/regular-expressions.md -
In the doc body, remove the shared Markdown text and add a comment that points to the shared file, in case someone happens upon the page in the repo--for example, in
/content/influxdb3/core/reference/influxql/regular-expressions.md, add the following:
//SOURCE is a comment anchor (recognized by the Comment Anchors editor extension)
to make the file path clickable.