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

Open
#3,315 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 8 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

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.

Written by the indexing model from the issue text.

Description

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.

Dominant language
TypeScript
Stars
979
Forks
434
Avg merge
10d 8h
Merged PRs (30d)
28

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from firebase/extensions

All issues in firebase/extensions

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.