Skip to content

docs(v1): add comprehensive application configuration reference#6584

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

docs(v1): add comprehensive application configuration reference#6584
shivansh-gohem wants to merge 4 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 reference for the Application configuration (app.config).

Note: This PR originally included the piped.config updates as well, but was split into two separate PRs per maintainer request to make reviewing safer and easier. The piped.config updates can now be found in #6644.

Key Documentation Updates:

  • Documented the shift to the unified Application kind.
  • Added the requirement for the pipecd.dev/platform label.
  • Mapped all core v1 deployment specs including planner, pipeline, trigger, postSync, and driftDetection.

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!!!

@shivansh-gohem
Copy link
Copy Markdown
Contributor Author

@eeshaanSA @khanhtc1202 could you ptal!!!

Copy link
Copy Markdown
Member

@khanhtc1202 khanhtc1202 left a comment

Choose a reason for hiding this comment

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

Lgtm with a small nit. Thank you!

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

Thanks for the review, @khanhtc1202! Good catch on those two types. I've added the NotificationReceiverSlack and NotificationReceiverWebhook tables back into the document so the section is complete. Pushed the update!

Copy link
Copy Markdown
Contributor

@eeshaanSA eeshaanSA left a comment

Choose a reason for hiding this comment

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

I strongly feel, for a configuration reference, it is better to divide the app config reference and the piped config reference into 2 different PRs. These the the most important parts of the documentation, and doing them accurately is really important.

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

shivansh-gohem commented Apr 4, 2026

Thanks for the feedback, @eeshaanSA! That makes complete sense. Since these are the two core configuration files, splitting them will definitely make reviewing and tracking changes much safer. I have updated this PR to exclusively cover the Application configuration, and I have opened a second, separate PR right now for the Piped configuration with my changes!!!
thank you!

@shivansh-gohem shivansh-gohem changed the title docs(v1): add comprehensive configuration references for app and piped docs(v1): add comprehensive application configuration reference Apr 4, 2026
Copy link
Copy Markdown
Contributor

@eeshaanSA eeshaanSA left a comment

Choose a reason for hiding this comment

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

@khanhtc1202, @Warashi we need some additional checks on this, since this the most important page in the document.

@eeshaanSA
Copy link
Copy Markdown
Contributor

@shivansh-gohem, please focus on Application configuration for now. We can deal with the piped config later.

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

4 participants