Skip to content

Commit 6ae4ce8

Browse files
committed
Updating documentation
1 parent 9dc4e47 commit 6ae4ce8

2 files changed

Lines changed: 5 additions & 16 deletions

File tree

POSTINSTALL.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,3 @@
1-
## ⚠️ If you're having troubles during installation ⚠️
2-
The installation of v2 functions might fail for projects that have never used v2 functions.
3-
4-
It will eventually be fixed on Firebase side, but for now, if you run into errors during install run these commands (or perform equivalent actions via cloud console) and try again:
5-
6-
```
7-
gcloud services enable compute.googleapis.com
8-
9-
gcloud projects add-iam-policy-binding <PROJECT ID> --member serviceAccount:<PROJECT NUMBER>-compute@developer.gserviceaccount.com --role roles/eventarc.eventReceiver
10-
```
11-
121
## Configuring your webhooks
132
Read the official documentation for each of the platforms on how to configure
143
webhooks.
@@ -17,8 +6,8 @@ webhooks.
176
* [Slack](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack)
187
* [Discord](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
198

20-
There is a square Firebase icon under the [`/icons/`](./icons) folder that you
21-
can use for your webhook avatar. Use this permalink to the image: [https://github.com/oddbit/firebase-alerts/raw/main/icons/firebase.png](https://github.com/oddbit/firebase-alerts/raw/main/icons/firebase.png)
9+
There is a square Firebase icon under the [`/icons/`](https://github.com/oddbit/firebase-alerts/raw/main/icons)
10+
folder that you can use for your webhook avatar. Use this permalink to the image: [https://github.com/oddbit/firebase-alerts/raw/main/icons/firebase.png](https://github.com/oddbit/firebase-alerts/raw/main/icons/firebase.png)
2211

2312

2413
## Configuring apps
@@ -34,7 +23,7 @@ Create one document for each of your Firebase app ids in a collection named
3423
- `github` - Optional object for github info
3524
- `repo` - Repository owner and name (e.g. `oddbit/firebase-alerts`)
3625

37-
For web apps, the `bundleId` is a random string that you will have to look for in
26+
For web apps, the `bundleId` is a string that you will have to look for in
3827
URL when you are selecting the web app in the Firebase settings page.
3928

4029
Look for the last part of the URL where `web-app-bundle-id` is your

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ It's easy and fun to develop new webhook plugins. All you need to do is to
1919
declare your new plugin and create a new class that extends the abstract
2020
[`Webhook`](./functions/src/models/webhook.ts)
2121

22-
Have a look at the existing plugin(s) under [`functions/src/webhook-plugins/`](./functions/src/webhook-plugins)
22+
Have a look at the existing plugin(s) under [`functions/src/webhook-plugins/`](https://github.com/oddbit/firebase-alerts/tree/main/functions/src/webhook-plugins)
2323
to see how an implementation can look like.
2424

2525
Create your new plugin alongside the existing plugins `your-new-plugin.ts`
@@ -30,4 +30,4 @@ export class YourNewPluginWebhook extends Webhook {
3030
}
3131
```
3232

33-
Registering the new plugin in the method [`webhookPluginFromUrl()`](./functions/src/alerts/crashlytics.ts).
33+
Registering the new plugin in the method [`webhookPluginFromUrl()`](https://github.com/oddbit/firebase-alerts/blob/main/functions/src/alerts/crashlytics.ts).

0 commit comments

Comments
 (0)