Skip to content

Conversation

@eeshaanSA
Copy link
Contributor

@eeshaanSA eeshaanSA commented Oct 13, 2025

What this PR does:

Add Structure for PipeCD v1 docs

Why we need it:

Which issue(s) this PR fixes:
#6077

Fixes #

Does this PR introduce a user-facing change?:

  • How are users affected by this change:
  • Is this breaking change:
  • How to migrate (if breaking change):

@eeshaanSA eeshaanSA requested a review from a team as a code owner October 13, 2025 05:37
@khanhtc1202 khanhtc1202 changed the title Restructure PipeCD Docs for PipeCD v1 Init PipeCD Docs for PipeCD v1 Oct 13, 2025
@eeshaanSA
Copy link
Contributor Author

Hey @khanhtc1202,

The image (diagram) on the concepts page is supposed to be the same right? No changes to that in V1 I assume?

@eeshaanSA
Copy link
Contributor Author

Also, I was thinking to evaluate and test better, lets split this PR into

  1. Concepts page
  2. Installation Page
  3. User Guide

and so on. Let me know what you think.

@eeshaanSA
Copy link
Contributor Author

Also, I just realised we will have to update the index.html page as well.

@eeshaanSA
Copy link
Contributor Author

maybe we need some images from the overview plan blog? 👀

@khanhtc1202
Copy link
Member

Hey @khanhtc1202,

The image (diagram) on the concepts page is supposed to be the same right? No changes to that in V1 I assume?

Yes, I don't think we have any changes on the overview, but if you want a better explain for piped plugins, maybe you can draw a separated diagram for piped<->plugin relationship.

@eeshaanSA
Copy link
Contributor Author

Hey @khanhtc1202,
The image (diagram) on the concepts page is supposed to be the same right? No changes to that in V1 I assume?

Yes, I don't think we have any changes on the overview, but if you want a better explain for piped plugins, maybe you can draw a separated diagram for piped<->plugin relationship.

I was thinking of using this diagram from the overview blog:

Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Signed-off-by: Eeshaan Sawant <eeshaans1@gmail.com>
Copy link
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, thanks!

@khanhtc1202 khanhtc1202 merged commit 9a6e9bf into pipe-cd:master Oct 20, 2025
43 checks passed
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.

2 participants