From 54e5426c898e94846c149be602d614edb5c157f6 Mon Sep 17 00:00:00 2001 From: Chris Raynor Date: Fri, 3 Mar 2017 16:00:48 -0800 Subject: [PATCH] Misc doc fixes --- .gitignore | 1 + email-confirmation/README.md | 4 ++-- email-confirmation/public/index.html | 12 ------------ fcm-notifications/README.md | 8 ++++---- text-moderation/README.md | 9 ++++----- 5 files changed, 11 insertions(+), 23 deletions(-) diff --git a/.gitignore b/.gitignore index 592fa75..55aeeb0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .idea **/node_modules/* +**/.firebaserc diff --git a/email-confirmation/README.md b/email-confirmation/README.md index b7650d8..8e49934 100644 --- a/email-confirmation/README.md +++ b/email-confirmation/README.md @@ -42,8 +42,8 @@ firebase functions:config:set gmail.email="myusername@gmail.com" gmail.password= This sample comes with a web-based UI for testing the function. To set it up: - - Create a Firebase Project using the Firebase Developer Console - - Enable Google Provider in the Auth section + - Create a Firebase Project using the [Firebase Developer Console](https://console.firebase.google.com) + - Enable Google Provider in the [Auth section](https://console.firebase.google.com/project/_/authentication/providers) - Import and configure Firebase in the `public/index.html` where the `TODO` is located diff --git a/email-confirmation/public/index.html b/email-confirmation/public/index.html index 53cc2d0..7c4cf01 100644 --- a/email-confirmation/public/index.html +++ b/email-confirmation/public/index.html @@ -101,18 +101,6 @@ * TODO(DEVELOPER): Paste the initialization snippet from: Firebase Console > Overview > Add Firebase to your web app. * *********************************************************************************************************************** --> - - diff --git a/fcm-notifications/README.md b/fcm-notifications/README.md index 41cecd6..b946e0f 100644 --- a/fcm-notifications/README.md +++ b/fcm-notifications/README.md @@ -53,9 +53,9 @@ The function triggers every time the value of a follow flag changes at `/followe This sample comes with a web-based UI for testing the function. To test it out: - - Create a Firebase Project using the Firebase Developer Console - - Enable billing since Functions require billing. - - Enable Google Provider in the Auth section - - Import and configure Firebase in the `index.html` where the `TODO` is located + - Create a Firebase Project using the [Firebase Developer Console](https://console.firebase.google.com) + - Enable Google Provider in the [Auth section](https://console.firebase.google.com/project/_/authentication/providers) + - Import and configure Firebase in `public/index.html` where the `TODO` is located + - Install the required dependencies by running `npm install` in the `functions` directory - Deploy your project using `firebase deploy` - Open the app and start following a user, this will send a notification to him. diff --git a/text-moderation/README.md b/text-moderation/README.md index 0f7b0f1..f5a59ec 100644 --- a/text-moderation/README.md +++ b/text-moderation/README.md @@ -50,16 +50,15 @@ The function triggers every time a message is modified. It exits if the message ## Security Rules -The security rules only allow users to create message but not edit them afterwards. Also it does not allows users to set the `sanitized` value. Only the Functions is allowed to modify `sanitized` by using an admin authorized reference. +The security rules only allow users to create message but not edit them afterwards. Also it does not allow users to set the `sanitized` value. Only the Cloud Function is allowed to modify `sanitized` by using an admin authorized reference. ## Deploy and test This sample comes with a web-based UI for testing the function. To test it out: - - Create a Firebase Project using the Firebase Developer Console - - Enable Google Provider in the Auth section - - Import and configure Firebase in the `index.html` where the `TODO` is located + - Create a Firebase Project using the [Firebase Developer Console](https://console.firebase.google.com) + - Import and configure Firebase in `public/index.html` where the `TODO` is located + - Install the required dependencies by running `npm install` in the `functions` directory - Deploy your project using `firebase deploy` - Open the app and add messages to the message board. Try to ad bad words into your message and they should get moderated. -