Skip to content

docs: fix outdated piped config example in docs-dev contributing guide#6758

Open
netram75 wants to merge 1 commit into
pipe-cd:masterfrom
netram75:docs/fix-contributing-guide-v1-plugin-syntax
Open

docs: fix outdated piped config example in docs-dev contributing guide#6758
netram75 wants to merge 1 commit into
pipe-cd:masterfrom
netram75:docs/fix-contributing-guide-v1-plugin-syntax

Conversation

@netram75
Copy link
Copy Markdown

What this PR does:
Updates the docs-dev contributing guide with two changes:

  • Replaces the outdated platformProviders piped config example with the correct PipeCD v1 plugins syntax
  • Adds "Contribute plugins" to the Ways to Contribute section

Why we need it:
The docs-dev contributing guide still used platformProviders — a v0 concept replaced by plugins in PipeCD v1. Any contributor following this guide to run piped locally would use the wrong config format.

Which issue(s) this PR fixes:

Refs #6679

Does this PR introduce a user-facing change?:

  • How are users affected by this change: Contributors following the docs-dev guide now see the correct v1 plugin syntax for running piped locally
  • Is this breaking change: No
  • How to migrate (if breaking change): N/A

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant