Skip to content

[Docs] Expand Concepts page with additional PipeCD terminology#6881

Open
ObaidAbdullah16 wants to merge 2 commits into
pipe-cd:masterfrom
ObaidAbdullah16:docs/addition-concepts
Open

[Docs] Expand Concepts page with additional PipeCD terminology#6881
ObaidAbdullah16 wants to merge 2 commits into
pipe-cd:masterfrom
ObaidAbdullah16:docs/addition-concepts

Conversation

@ObaidAbdullah16
Copy link
Copy Markdown

@ObaidAbdullah16 ObaidAbdullah16 commented May 30, 2026

What this PR does:

Adds definitions for several commonly used PipeCD concepts and features to the Concepts page, along with links to the relevant documentation.

Why we need it:

Some terms are documented across different pages but are not explained in the Concepts section. Adding them here makes it easier for users and contributors to understand PipeCD terminology in one place.

Which issue(s) this PR fixes:

Fixes #

Does this PR introduce a user-facing change?: No

  • How are users affected by this change: Users can more easily find explanations for PipeCD concepts and related features.
  • Is this breaking change: No
  • How to migrate (if breaking change): N/A

Screen Recording :

PipeCD.-.Google.Chrome.2026-06-02.12-27-39.mp4

Signed-off-by: ObaidAbdullah16 <obaidabdullah1610@gmail.com>
Copilot AI review requested due to automatic review settings May 30, 2026 10:32
@ObaidAbdullah16 ObaidAbdullah16 requested review from a team as code owners May 30, 2026 10:32
Copy link
Copy Markdown
Member

@Ayushmore1214 Ayushmore1214 left a comment

Choose a reason for hiding this comment

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

@ObaidAbdullah16 none of the links seems to be working here, can you run this locally and verify once ?

Comment on lines +92 to +93
### Event Watcher
A `piped` feature that watches for external events — such as a new container image pushed to a registry or a new Helm chart version published — and automatically updates files in the Git repository to trigger a new deployment.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@ObaidAbdullah16 just a question :why em dashes are used here ?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I used em dashes as a stylistic choice to set off the example clause, but I can see how it looks inconsistent. I've replaced them with commas to keep it simpler.


### Insights
The analytics dashboard of PipeCD that displays delivery performance metrics such as deployment frequency, lead time, mean time to restore (MTTR), and change failure rate.
See [Insights](/docs-dev/user-guide/insights/) for details.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Did you verified the links before pushing this one says file not found

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

The links were using absolute paths (/docs-dev/user-guide/...) but the existing file uses relative paths (../user-guide/...). That's what broke them locally. Fixed all of them to use relative paths for consistency and ran it locally to confirm they work now.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you share the screen recording or screenshot or them working, this is mandatory for all docs and site based PR's thanks!

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I have uploaded the screen recording in the pr description

Signed-off-by: ObaidAbdullah16 <obaidabdullah1610@gmail.com>
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