Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify ${params} #448

Open
wants to merge 3 commits into
base: next
Choose a base branch
from
Open

Clarify ${params} #448

wants to merge 3 commits into from

Conversation

joshdance
Copy link
Contributor

This is tricky because we only want this note to show if they are reading on Github and not in the Extensions > How this Extension Works tab, but thought I would suggest it.

I didn't realize these parameters would fill in with my specific project details when I saw them on Github.

jsteele-stripe and others added 2 commits August 24, 2022 15:13
* feat(firestore-stripe-payments): upgraded to the new emulator suite (invertase#400)

tests(firestore-stripe-payments): upgraded to the new emulator suite

* fix(firestore-stripe-payments): added env stripe key check on test setup

* fix(firestore-stripe-payments): added env stripe key check on test setup

* formatted code

* Remove link to old repo

* feat(firestore-stripe-payments): Allow configuring min instances for createCheckoutSession (invertase#375)

* feat: Allow configuring min instances for createCheckoutSession

* Update firestore-stripe-payments/extension.yaml

* Update firestore-stripe-payments/extension.yaml

Co-authored-by: Jonathan Steele <83410553+jsteele-stripe@users.noreply.github.com>

* chore(firestore-stripe-payments): updated scripts for CI and local testing (invertase#415)

* chore(firestore-stripe-payments): updated scripts for ci and local testing

* chore(firestore-stripe-payments): added testing typescript configuration, fixes jest warnings in files

* fix(firestore-stripe-web-sdk): locked sinon types to 10.0.6

* chore(firestore-stripe-payments): removed obsolete comments

* fix(firestore-stripe-payments): `minInstances` parameter expects number

* docs(firestore-stripe-payments): Update APIs for restricted key (invertase#411)

Prices API replaces the Plans API, per https://stripe.com/docs/api/plans

* docs(firestore-stripe-payments): Add extra context to `CREATE_CHECKOUT_SESSION_MIN_INSTANCES` config parameter

* fix(firestore-stripe-payments): added subscription payments prices, test and refactor included (invertase#393)

* fix(firestore-stripe-payments): added subscription payments prices, tests and refactor included

* chore: locked firebase tools workflow to 10.9.2

* added setup emulator for collection helper functions

* chore: commiting empty env files

* chore: updated ci firebase tools to latest

* pinned sinon types at 10.0.6

* feat(firestore-stripe-payments): createPortalLink auth tweaks (invertase#420)

Throw 'unauthenticated' code instead of 'failed-precondition' and use optional chaining (supported in Node 14) to avoid redundant check for 'context.auth.uid'.

* docs(firestore-stripe-payments): Fix GitHub link to `firestore-stripe-web-sdk` README

Fixes invertase#409

* chore: 2022-08-23 release (invertase#422)

* [skip ci] Open PR

* chore(firestore-stripe-payments): 0.3.0 release

* chore: Remove lockfiles from .gitignore (invertase#426)

Re-generated `package-lock.json` for each extension, too

* chore: 2022-08-24 release (invertase#427)

* [skip ci] Open PR

* chore(firestore-stripe-invoices): 0.2.1 release

* chore(firestore-stripe-payments): 0.3.1 release

* fix(firestore-stripe-payments): renamed create checkout min instances config (invertase#428)

* chore: Remove lockfiles from .gitignore

Re-generated `package-lock.json` for each extension, too

* fix(firestore-stripe-payments): renamed create checkout min instances config

* fix: added eventchannel check

Co-authored-by: Jonathan Steele <jsteele@stripe.com>

Co-authored-by: Darren Ackers <ackers86@hotmail.com>

Co-authored-by: Darren Ackers <ackers86@hotmail.com>
Co-authored-by: CJ Avilla <cjavilla@stripe.com>
Co-authored-by: Allen <abierbaum@gmail.com>
Co-authored-by: Will Battel <willbattel@gmail.com>
This is tricky because we only want this note to show if they are reading on Github and not in the Extensions > How this Extension Works tab, but thought I would suggest it. 

I didn't realize these parameters would fill in with my specific project details when I saw them on Github.
@CLAassistant
Copy link

CLAassistant commented Oct 4, 2022

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ joshdance
✅ dackers86
❌ jsteele-stripe
You have signed the CLA already but the status is still pending? Let us recheck it.

@dackers86 dackers86 changed the base branch from master to next September 4, 2023 22:39
@dackers86
Copy link
Member

Hi @joshdance

Typically for Firebase Extensions, any documentation that requires a param field - would need to be added to the PRINSTALL.md.

Extensions.dev documentation is added through the PREINSTALL.md,

README and CONTRIBUTING documentation is mainly for Github.

is there a particularly section of the docs which is in the incorrect file?

@AJSteinhauser
Copy link

Atleast the comment in the firestore-stripe-payments/POSTINSTALL.md would be a great contribution. I definitely spent a minute googling around if ${param:params} was some special firestore.rules syntax I had not heard of.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants