angular / angular/angular-cli

Generate documentation for default builders

Đang mở
#23,088 7 bình luận 1 reaction 0 người được giao Xem trên GitHub
area: @angular-devkit/build-angular area: docs
Ngôn ngữ chính
TypeScript
Star
27k
Fork
11.8k
Merge trung bình
14 giờ 23 phút
Pull request đã merge (30 ngày)
162

Mô tả

AIO has a page on `angular.json` workspace configuration which lists [default builders](https://angular.io/guide/workspace-config#default-architect-builders-and-targets). Unfortunately these builders link directly to the [JSON schema](https://github.com/angular/angular-cli/blob/main/packages/angular_devkit/build_angular/src/builders/browser/schema.json), which is not very intuitive.

We should process these schema files and generate a page for each builder linked from the workspace configuration. This would make it much easier to understand `@angular-devkit/build-angular` and related builders' options.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu với trang cấu hình workspace AIO và schema builder mặc định được liên kết, packages/angular_devkit/build_angular/src/builders/browser/schema.json. Theo dõi cách các tệp schema có thể được xử lý thành các trang tài liệu và được liên kết từ danh sách các builder mặc định. Hoàn thành nghĩa là mỗi builder liên quan đều có một trang được tạo dễ hiểu và cấu hình workspace liên kết đến các trang đó thay vì liên kết trực tiếp đến các schema JSON.

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

Đánh giá

Công nghệ
angular, typescript
Lĩnh vực
build-system, documentation
Loại issue
Tài liệu
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

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.