pipecd icon indicating copy to clipboard operation
pipecd copied to clipboard

Docs-V1(UserGuide): Add root content in v1/User-Guide

Open eeshaanSA opened this issue 1 month ago • 3 comments

What this PR does:

Add root files in UserGuide. Please check v0.55x userguide to check and review what has changed.

Why we need it:

Which issue(s) this PR fixes:

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 avatar Nov 14 '25 11:11 eeshaanSA

Codecov Report

:white_check_mark: All modified and coverable lines are covered by tests. :white_check_mark: Project coverage is 17.50%. Comparing base (c32694e) to head (927100b).

:exclamation: There is a different number of reports uploaded between BASE (c32694e) and HEAD (927100b). Click for more details.

HEAD has 10 uploads less than BASE
Flag BASE (c32694e) HEAD (927100b)
.-pkg-app-pipedv1-plugin-waitapproval 1 0
.-pkg-plugin-sdk 1 0
.-tool-actions-plan-preview 1 0
.-pkg-app-pipedv1-plugin-scriptrun 1 0
.-pkg-app-pipedv1-plugin-analysis 1 0
.-pkg-app-pipedv1-plugin-wait 1 0
.-pkg-app-pipedv1-plugin-terraform 1 0
.-pkg-app-pipedv1-plugin-kubernetes 1 0
. 1 0
.-pkg-app-pipedv1-plugin-kubernetes_multicluster 1 0
Additional details and impacted files
@@             Coverage Diff             @@
##           master    #6343       +/-   ##
===========================================
- Coverage   28.82%   17.50%   -11.33%     
===========================================
  Files         560        7      -553     
  Lines       59937      920    -59017     
===========================================
- Hits        17277      161    -17116     
+ Misses      41339      738    -40601     
+ Partials     1321       21     -1300     
Flag Coverage Δ
. ?
.-pkg-app-pipedv1-plugin-analysis ?
.-pkg-app-pipedv1-plugin-kubernetes ?
.-pkg-app-pipedv1-plugin-kubernetes_multicluster ?
.-pkg-app-pipedv1-plugin-scriptrun ?
.-pkg-app-pipedv1-plugin-terraform ?
.-pkg-app-pipedv1-plugin-wait ?
.-pkg-app-pipedv1-plugin-waitapproval ?
.-pkg-plugin-sdk ?
.-tool-actions-gh-release 19.23% <ø> (ø)
.-tool-actions-plan-preview ?
.-tool-codegen-protoc-gen-auth 0.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Nov 14 '25 18:11 codecov[bot]

@khanhtc1202 I think at this point let us not focus on broken links. We will fix all of them once we have more clarity on v1 docs.

eeshaanSA avatar Dec 02 '25 17:12 eeshaanSA

There is convention for directory name, the directory name should be snake case, instead of normal string (eg. managing-application) cc @eeshaanSA

khanhtc1202 avatar Dec 08 '25 08:12 khanhtc1202

@khanhtc1202, please review. 🙌

eeshaanSA avatar Dec 15 '25 10:12 eeshaanSA