Skip to content

port_to_docs.js: auto-add --cluster-id for Enterprise in synced plugin install examples #7721

Description

@jstirnaman

What changed / what's needed

helper-scripts/influxdb3-plugins/port_to_docs.js transforms plugin READMEs from influxdb3_plugins into docs-v2 content, but doesn't account for Enterprise-only flags. The upstream influxdb3 serve install examples never include --cluster-id (correctly — that repo is edition-agnostic), so every synced page inherits that gap for InfluxDB 3 Enterprise.

Add a transform step, following the same pattern as the existing schemaPlugins insertion (port_to_docs.js lines ~260-298), that detects an influxdb3 serve \ block containing --node-id ... \ with no --cluster-id, and injects:

```
{{< show-in "enterprise" >}}--cluster-id CLUSTER_ID
{{< /show-in >}}--node-id NODE_ID
```

matching the pattern already used in content/shared/influxdb3-admin/object-storage/{s3,gcs,minio,azure}.md.

Why

Found via docs-v2 #6878: plugins-library/examples/wal-plugin.md was missing --cluster-id in its Enterprise install example. Fixed by hand in #7720, but that page — and 13 others with the same influxdb3 serve install block (basic-transformation.md, downsampler.md, notifier.md, system-metrics.md, and more) — is regenerated by .github/workflows/sync-plugins.ymlport_to_docs.js on every plugin sync. A manual fix gets silently overwritten on the next sync.

Impact

Without this, every future plugin sync reintroduces the missing-flag gap on all affected pages, and someone has to notice and re-patch by hand each time.

Verification

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    product:v3-monolithInfluxDB 3 Core and Enterprise (single-node / clusterable)

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions