Skip to content

Commit 2b8e769

Browse files
jstirnamanjstirnaman
committed
feat(influxdb3): add plugin library with comprehensive plugin documentation:
- 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
1 parent b0de478 commit 2b8e769

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+3815
-18
lines changed

‎content/influxdb3/core/plugins.md renamed to ‎content/influxdb3/core/plugins/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ influxdb3/core/tags: [processing engine, python]
1111
related:
1212
- /influxdb3/core/reference/cli/influxdb3/test/wal_plugin/
1313
- /influxdb3/core/reference/cli/influxdb3/create/trigger/
14-
source: /shared/v3-core-plugins/_index.md
14+
source: /shared/influxdb3-plugins/_index.md
1515
---
1616

1717
<!--
18-
//SOURCE - content/shared/v3-core-plugins/_index.md
18+
//SOURCE - content/shared/influxdb3-plugins/_index.md
1919
-->

‎content/influxdb3/core/extend-plugin.md renamed to ‎content/influxdb3/core/plugins/extend-plugin.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,14 @@ menu:
88
parent: Processing engine and Python plugins
99
weight: 4
1010
influxdb3/core/tags: [processing engine, plugins, API, python]
11-
source: /shared/extended-plugin-api.md
11+
aliases:
12+
- /influxdb3/core/extend-plugin/
13+
related:
14+
- /influxdb3/core/reference/cli/influxdb3/create/trigger/
15+
- /influxdb3/core/reference/cli/influxdb3/test/
16+
- /influxdb3/core/reference/processing-engine/
17+
source: /shared/influxdb3-plugins/extended-plugin-api.md
1218
---
1319

14-
<!--
15-
// SOURCE content/shared/extended-plugin-api.md
16-
-->
20+
<!-- //SOURCE content/shared/influxdb3-plugins/extended-plugin-api.md -->
1721

‎content/influxdb3/core/plugins/library/_index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Plugin library
3+
description: Browse available plugins for {{% product-name %}} to extend your database functionality with custom Python code.
4+
menu:
5+
influxdb3_core:
6+
name: Plugin library
7+
parent: Processing engine and Python plugins
8+
weight: 5
9+
influxdb3/core/tags: [plugins, processing engine, python]
10+
source: /shared/influxdb3-plugins/plugins-library/_index.md
11+
---
12+
13+
<!-- //SOURCE - content/shared/influxdb3-plugins/plugins-library/_index.md -->

‎content/influxdb3/core/plugins/library/examples/_index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Example plugins
3+
description: Start with example plugins that demonstrate common use cases.
4+
menu:
5+
influxdb3_core:
6+
name: Example plugins
7+
parent: Plugin library
8+
weight: 1
9+
influxdb3/core/tags: [plugins, processing engine, python, examples]
10+
source: /shared/influxdb3-plugins/plugins-library/examples/_index.md
11+
---
12+
13+
<!-- //SOURCE - content/shared/influxdb3-plugins/plugins-library/examples/_index.md -->

‎content/influxdb3/core/plugins/library/examples/system-metrics.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: System metrics plugin
3+
description: Collects comprehensive system performance metrics including CPU, memory, disk, and network statistics.
4+
menu:
5+
influxdb3_core:
6+
name: System metrics
7+
parent: Example plugins
8+
weight: 1
9+
influxdb3/core/tags: [plugins, processing engine, python, monitoring, system-metrics, performance]
10+
related:
11+
- https://github.com/influxdata/influxdb3_plugins/tree/main/examples/system-metrics, System metrics plugin on GitHub
12+
source: /shared/influxdb3-plugins/plugins-library/examples/system-metrics.md
13+
---
14+
15+
<!-- //SOURCE - content/shared/influxdb3-plugins/plugins-library/examples/system-metrics.md -->

‎content/influxdb3/core/plugins/library/examples/wal-plugin.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: WAL plugin
3+
description: Example Write-Ahead Log (WAL) plugin that demonstrates processing data as it's written to the database.
4+
menu:
5+
influxdb3_core:
6+
name: WAL plugin
7+
parent: Example plugins
8+
weight: 2
9+
influxdb3/core/tags: [plugins, processing engine, python, wal, data-write]
10+
related:
11+
- https://github.com/influxdata/influxdb3_plugins/tree/main/examples/wal-plugin, WAL plugin on GitHub
12+
source: /shared/influxdb3-plugins/plugins-library/examples/wal-plugin.md
13+
---
14+
15+
<!-- //SOURCE - content/shared/influxdb3-plugins/plugins-library/examples/wal-plugin.md -->

‎content/influxdb3/core/plugins/library/official/_index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Official plugins
3+
description: Production-ready plugins developed and maintained by InfluxData.
4+
menu:
5+
influxdb3_core:
6+
name: Official plugins
7+
parent: Plugin library
8+
weight: 2
9+
influxdb3/core/tags: [plugins, processing engine, python, official]
10+
source: /shared/influxdb3-plugins/plugins-library/official/_index.md
11+
---
12+
13+
<!-- //SOURCE - content/shared/influxdb3-plugins/plugins-library/official/_index.md -->

‎content/influxdb3/core/plugins/library/official/basic-transformation.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Basic transformation plugin
3+
description: Provides common data transformation functions for modifying and enriching time series data.
4+
menu:
5+
influxdb3_core:
6+
name: Basic transformation
7+
parent: Official plugins
8+
weight: 1
9+
influxdb3/core/tags: [plugins, processing engine, python, transformation, data-processing]
10+
related:
11+
- https://github.com/influxdata/influxdb3_plugins/tree/main/influxdata/basic_transformation, Basic transformation plugin on GitHub
12+
source: /shared/influxdb3-plugins/plugins-library/official/basic-transformation.md
13+
---
14+
15+
<!-- //SOURCE - content/shared/influxdb3-plugins/plugins-library/official/basic-transformation.md -->

‎content/influxdb3/core/plugins/library/official/downsampler.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Downsampler plugin
3+
description: Automatically downsample and aggregate time series data at configurable intervals.
4+
menu:
5+
influxdb3_core:
6+
name: Downsampler
7+
parent: Official plugins
8+
weight: 2
9+
influxdb3/core/tags: [plugins, processing engine, python, downsampling, aggregation, performance]
10+
related:
11+
- https://github.com/influxdata/influxdb3_plugins/tree/main/influxdata/downsampler, Downsampler plugin on GitHub
12+
source: /shared/influxdb3-plugins/plugins-library/official/downsampler.md
13+
---
14+
15+
<!-- //SOURCE - content/shared/influxdb3-plugins/plugins-library/official/downsampler.md -->

‎content/influxdb3/core/plugins/library/official/forecast-error-evaluator.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Forecast error evaluator plugin
3+
description: Evaluate forecast accuracy by comparing predicted values against actual measurements.
4+
menu:
5+
influxdb3_core:
6+
name: Forecast error evaluator
7+
parent: Official plugins
8+
weight: 3
9+
influxdb3/core/tags: [plugins, processing engine, python, forecasting, evaluation, analytics]
10+
related:
11+
- https://github.com/influxdata/influxdb3_plugins/tree/main/influxdata/forecast_error_evaluator, Forecast error evaluator plugin on GitHub
12+
source: /shared/influxdb3-plugins/plugins-library/official/forecast-error-evaluator.md
13+
---
14+
15+
<!-- //SOURCE - content/shared/influxdb3-plugins/plugins-library/official/forecast-error-evaluator.md -->

0 commit comments

Comments
 (0)