docs(storage-resize-images): restructure the kit README to match the firestore-bigquery-export kit README
Maintainers usually reply within 8 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 54/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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:migrateandfirebase 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.
- Dominant language
- TypeScript
- Stars
- 979
- Forks
- 434
- Avg merge
- 10d 8h
- Merged PRs (30d)
- 28
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from firebase/extensions
-
kits parity type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
firebase/extensions#3303 ·
Maintainers usually reply within 8 days
-
kits parity type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
firebase/extensions#3301 ·
Maintainers usually reply within 8 days
-
kits parity type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
firebase/extensions#3296 ·
Maintainers usually reply within 8 days
-
kits parity type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
firebase/extensions#3294 ·
Maintainers usually reply within 8 days
-
kits parity type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
firebase/extensions#3291 ·
Maintainers usually reply within 8 days
All issues in firebase/extensions
Similar issues
-
bot:ai-assisted component:platform-js status:untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
midnightntwrk/platform-js#69 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Picolab/pico-engine#668 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Maintainers usually reply within 1 day
-
ai-driven-qa bug claude Cosmetic
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
needs verification
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Maintainers usually reply within 13 days