docs(delete-user-data): restructure the kit README to match the firestore-bigquery-export kit README

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

I maintainer di solito rispondono entro 1 giorno

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
firebase, typescript
Ambito
documentation

Direzione di ricerca

Read kits/delete-user-data/README.md and compare its structure with kits/firestore-bigquery-export/README.md. Wait until PRs #3276, #3277, #3278, #3282, #3284, and #3286 have merged, then fold their content into the requested section order. Done when the README follows that order and addresses the listed missing sections where they apply.

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

Descrizione

documentation kits

delete-user-data kit README. Priority: low. Do this last, after the other sub-issues of #3249 have landed.

What

Restructure kits/delete-user-data/README.md so it is similar in structure and length to kits/firestore-bigquery-export/README.md. At kits @ 1c7b0474, the FBE README is 418 lines and 2,450 words; this one is 266 lines and 1,590 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.
  • Provisioning: only if it applies to this kit.
When

Wait until the PRs that edit this README have merged: #3276, #3277, #3278, #3282, #3284 and #3286. Then fold their content into the new structure rather than rewriting it.

Lingua principale
TypeScript
Stelle
979
Fork
436
Merge medio
2g 13h
PR unite (30g)
18

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.