add plugin library with documentation from influxdb3_plugins examples and official plugins #6244
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
@peterbarnett03 @sanderson Updated from latest system-metrics README in influxdata/influxdb3_plugins#16 |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive plugin library structure for InfluxDB 3 Core and Enterprise products with plugin documentation from the influxdb3_plugins repository. The PR creates a standardized plugin library format with 12 plugin documentation files, including both official InfluxData plugins and example plugins for users to learn from.
Key changes include:
- Establishes shared content directory structure for plugin documentation
- Ports 10 official InfluxData plugins and 2 example plugins from the influxdb3_plugins repository
- Creates product-specific frontmatter and navigation structure for both Core and Enterprise products
Reviewed Changes
Copilot reviewed 53 out of 55 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| content/shared/influxdb3-plugins/plugins-library/ | New shared plugin documentation structure with official and example plugins |
| content/influxdb3/core/plugins/library/ | Core product-specific plugin library pages with proper frontmatter |
| content/influxdb3/enterprise/plugins/library/ | Enterprise product-specific plugin library pages with proper frontmatter |
| content/shared/influxdb3-plugins/_index.md | Updated main plugins index to reference new plugin library structure |
| content/shared/influxdb3-plugins/extended-plugin-api.md | Updated reference to point to new plugin library location |
Comments suppressed due to low confidence (1)
content/shared/influxdb3-plugins/plugins-library/official/downsampler.md:53
- The link text shows '/README.md](' instead of the proper link format. It should be '[influxdb3_plugins/README.md](' to match the pattern used in other plugins.
/README.md](/README.md).
content/shared/influxdb3-plugins/plugins-library/official/downsampler.md
Outdated
Show resolved
Hide resolved
content/influxdb3/enterprise/plugins/library/official/system-metrics.md
Outdated
Show resolved
Hide resolved
content/influxdb3/core/plugins/library/official/system-metrics.md
Outdated
Show resolved
Hide resolved
…tation: - Add plugin library structure for Core and Enterprise products - Create shared content directory for plugin documentation - Port 12 plugin documentation files from influxdb3_plugins repository - Add GitHub repository links in related frontmatter for all plugins - Remove emoji metadata tags and clean up content structure - Implement standardized support sections with product-specific links - Reorganize plugins navigation with dedicated library section - Include 2 example plugins and 10 official InfluxData plugins
…cial plugins:- Updated with latest configuration arguments
- Add TOML configuration section to plugins-library index explaining usage - Add TOML config tables to all official plugin documentation files - Standardize TOML section format across plugins with config_file_path parameter - Update system-metrics plugin moved from examples to official - Remove redundant config_file_path from individual parameter tables - Ensure consistent placement before Installation/Requirements sections - Fix linting: replace 'e.g.' with 'for example' in system-metrics.md This completes the TOML configuration documentation updates from PR 6244
…sampler.md Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
…etrics.md Co-authored-by: Copilot <[email protected]>
jstirnaman
force-pushed
the
jts-feat-plugin-list
branch
from
3bbb775 to
cfb39c3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'll update this with Pete's system_monitoring update
Enterprise products
documentation
influxdb3_plugins repository
for all plugins
structure
product-specific links
library section
InfluxData plugins