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

Aperta
#3,314 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 8 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
54/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
979
Fork
434
Merge medio
10g 8h
PR unite (30g)
28

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di firebase/extensions

Tutte le issue di firebase/extensions

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.