Skip to content

Commit a115522

Browse files
Merge pull request #348 from FirebasePrivate/rachelsaunders-sectionsH4s
PREINSTALL files: sections to H4s; remove line break before bullet lists
2 parents f0502ef + 39ed567 commit a115522

File tree

8 files changed

+12
-24
lines changed

8 files changed

+12
-24
lines changed

auth-mailchimp-sync/PREINSTALL.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,15 @@ This extension adds the email address of each new user to your specified Mailchi
66

77
This extension uses Mailchimp, so you'll need to supply your Mailchimp API Key and Audience ID when installing this extension.
88

9-
### Additional setup
9+
#### Additional setup
1010

1111
Make sure that you've set up [Firebase Authentication](https://firebase.google.com/docs/auth) to manage your users.
1212

1313
You must also have a Mailchimp account before installing this extension.
1414

15-
### Billing
15+
#### Billing
1616

1717
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
18-
1918
- Firebase Realtime Database
2019
- Cloud Functions
2120

delete-user-data/PREINSTALL.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,15 @@ You can configure this extension to delete user data from any or all of the foll
66

77
This extension is useful in respecting user privacy and fulfilling compliance requirements. However, using this extension does not guarantee compliance with government and industry regulations.
88

9-
### Additional setup
9+
#### Additional setup
1010

1111
Depending on where you'd like to delete user data from, make sure that you've set up [Cloud Firestore](https://firebase.google.com/docs/firestore), [Realtime Database](https://firebase.google.com/docs/database), or [Cloud Storage](https://firebase.google.com/docs/storage) in your Firebase project before installing this extension.
1212

1313
Also, make sure that you've set up [Firebase Authentication](https://firebase.google.com/docs/auth) to manage your users.
1414

15-
### Billing
15+
#### Billing
1616

1717
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
18-
1918
- Cloud Firestore
2019
- Firebase Realtime Database
2120
- Cloud Storage

firestore-bigquery-export/PREINSTALL.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,28 @@
11
Use this extension to export the documents in a Cloud Firestore collection to BigQuery. Exports are realtime and incremental, so the data in BigQuery is a mirror of your content in Cloud Firestore.
22

33
The extension creates and updates a [dataset](https://cloud.google.com/bigquery/docs/datasets-intro) containing the following two BigQuery resources:
4-
54
+ A [table](https://cloud.google.com/bigquery/docs/tables-intro) of raw data that stores a full change history of the documents within your collection. This table includes a number of metadata fields so that BigQuery can display the current state of your data. The principle metadata fields are `timestamp`, `document_name`, and the `operation` for the document change.
65
+ A [view](https://cloud.google.com/bigquery/docs/views-intro) which represents the current state of the data within your collection. It also shows a log of the latest `operation` for each document (`CREATE`, `UPDATE`, or `IMPORT`).
76

87
Whenever a document is created, updated, deleted, or imported in the specified collection, this extension sends that update to BigQuery. You can then run queries on this mirrored dataset.
98

109
Note that this extension only listens for _document_ changes in the collection, but not changes in any _subcollection_. You can, though, install additional instances of this extension to specifically listen to a subcollection or other collections in your database. Or if you have the same subcollection across documents in a given collection, you can use `{wildcard}` notation to listen to all those subcollections (for example: `chats/{chatid}/posts`).
1110

12-
### Additional setup
11+
#### Additional setup
1312

1413
Before installing this extension, you'll need to:
15-
1614
+ [Set up Cloud Firestore in your Firebase project.](https://firebase.google.com/docs/firestore/quickstart)
1715
+ [Link your Firebase project to BigQuery.](https://support.google.com/firebase/answer/6318765)
1816

19-
#### Import existing documents
20-
2117
This extension only sends the content of documents that have been changed -- it does not export your full dataset of existing documents into BigQuery. So, to backfill your BigQuery dataset with all the documents in your collection, you can run the import script provided by this extension.
2218

2319
**Important:** Run the script over the entire collection _after_ installing this extension, otherwise all writes to your database during the import might be lost.
2420

2521
Learn more about using this script to [backfill your existing collection](https://dev-partners.googlesource.com/samples/firebase/mods/+/master/firestore-bigquery-export/guides/IMPORT_EXISTING_DOCUMENTS.md).
2622

27-
### Billing
23+
#### Billing
2824

2925
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
30-
3126
+ Cloud Firestore
3227
+ BigQuery
3328
+ Cloud Functions

firestore-counter/PREINSTALL.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,17 @@ In your app, you specify a Cloud Firestore document path and increment a field v
44

55
Note that this extension is for use with the JavaScript apps and requires the Firebase JavaScript SDK.
66

7-
### Additional setup
7+
#### Additional setup
88

99
Before installing this extension, make sure that you've [set up a Cloud Firestore database](https://firebase.google.com/docs/firestore/quickstart) in your Firebase project.
1010

1111
After installation, you'll need to update your database security rules and set up a [scheduled function](https://firebase.google.com/docs/functions/schedule-functions) to regularly call one of the functions created by this extension. Detailed information for these post-installation tasks are provided after you install this extension.
1212

1313
This extension provides a Counter SDK that you need to install in your app. You can then use this library in your code to specify your document path and increment values. Detailed instructions to install this SDK and use it are provided after you install this extension.
1414

15-
### Billing
15+
#### Billing
1616

1717
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
18-
1918
- Cloud Firestore
2019
- Cloud Functions
2120

firestore-send-email/PREINSTALL.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,3 @@ This extension uses other Firebase or Google Cloud Platform services which may h
3131
When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling to a Google Cloud Platform API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. [Learn more about Firebase billing.](https://firebase.google.com/pricing)
3232

3333
Usage of this extension also requires you to have SMTP credentials for mail delivery. You are responsible for any associated costs with your usage of your SMTP provider.
34-

rtdb-limit-child-nodes/PREINSTALL.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@ Use this extension to control the maximum number of nodes stored in a Firebase R
22

33
If the number of nodes in your specified Realtime Database path exceeds the specified max count, this extension deletes the oldest nodes first until there are the max count number of nodes remaining.
44

5-
### Additional setup
5+
#### Additional setup
66

77
Before installing this extension, make sure that you've [set up a Realtime Database instance](https://firebase.google.com/docs/database) in your Firebase project.
88

9-
### Billing
9+
#### Billing
1010

1111
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
12-
1312
- Firebase Realtime Database
1413
- Cloud Functions
1514

rtdb-shorten-urls/PREINSTALL.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,9 @@ If the original URL in the database path is updated, then the shortened URL will
1616

1717
This extension uses Bitly to shorten URLs, so you'll need to supply your Bitly access token as part of this extension's installation. You can generate this access token using [Bitly](https://bitly.com/a/oauth_apps).
1818

19-
### Billing
19+
#### Billing
2020

2121
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
22-
2322
- Firebase Realtime Database
2423
- Cloud Functions
2524

rtdb-translate-text/PREINSTALL.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,9 @@ If the original, untranslated string in the database path is updated, then the t
2626

2727
This extension uses the Google Translate API for translations, which requires a billing account to use. Make sure to review the [pricing structure](https://cloud.google.com/translate/#pricing) for the Google Translate API.
2828

29-
### Billing
29+
#### Billing
3030

3131
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
32-
3332
- Cloud Translation API
3433
- Firebase Realtime Database
3534
- Cloud Functions

0 commit comments

Comments
 (0)