Skip to content

Conversation

@jstirnaman
Copy link
Contributor

Closes influxdata/dar/issues/588

…rity

Fixes issues with plugin filename resolution and improves progressive
disclosure in the processing engine Get Started guide.

- Update `--plugin` flag to `--path` (current CLI syntax)
- Clarify plugin filename must be provided without relative/absolute paths
- Add note explaining path resolution relative to `--plugin-dir`
- Document single-file vs multi-file plugin path requirements
- Link to detailed multi-file plugin structure documentation

- Add "Before you begin" section listing required setup steps
- Add prerequisites to table of contents
- Improve progressive disclosure by front-loading essentials

- Update trigger type from "Data write" to "WAL rows" (consistent with `influxdb3 create trigger --help`) with WAL link
- Replace `--plugin` with `--path` in trigger creation example
- Fix syntax error in enable trigger example (missing backslash)
- Clarify plugin example as "data write (WAL) plugin"
- Update code comments for clarity and remove outdated notes
- Specify "wal_rows trigger specification" terminology

- Specify testing "process_writes (WAL) plugin" for clarity
- Reference multiple test commands, not just wal_plugin
- Add link to schedule_plugin test command
- Clarify that PLUGIN_FILENAME should be filename only

- Prevents path resolution errors users encountered
- Aligns documentation with current CLI behavior
- Improves Get Started guide readability and flow
- Reduces confusion about plugin file handling

Closes #588
- Added inline comments to Docker Compose examples: `# Optional: only
  needed for processing engine plugins`
- Appears for both `--plugin-dir` flag and volume mount
- Helps users understand they can skip this if not using plugins
- Better progressive disclosure - users see it's optional without
  needing separate explanation
- Uses `--path` for plugins, replacing deprecated `--plugin-filename`
- Replaces "Data write" with "WAL rows" to be consistent with CLI help
  docs
@github-actions
Copy link
Contributor

github-actions bot commented Jan 9, 2026

PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-6718/
on branch gh-pages at 2026-01-09 21:40 UTC

@github-actions
Copy link
Contributor

github-actions bot commented Jan 9, 2026

PR Preview

Status Details
Preview View preview
Pages 8 page(s) deployed
Build time 66s
Last updated 2026-01-09 21:40:51 UTC
Pages included in this preview
  • /influxdb3/core/reference/internals/durability/
  • /influxdb3/enterprise/reference/internals/durability/
  • /influxdb3/enterprise/get-started/process/
  • /influxdb3/core/get-started/process/
  • /influxdb3/enterprise/get-started/setup/
  • /influxdb3/core/get-started/setup/
  • /influxdb3/enterprise/plugins/
  • /influxdb3/core/plugins/

Preview auto-deploys on push. Will be cleaned up when PR closes.

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.

2 participants