Skip to content

Commit 03a1e37

Browse files
committed
docs: add CLAUDE.md files for generated content directories
Add guidance for AI tools about generated documentation: - content/shared/influxdb3-plugins/plugins-library/official/CLAUDE.md - content/telegraf/CLAUDE.md These files document the sync workflows and prevent AI tools from editing generated content directly.
1 parent b8418d9 commit 03a1e37

File tree

2 files changed

+75
-0
lines changed

2 files changed

+75
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Generated Content - Do Not Edit Directly
2+
3+
The plugin documentation files in this directory are **generated from source READMEs** in the [influxdata/influxdb3_plugins](https://github.com/influxdata/influxdb3_plugins) repository.
4+
5+
## Workflow
6+
7+
1. **Source of truth**: `influxdb3_plugins/influxdata/<plugin>/README.md`
8+
2. **Sync script**: `yarn sync-plugins` transforms and ports content to this directory
9+
3. **Transformations**: The sync applies shortcodes, formatting, and docs-specific sections
10+
11+
## To Make Changes
12+
13+
1. Edit the source README in `influxdb3_plugins/influxdata/<plugin>/README.md`
14+
2. Run `yarn sync-plugins` from the docs-v2 root to port changes
15+
3. Commit changes in both repositories
16+
17+
## Documentation
18+
19+
See [helper-scripts/influxdb3-plugins/README.md](/helper-scripts/influxdb3-plugins/README.md) for the complete sync workflow documentation.
20+
21+
## Files in This Directory
22+
23+
| File | Source |
24+
|------|--------|
25+
| `basic-transformation.md` | `influxdb3_plugins/influxdata/basic_transformation/README.md` |
26+
| `downsampler.md` | `influxdb3_plugins/influxdata/downsampler/README.md` |
27+
| `forecast-error-evaluator.md` | `influxdb3_plugins/influxdata/forecast_error_evaluator/README.md` |
28+
| `influxdb-to-iceberg.md` | `influxdb3_plugins/influxdata/influxdb_to_iceberg/README.md` |
29+
| `mad-check.md` | `influxdb3_plugins/influxdata/mad_check/README.md` |
30+
| `notifier.md` | `influxdb3_plugins/influxdata/notifier/README.md` |
31+
| `prophet-forecasting.md` | `influxdb3_plugins/influxdata/prophet_forecasting/README.md` |
32+
| `state-change.md` | `influxdb3_plugins/influxdata/state_change/README.md` |
33+
| `stateless-adtk-detector.md` | `influxdb3_plugins/influxdata/stateless_adtk_detector/README.md` |
34+
| `system-metrics.md` | `influxdb3_plugins/influxdata/system_metrics/README.md` |
35+
| `threshold-deadman-checks.md` | `influxdb3_plugins/influxdata/threshold_deadman_checks/README.md` |

content/telegraf/CLAUDE.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Telegraf Plugin Documentation - Edit in Source Repository
2+
3+
The Telegraf plugin documentation in subdirectories (`input-plugins/`, `output-plugins/`, `aggregator-plugins/`, `processor-plugins/`) is **generated from plugin READMEs** in the [influxdata/telegraf](https://github.com/influxdata/telegraf) repository.
4+
5+
## Workflow
6+
7+
1. **Source of truth**: Plugin READMEs in `telegraf/plugins/<type>/<plugin>/README.md`
8+
2. **Automated sync**: The `telegraf-internal` repository generates documentation PRs from plugin READMEs
9+
3. **Release process**: Telegraf releases automatically trigger documentation updates
10+
11+
## To Make Changes
12+
13+
1. Edit the source README in the `telegraf` repository: `plugins/<type>/<plugin>/README.md`
14+
2. Submit a PR to `influxdata/telegraf`
15+
3. After merge, the sync process will create a PR to docs-v2
16+
17+
## Plugin Types and Locations
18+
19+
| Directory | Source Location |
20+
|-----------|-----------------|
21+
| `input-plugins/` | `telegraf/plugins/inputs/<plugin>/README.md` |
22+
| `output-plugins/` | `telegraf/plugins/outputs/<plugin>/README.md` |
23+
| `aggregator-plugins/` | `telegraf/plugins/aggregators/<plugin>/README.md` |
24+
| `processor-plugins/` | `telegraf/plugins/processors/<plugin>/README.md` |
25+
26+
## Documentation
27+
28+
- **Telegraf repository**: https://github.com/influxdata/telegraf
29+
- **Contributing guide**: https://github.com/influxdata/telegraf/blob/master/CONTRIBUTING.md
30+
31+
## Non-Generated Content
32+
33+
The following files in `content/telegraf/` are **not generated** and can be edited directly:
34+
- `_index.md`
35+
- `configuration.md`
36+
- `install.md`
37+
- `get-started.md`
38+
- `metrics.md`
39+
- `release-notes.md`
40+
- Other top-level documentation files

0 commit comments

Comments
 (0)