docs(v1): add comprehensive configuration references for app and piped#6584
docs(v1): add comprehensive configuration references for app and piped#6584shivansh-gohem wants to merge 2 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!!! |
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.xdirectory with comprehensive, markdown-formatted tables mapped directly from the v1 Go structs (pkg/configv1/application.goandpkg/configv1/piped.go).Key Documentation Updates:
Application Configuration (
app.config):Applicationkind.pipecd.dev/platformlabel.Piped Configuration (
piped.config):platformProviderswith the newpluginsand nesteddeployTargetsspecifications.Which issue(s) this PR fixes:
Fixes #6542