Skip to content

Commit ad90ee7

Browse files
authored
add linebreaks to fix lists (#375)
* add linebreaks to fix lists * regen readmes
1 parent 83eded9 commit ad90ee7

File tree

22 files changed

+75
-27
lines changed

22 files changed

+75
-27
lines changed

auth-mailchimp-sync/PREINSTALL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ You must also have a Mailchimp account before installing this extension.
1515
#### Billing
1616

1717
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
18+
1819
- Firebase Realtime Database
1920
- Cloud Functions
2021

auth-mailchimp-sync/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ You must also have a Mailchimp account before installing this extension.
4343
#### Billing
4444

4545
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
46+
4647
- Firebase Realtime Database
4748
- Cloud Functions
4849

delete-user-data/PREINSTALL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Also, make sure that you've set up [Firebase Authentication](https://firebase.go
1515
#### Billing
1616

1717
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
18+
1819
- Cloud Firestore
1920
- Firebase Realtime Database
2021
- Cloud Storage

delete-user-data/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ Also, make sure that you've set up [Firebase Authentication](https://firebase.go
4747
#### Billing
4848

4949
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
50+
5051
- Cloud Firestore
5152
- Firebase Realtime Database
5253
- Cloud Storage

firestore-bigquery-export/PREINSTALL.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
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+
45
+ 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.
56
+ 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`).
67

@@ -11,6 +12,7 @@ Note that this extension only listens for _document_ changes in the collection,
1112
#### Additional setup
1213

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

@@ -23,6 +25,7 @@ Learn more about using this script to [backfill your existing collection](https:
2325
#### Billing
2426

2527
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
28+
2629
+ Cloud Firestore
2730
+ BigQuery
2831
+ Cloud Functions

firestore-bigquery-export/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
**DETAILS**: 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.
2828

2929
The extension creates and updates a [dataset](https://cloud.google.com/bigquery/docs/datasets-intro) containing the following two BigQuery resources:
30+
3031
+ 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.
3132
+ 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`).
3233

@@ -37,6 +38,7 @@ Note that this extension only listens for _document_ changes in the collection,
3738
#### Additional setup
3839

3940
Before installing this extension, you'll need to:
41+
4042
+ [Set up Cloud Firestore in your Firebase project.](https://firebase.google.com/docs/firestore/quickstart)
4143
+ [Link your Firebase project to BigQuery.](https://support.google.com/firebase/answer/6318765)
4244

@@ -49,6 +51,7 @@ Learn more about using this script to [backfill your existing collection](https:
4951
#### Billing
5052

5153
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
54+
5255
+ Cloud Firestore
5356
+ BigQuery
5457
+ Cloud Functions

firestore-counter/PREINSTALL.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ Use this extension to add a highly scalable counter service to your app. This is
33
Since Cloud Firestore has a limit of one sustained write per second, per document, this extension instead shards your writes across documents in a `_counter_shards_` subcollection. Each client only increments their own unique shard while the background workers (provided by this extension) monitor and aggregate these shards into a main document.
44

55
Here are some features of this extension:
6+
67
- Scales from 0 updates per second to at least 10,000 per second.
78
- Supports an arbitrary number of counters in your app.
89
- Works offline and provides latency compensation for the main counter.
@@ -15,6 +16,7 @@ Note that this extension is currently fully resourced for use with JavaScript ap
1516
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.
1617

1718
After installing this extension, you'll need to:
19+
1820
- Update your [database security rules](https://firebase.google.com/docs/rules).
1921
- Set up a [scheduled function](https://firebase.google.com/docs/functions/schedule-functions) to regularly call the controller function, which is created by this extension and monitors the extension's workload.
2022
- Install the provided [Counter SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts) in your app. You can then use this library in your code to specify your document path and increment values.
@@ -25,6 +27,7 @@ Detailed information for these post-installation tasks are provided after you in
2527
#### Billing
2628

2729
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
30+
2831
- Cloud Firestore
2932
- Cloud Functions
3033

firestore-counter/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
Since Cloud Firestore has a limit of one sustained write per second, per document, this extension instead shards your writes across documents in a `_counter_shards_` subcollection. Each client only increments their own unique shard while the background workers (provided by this extension) monitor and aggregate these shards into a main document.
3030

3131
Here are some features of this extension:
32+
3233
- Scales from 0 updates per second to at least 10,000 per second.
3334
- Supports an arbitrary number of counters in your app.
3435
- Works offline and provides latency compensation for the main counter.
@@ -41,6 +42,7 @@ Note that this extension is currently fully resourced for use with JavaScript ap
4142
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.
4243

4344
After installing this extension, you'll need to:
45+
4446
- Update your [database security rules](https://firebase.google.com/docs/rules).
4547
- Set up a [scheduled function](https://firebase.google.com/docs/functions/schedule-functions) to regularly call the controller function, which is created by this extension and monitors the extension's workload.
4648
- Install the provided [Counter SDK](https://github.com/firebase/extensions/blob/master/firestore-counter/clients/web/src/index.ts) in your app. You can then use this library in your code to specify your document path and increment values.
@@ -51,6 +53,7 @@ Detailed information for these post-installation tasks are provided after you in
5153
#### Billing
5254

5355
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
56+
5457
- Cloud Firestore
5558
- Cloud Functions
5659

firestore-send-email/POSTINSTALL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ Available properties for the `message` field are:
6767
If you specified a "Templates collection" parameter during configuration of the extension, you can create and manage [Handlebars][handlebars] templates for your emails. Each document for a template should have a memorable ID that you use as the *template name* in the document that's written to your `${param:MAIL_COLLECTION}` collection.
6868
6969
The template document can include any of the following fields:
70+
7071
* **subject:** A template string for the subject of the email.
7172
* **text:** A template string for the plaintext content of the email.
7273
* **html:** A template string for the HTML content of the email.

firestore-send-email/PREINSTALL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Before installing this extension, make sure that you've [set up a Cloud Firestor
2525
#### Billing
2626

2727
This extension uses other Firebase or Google Cloud Platform services which may have associated charges:
28+
2829
- Cloud Firestore
2930
- Cloud Functions
3031

0 commit comments

Comments
 (0)