loopbackio / loopbackio/loopback-next

[Docs] Example config.json for `lb4 <command>` except `lb4 app` shows the app-config.json

Đang mở
#1,844 5 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Docs good first issue
Ngôn ngữ chính
TypeScript
Star
5.1k
Fork
1.1k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
27

Mô tả

## Description / Steps to reproduce / Feature proposal
In the CLI generator docs e.g. https://loopback.io/doc/en/lb4/Model-generator.html, the example `--config` option shows the `lb4 app` example. This is true for Application, Datasource, Repository, etc. generators (7 generators in total).

## Expected Behavior
We should show the appropriate config json file that the commands are expecting. Find a dynamic way to update https://github.com/strongloop/loopback-next/blob/master/docs/site/includes/CLI-std-options.md for each command.

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

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

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.

Hướng nghiên cứu

Bắt đầu với docs/site/includes/CLI-std-options.md và so sánh ví dụ --config trong đó với tài liệu về trình tạo CLI, bao gồm bảy trình tạo được nêu trong issue. Xác định cách JSON cấu hình mà mỗi lệnh mong đợi được biểu diễn, sau đó cập nhật tài liệu để mọi lệnh đều hiển thị ví dụ phù hợp và kiểm tra các trang của những trình tạo bị ảnh hưởng.

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

Đánh giá

Lĩnh vực
cli, documentation
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 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.