Skip to content

docs: move plugin configuration guides to plugins section#6698

Open
DCchoudhury15 wants to merge 3 commits into
pipe-cd:masterfrom
DCchoudhury15:docs/move-plugins-v1
Open

docs: move plugin configuration guides to plugins section#6698
DCchoudhury15 wants to merge 3 commits into
pipe-cd:masterfrom
DCchoudhury15:docs/move-plugins-v1

Conversation

@DCchoudhury15

Copy link
Copy Markdown

What this PR does:
Moves plugin-specific configuration guides out of the User Guide and into the new Plugins section. Specifically:

  • Extracts the Kubernetes and Terraform plugin configuration sections from user-guide/managing-piped/configuring-a-plugin.md into dedicated pages under plugins/
  • Moves user-guide/managing-piped/adding-an-analysis-provider.md to plugins/analysis.md
  • Updates plugins/_index.md to link to the three new pages instead of showing a WIP placeholder
  • Adds a redirect note in configuring-a-plugin.md pointing users to the new Plugins section

Why we need it:
The plugin documentation was scattered across the User Guide. Having dedicated pages under the Plugins section makes it easier for users to find plugin-specific configuration guides in one place.

Which issue(s) this PR fixes:
Fixes #6540

Does this PR introduce a user-facing change?:

  • How are users affected by this change: Plugin configuration guides are now located at /docs-v1.0.x/plugins/ instead of inside the User Guide. A note in configuring-a-plugin.md directs users to the new location.
  • Is this breaking change: No
  • How to migrate (if breaking change): N/A

Signed-off-by: DCchoudhury15 <divyanshuchoudhury3@gmail.com>

@eeshaanSA eeshaanSA left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, @DCchoudhury15, thanks for this. Your work looks good.

Since @rahulshendre is also working on some sections from the 'Plugins' category, Rahul, do you mind reviewing one final time if everything looks alright?

---

To enable [Automated deployment analysis](../../managing-application/customizing-deployment/automated-deployment-analysis/) feature, you have to set the needed information for Piped to connect to the [Analysis Provider](../../../concepts/#analysis-provider).
To enable [Automated deployment analysis](../user-guide/managing-application/customizing-deployment/automated-deployment-analysis/) feature, you have to set the needed information for Piped to connect to the [Analysis Provider](../concepts/#analysis-provider).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the first link is broken
the second, we don't have an anchor for that in concepts
I'd suggest, remove those links (plain text is fine), and keep only working refs

Signed-off-by: DCchoudhury15 <divyanshuchoudhury3@gmail.com>
@DCchoudhury15 DCchoudhury15 force-pushed the docs/move-plugins-v1 branch from a5ca9ec to b7aec3c Compare May 3, 2026 09:07
@DCchoudhury15

DCchoudhury15 commented May 9, 2026

Copy link
Copy Markdown
Author

@rahulshendre done the suggested changes ; up for review whenever you are ready

@github-actions

github-actions Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@github-actions github-actions Bot added the Stale label Jun 9, 2026
@DCchoudhury15

Copy link
Copy Markdown
Author

@rahulshendre , @eeshaanSA The pr is ready for review .

@rahulshendre rahulshendre left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, Thanks @DCchoudhury15

@eeshaanSA eeshaanSA left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, @rahulshendre I hope you checked thoroughly.

@github-actions github-actions Bot removed the Stale label Jun 10, 2026
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.

Docs: Move certain sections from the User Guide to the new Plugins section

3 participants