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

未关闭
#3,314 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 8 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
54/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
TypeScript
星标
979
派生
434
平均合并
10 天 8 小时
30 天内合并 PR
28

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

firebase/extensions 的其他 Issue

查看 firebase/extensions 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。