-
Notifications
You must be signed in to change notification settings - Fork 296
Restructure influxdb3 /plugins for step-by-step clarity #5963
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
…g a processing engine plugin section
…xdata/docs-v2 into 5951-restructure-influxdb3-plugins
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (2)
content/shared/v3-core-plugins/extended-plugin-api.md:189
- [nitpick] The placeholder 'METHOD' and 'PARAMETERS' may confuse users. Consider either replacing these with concrete examples or adding a clarifying comment that indicates these are placeholders.
influxdb3_local.cache.METHOD(PARAMETERS)
content/shared/v3-core-plugins/extended-plugin-api.md:95
- [nitpick] Ensure that converting a float with no decimal component to an integer and appending '.0' meets the intended behavior and formatting requirements. Verify this behavior remains consistent with all usage scenarios.
self.fields[key] = f"{int(value)}.0" if value % 1 == 0 else str(value)
…xdata/docs-v2 into 5951-restructure-influxdb3-plugins
4784f00
to
6c565a9
Compare
…xdata/docs-v2 into 5951-restructure-influxdb3-plugins
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR restructures the /plugins documentation to provide a clearer, step-by-step guide on how to use and extend InfluxDB 3 plugins. Key changes include:
- Addition of a comprehensive, example-driven extended plugin API documentation file.
- Refinement of the menu naming in enterprise plugin documentation for consistency.
- Creation of two new extended plugin reference pages (enterprise and core) linking to the shared extended plugin API source.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
content/shared/v3-core-plugins/extended-plugin-api.md | New detailed documentation with code examples and best practices for plugin API usage. |
content/influxdb3/enterprise/plugins.md | Updated menu item naming for improved consistency. |
content/influxdb3/enterprise/extended-plugin.md | New enterprise page referencing the shared extended plugin API documentation. |
content/influxdb3/core/extended-plugin.md | New core page referencing the shared extended plugin API documentation. |
Co-authored-by: Copilot <[email protected]>
…xdata/docs-v2 into 5951-restructure-influxdb3-plugins
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
Co-authored-by: Jason Stirnaman <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR restructures the InfluxDB 3 plugins documentation to provide a more step-by-step and guided experience for users. Key changes include:
- Adding a new shared extended plugin API documentation file with detailed code samples.
- Updating the enterprise and core plugin extension files to source from the shared API document.
- Refining menu naming and presentation for clarity.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
File | Description |
---|---|
content/shared/extended-plugin-api.md | New, detailed documentation for the shared plugin API, complete with code examples and usage guidelines. |
content/influxdb3/enterprise/plugins.md | Minor update to the menu name for stylistic consistency. |
content/influxdb3/enterprise/extend-plugin.md | New documentation file extending plugins by sourcing shared API content. |
content/influxdb3/core/extend-plugin.md | New documentation file extending plugins by sourcing shared API content, with slight naming differences. |
Comments suppressed due to low confidence (2)
content/influxdb3/core/extend-plugin.md:7
- [nitpick] The menu name here differs from the enterprise version ('Extend plugins'); consider aligning the naming across both files for consistency.
name: Extended plugins
content/influxdb3/enterprise/plugins.md:8
- [nitpick] The change to 'Processing engine' appears intended for stylistic consistency; please confirm that this aligns with the overall documentation style.
name: Processing engine and Python plugins
Co-authored-by: Copilot <[email protected]>
**Objective:
To revise the /plugins section to be more structured and step-by-step than it is now. The goal is to make it easier for users to understand how plugins work, how to configure them, and how to build or extend them—especially for those who are new to InfluxDB 3 or plugin-based architectures.
What the feature does and why it’s useful
Once updated, users should be able to:
part of #5857
closes #5951