Merge pull request #360 from FirebasePrivate/rachelsaunders-breaktobullets

PRE/POST - formatting to bullets; light wordsmithing

Author: rachelsaunders

firestore-bigquery-export/PREINSTALL.md

@@ -4,7 +4,7 @@ The extension creates and updates a [dataset](https://cloud.google.com/bigquery/
 +   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.
 +   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`).
 
-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.
+If you create, update, delete, or import a document in the specified collection, this extension sends that update to BigQuery. You can then run queries on this mirrored dataset.
 
 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`).
 

firestore-shorten-urls/POSTINSTALL.md

@@ -12,9 +12,9 @@ You can test out this extension right away:
 
 ### Using the extension
 
-This extension listens to the Cloud Firestore collection `${param:COLLECTION_PATH}`, then shortens any URL added to the field `${param:URL_FIELD_NAME}` in any document within that collection.
-
-This extension saves the shortened URL in the `${param:SHORT_URL_FIELD_NAME}` field of the same document like so:
+This extension listens to the Cloud Firestore collection `${param:COLLECTION_PATH}`. If you add a URL to the field `${param:URL_FIELD_NAME}` in any document within that collection, this extension:
+- Shortens the URL.
+- Saves the shortened URL in the `${param:SHORT_URL_FIELD_NAME}` field of the same document like so:
 
 ```
 {

firestore-shorten-urls/PREINSTALL.md

@@ -1,6 +1,8 @@
 Use this extension to create shortened URLs from URLs written to Cloud Firestore. These shortened URLs are useful as display URLs.
 
-This extension listens to your specified Cloud Firestore collection, then shortens any URL added to a specified field in any document within that collection. This extension saves the shortened URL in a new field in the same document.
+This extension listens to your specified Cloud Firestore collection. If you add a URL to a specified field in any document within that collection, this extension:
+- Shortens the URL.
+- Saves the shortened URL in a new specified field in the same document.
 
 If the original URL in a document is updated, then the shortened URL will be automatically updated, too.
 

firestore-translate-text/POSTINSTALL.md

@@ -2,17 +2,19 @@
 
 To test out this extension, follow these steps:
 
-1.  Go to the [Cloud Firestore tab](https://console.firebase.google.com/project/${param:PROJECT_ID}/database/firestore/data).
+1.  Go to your [Cloud Firestore dashboard](https://console.firebase.google.com/project/${param:PROJECT_ID}/database/firestore/data).
 
 1.  If it doesn't exist already, create a collection called `${param:COLLECTION_PATH}`.
 
-1.  Create a document with a field named `${param:INPUT_FIELD_NAME}` and make its value a word or phrase that you want to translate.
+1.  Create a document with a field named `${param:INPUT_FIELD_NAME}`, then make its value a word or phrase that you want to translate.
 
-1.  In a few seconds, you'll see a new field called `${param:OUTPUT_FIELD_NAME}` pop up in the same document you just created; it will contain the translations for each language specified. 
+1.  In a few seconds, you'll see a new field called `${param:OUTPUT_FIELD_NAME}` pop up in the same document you just created. It will contain the translations for each language you specified during installation. 
 
 ### Using the extension
 
-Whenever a string is written to the field `${param:INPUT_FIELD_NAME}` in `${param:COLLECTION_PATH}`, this extension translates the string into your specified target language(s). The source language of the string is automatically detected. This extension adds the translated string to `${param:OUTPUT_FIELD_NAME}` in the same document using the following format:
+Whenever you write a string to the field `${param:INPUT_FIELD_NAME}` in `${param:COLLECTION_PATH}`, this extension:
+- Translates the string into your specified target language(s); the source language of the string is automatically detected.
+- Adds the translated string to `${param:OUTPUT_FIELD_NAME}` in the same document using the following format:
 
 ```
 {

firestore-translate-text/PREINSTALL.md

@@ -1,6 +1,8 @@
 Use this extension to translate strings (for example, text messages) written to a Cloud Firestore collection.
 
-This extension listens to your specified Cloud Firestore collection. If a string is added to a specified field in any document with that collection, this extension translates the string into your specified target language(s). The source language of the string is automatically detected. This extension adds the translation(s) of the string to a separate specified field in the same document.
+This extension listens to your specified Cloud Firestore collection. If you add a string to a specified field in any document within that collection, this extension:
+- Translates the string into your specified target language(s); the source language of the string is automatically detected.
+- Adds the translation(s) of the string to a separate specified field in the same document.
 
 You specify the desired target languages using ISO-639-1 codes. You can find a list of valid languages and their corresponding codes in the [Cloud Translate API documentation](https://cloud.google.com/translate/docs/languages).
 

storage-resize-images/POSTINSTALL.md

@@ -6,11 +6,16 @@ You can test out this extension right away:
 
 1.  Upload an image file to the bucket: `${param:IMG_BUCKET}`
 
-1.  In a few seconds, the resized image(s) appear in the same bucket. Note that you might need to refresh the page to see changes.
+1.  In a few seconds, the resized image(s) appear in the same bucket.
+
+    Note that you might need to refresh the page to see changes.
 
 ### Using the extension
 
-When you upload an image file to `${param:IMG_BUCKET}`, this extension creates resized image(s) with your specfied dimensions. It stores both the resized image(s) and the original image in the same bucket, `${param:IMG_BUCKET}`. The extension names a resized image using the same name as the original uploaded image, but suffixed with your specified width and height.
+When you upload an image file to `${param:IMG_BUCKET}`, this extension:
+- Creates resized image(s) with your specfied dimensions.
+- Stores the resized image(s) in the bucket `${param:IMG_BUCKET}` (and, if configured, under the path `${param:RESIZED_IMAGES_PATH}`).
+- Names resized image(s) using the same name as the original uploaded image, but suffixed with the specified width and height.
 
 You can upload images using the [Cloud Storage for Firebase SDK](https://firebase.google.com/docs/storage/) for your platform (iOS, Android, or Web). Alternatively, you can upload images directly in the Firebase console's Storage dashboard.
 

storage-resize-images/PREINSTALL.md

@@ -1,6 +1,9 @@
 Use this extension to create resized versions of an image uploaded to a Cloud Storage bucket.
 
-When you upload an image file to your specified Cloud Storage bucket, this extension creates a resized image with your specified dimensions. It stores both the resized image and the original image in the same Storage bucket. The extension names the resized image using the same name as the original uploaded image, but suffixed with your specified width and height.
+When you upload an image file to your specified Cloud Storage bucket, this extension:
+- Creates a resized image with your specified dimensions.
+- Stores the resized image in the same Storage bucket as the original uploaded image.
+- Names the resized image using the same name as the original uploaded image, but suffixed with your specified width and height.
 
 You can even configure the extension to create resized images of different dimensions for each original image upload. For example, you might want images that are 200x200, 400x400, and 680x680 - this extension can create these three resized images then store them in your bucket.