docs(v1): add comprehensive application configuration reference#6584
docs(v1): add comprehensive application configuration reference#6584shivansh-gohem wants to merge 4 commits intopipe-cd:masterfrom
Conversation
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
rahulshendre
left a comment
There was a problem hiding this comment.
@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)
docs/content/en/docs-v1.0.x/user-guide/managing-piped/configuration-reference.md
Outdated
Show resolved
Hide resolved
…er review Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
|
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!!! |
|
@eeshaanSA @khanhtc1202 could you ptal!!! |
khanhtc1202
left a comment
There was a problem hiding this comment.
Lgtm with a small nit. Thank you!
docs/content/en/docs-v1.0.x/user-guide/managing-piped/configuration-reference.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Shivansh Sahu <sahushivansh142@gmail.com>
|
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! |
eeshaanSA
left a comment
There was a problem hiding this comment.
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>
|
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!!! |
eeshaanSA
left a comment
There was a problem hiding this comment.
@khanhtc1202, @Warashi we need some additional checks on this, since this the most important page in the document.
|
@shivansh-gohem, please focus on Application configuration for now. We can deal with the piped config later. |
What this PR does / Why we need it:
This PR provides the structured and updated v1 configuration reference for the
Applicationconfiguration (app.config).Note: This PR originally included the
piped.configupdates as well, but was split into two separate PRs per maintainer request to make reviewing safer and easier. Thepiped.configupdates can now be found in #6644.Key Documentation Updates:
Applicationkind.pipecd.dev/platformlabel.planner,pipeline,trigger,postSync, anddriftDetection.Which issue(s) this PR fixes:
Fixes #6542