Move plugin-architecture Piped usage guide to official documentation

Đang mở
  • Có gì không ổn?
#6,742 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

@A-d-i-t-y đang làm issue này rồi.

Từ ngày 17/5/2026.

  • #6785 của @A-d-i-t-y — đã đóng, không merge

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
hugo
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc đọc cmd/pipedv1/README-usage-alpha.md và các trang liên quan trong docs/content/en/docs-v1.0.x/installation/install-piped/. Di chuyển các phần Prerequisites, Setup Control Plane, Run Piped và Deploy an Application vào plugin-architecture.md, cập nhật các liên kết nội bộ và thông báo alpha, sau đó chuyển README thành một con trỏ đến trang mới. Hoàn tất khi nội dung có thể được tìm thấy trong tài liệu chính thức, có định dạng Hugo nhất quán và các liên kết hoạt động.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

kind/enhancement

*What would you like to be added:

Move the plugin-architecture Piped usage guide from:

cmd/pipedv1/README-usage-alpha.md

to the official documentation under:

docs/content/en/docs-v1.0.x/installation/install-piped/plugin-architecture.md

This would include:

  • Migrating all relevant sections (Prerequisites, Setup Control Plane, Run Piped, Deploy an Application)
  • Replacing the "alpha" notice with a proper Hugo alert block
  • Updating internal links to align with documentation pages
  • Converting the existing README into a pointer to the new documentation

Why is this needed:

  • Improves discoverability, as users typically look for installation guidance in the official docs/ directory rather than inside cmd/
  • Provides a more structured and complete documentation experience
  • Reduces maintenance overhead by leveraging Hugo-based docs (versioning, search, consistent styling)
  • Improves onboarding for new users and contributors by centralizing important usage instructions
Ngôn ngữ chính
Go
Star
1.4k
Fork
391
Merge trung bình
4 ngày 1 giờ
Pull request đã merge (30 ngày)
58

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của pipe-cd/pipecd

Tất cả issue của pipe-cd/pipecd

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.