docs(storage-resize-images): restructure the kit README to match the firestore-bigquery-export kit README

Đang mở
#3,314 0 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 8 ngày

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

Đá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
54/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Start with kits/storage-resize-images/README.md and compare its sections with kits/firestore-bigquery-export/README.md at commit 3ded546a. Wait for PRs #3285, #3287, #3289, #3306 and #3307 to merge, then reorganize their content into the specified section order and add the missing guidance where applicable. Done when the README follows that structure, includes the Region subsection in Differences, and reflects the merged PR content.

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

Mô tả

documentation kits

storage-resize-images kit README. Priority: low. Do this last, after the other sub-issues of #3263 have landed.

What

Restructure kits/storage-resize-images/README.md so it is similar in structure and length to kits/firestore-bigquery-export/README.md. At kits @ 3ded546a, the FBE README is 418 lines and 2,450 words; this one is 330 lines and 2,278 words.

Follow the FBE section order: Install, Required IAM, Usage, Deploy, Configuration, Multiple instances, Events, Provisioning, Failure handling, Migrating from the extension, Differences from the extension (including a Region subsection), API surface, Reporting bugs, License.

Sections this README is missing:

  • Failure handling: what happens when a run fails, and how to find out.
  • Migrating from the extension: firebase ext:migrate and firebase ext:export --mode functions.
  • Provisioning: only if it applies to this kit.

The Differences section has seven subsections, with Region in the middle. Fold BUCKET_REGION decides where the function runs into the Region subsection.

When

Wait until the PRs that edit this README have merged: #3285, #3287, #3289, #3306 and #3307. Then fold their content into the new structure rather than rewriting it.

Ngôn ngữ chính
TypeScript
Star
979
Fork
434
Merge trung bình
10 ngày 8 giờ
Pull request đã merge (30 ngày)
28

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 firebase/extensions

Tất cả issue của firebase/extensions

Issue tương tự

Thêm issue về TypeScript

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.