search

firebase / extensions

Source code for official Firebase extensions
https://firebase.google.com/products/extensions
Apache License 2.0
882 stars 372 forks source link

docs(firestore-bigquery-export): clarify meaning of "exclude old data" #2024

Closed gregfenton closed 2 weeks ago

gregfenton commented 3 months ago

The original description is generically worded. This additional specificity should make it clear to Firestore users what is meant by "old data".

cabljac commented 2 months ago

Hi there! thanks for contributing!

The README.md isn't actually directly edited, what you need to do is find the corresponding documentation in the extension.yaml or the PREINSTALL.md and amend it there, before running npm run generate-readme in the functions directory

Can you do this and push changes, and I'll review?

gregfenton commented 2 months ago

@cabljac change made as per your direction. Thanks!

pr-Mais commented 1 month ago

Hi @gregfenton, the README is still missing, could you please npm run generate-readme and push the generated file?

gregfenton commented 1 month ago

Is there a document describing how to make docs PRs in a "clean way" ? I'd prefer to get it right on the first pass, and not bother busy people like y'all 😊

pr-Mais commented 3 weeks ago

Thanks @gregfenton! currently there's this guide, but it's missing some steps, will update it.

gregfenton commented 3 weeks ago

I'd be cool with nothing more than a bullet-list:

  1. clone repo
  2. npm install
  3. edit files as you see fit
  4. npm run generate-readme
  5. commit & push (or PR)
cabljac commented 2 weeks ago

Tests are failing, and I think it's because they need an environment variable from the repo secrets. I'll reopen this (and keep your commits etc) from a branch

cabljac commented 2 weeks ago

closing in favour of https://github.com/firebase/extensions/pull/2124