Skip to content

docs(v1): add comprehensive configuration references for app and piped#6584

Open
shivansh-gohem wants to merge 2 commits intopipe-cd:masterfrom
shivansh-gohem:clean-docs-v1
Open

docs(v1): add comprehensive configuration references for app and piped#6584
shivansh-gohem wants to merge 2 commits intopipe-cd:masterfrom
shivansh-gohem:clean-docs-v1

Conversation

@shivansh-gohem
Copy link
Copy Markdown
Contributor

@shivansh-gohem shivansh-gohem commented Mar 13, 2026

What this PR does / Why we need it:

This PR provides the structured and updated v1 configuration references requested in the EPIC. It replaces the "work in progress" placeholders in the docs-v1.0.x directory with comprehensive, markdown-formatted tables mapped directly from the v1 Go structs (pkg/configv1/application.go and pkg/configv1/piped.go).

Key Documentation Updates:

  1. Application Configuration (app.config):

    • Documented the shift to the unified Application kind.
    • Added the requirement for the pipecd.dev/platform label.
    • Mapped all core v1 deployment specs (planner, pipeline, trigger, etc.).
  2. Piped Configuration (piped.config):

    • Documented the new plugin-based architecture.
    • Replaced legacy platformProviders with the new plugins and nested deployTargets specifications.
    • Added structured tables for internal configs like Git, SecretManagement, and Notifications.

Which issue(s) this PR fixes:

Fixes #6542

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
Copy link
Copy Markdown
Contributor

@rahulshendre rahulshendre left a comment

Choose a reason for hiding this comment

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

@shivansh-gohem, this is a good high‑level overview, but it only covers the top‑level fields plus DriftDetection.
Given the EPIC asks for “comprehensive configuration references”, I think we should either add
(a) document planner, pipeline, trigger, postSync, etc. here as well
or
(b) explicitly say that deeper details for these live in another doc (and link to it)

…er review

Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
@shivansh-gohem
Copy link
Copy Markdown
Contributor Author

shivansh-gohem commented Mar 25, 2026

Thanks for the review, @rahulshendre! That’s a very fair point. Since the Epic asks for comprehensive references, I completely agree with going with Option A. I have updated the PR to include the detailed markdown tables for Planner, Pipeline, Trigger, PostSync, NotificationRoute, and NotificationReceiver directly in the docs so everything is in one place!!!

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.

[EPIC]Need structured and updated configuration references for App config file and piped config file

2 participants