docs(firestore-send-email): restructure the kit README to match the firestore-bigquery-export kit README

Aperta
#3,315 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à
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Read kits/firestore-send-email/README.md alongside kits/firestore-bigquery-export/README.md at the referenced commit to compare their structure. Wait for #3309 to merge and #3300 to be done, then reorganize the send-email README to follow the listed section order and incorporate their content. Done when the requested sections are present, including the missing migration and failure handling guidance, with Provisioning included only if it applies.

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

Descrizione

documentation kits

firestore-send-email kit README. Priority: low. Do this last, after the other sub-issues of #3290 have landed.

What

Restructure kits/firestore-send-email/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 316 lines and 2,219 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.
  • Region: a subsection under Differences. Fold DATABASE_REGION now decides where the function runs into it.
  • Provisioning: only if it applies to this kit.
When

Wait until #3309 (which edits this README) has merged. Then fold its content into the new structure rather than rewriting it.

Also fix the wrong README and CHANGELOG statements listed in #3300, which was closed in favour of this issue.

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.