Skip to content

Conversation

@github-actions
Copy link

Plugin Documentation Sync

Source: influxdb3_plugins@main
Plugins: basic_transformation
Triggered by: Manual workflow dispatch

Changes Made

  • ✅ Validated source READMEs against template requirements
  • 🔄 Transformed content for docs-v2 compatibility
  • 🖼️ Generated plugin page screenshots

Transformations Applied

  • Removed emoji metadata (already in plugin JSON metadata)
  • Converted relative links to GitHub URLs
  • Added Hugo product shortcodes ({{% product-name %}})
  • Added standard logging section
  • Updated support sections with docs-v2 format

Screenshots

Plugin page previews are available in the plugin-screenshots/ directory (if any were generated).

Review Checklist

  • All plugin pages render correctly
  • GitHub links resolve properly
  • Product shortcodes display correctly
  • Code examples are properly formatted
  • Support sections link correctly

This PR was automatically generated by the plugin sync workflow.

Copy link
Contributor

@jstirnaman jstirnaman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good. My comment is the only blocker I see right now. Thanks!

The Basic Transformation Plugin enables real-time and scheduled transformation of time series data in InfluxDB 3.
Transform field and tag names, convert values between units, and apply custom string replacements to standardize or clean your data.
The plugin supports both scheduled batch processing of historical data and real-time transformation as data is written.
# Basic Transformation Plugin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script should have removed the # headings.
(My comment from the last iteration)

TLDR;
The final output should generally follow the same structure has the previous version of this file, i.e. we shouldn't have much of a diff.

Explanation:

My comment in the last iteration was a bit overloaded. I meant that:

  1. we don't use level 1 headings in our docs-v2 content, or rather, the frontmatter title: field becomes the H1 in the HTML. The first heading level you'll find in the Markdown content is level 2 (## => <h2>).
  2. we don't include the plugin title in the Markdown content; it's redundant with the title field.
  3. we don't need a Description heading in the content because our first 1-2 paragraphs are always the description.
  4. In this case, removing those headings is enough because the remaining headings start at level 2 and follow logically. Depending on the content source, however, in some cases we need to promote or demote the remaining headings so that they start at level 2 and follow logically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants