Add ngrok sidecar to facebook webhook #126
Conversation
infrastructure/scripts/user-input.sh
Outdated
| @@ -1,13 +1,15 @@ | |||
| #!/bin/bash | |||
| set -euo pipefail | |||
| IFS=$'\n\t' | |||
| #set -euo pipefail | |||
There was a problem hiding this comment.
why did you comment the strict mode out?
There was a problem hiding this comment.
It failed for me for unbound-variables and I couldn't solve it otherwise. But we can do some more testing and try ti keep it.
There was a problem hiding this comment.
ah yes that is what the u does. so you could just remove that
| @@ -17,13 +19,17 @@ do | |||
| fi | |||
| done < ../airy.conf | |||
|
|
|||
| sed -i '.bak' "s/<fb_app_id>/${config[FB_APP_ID]}/" ../deployments/sources-facebook-events-router.yaml | |||
| sed -i '.bak' "s/<fb_app_id>/${config[FB_APP_ID]}/" ../deployments/api-admin.yaml | |||
| sed -i "s/<fb_app_id>/${config[FB_APP_ID]}/" ../deployments/sources-facebook-events-router.yaml | |||
There was a problem hiding this comment.
it doesn't work without a backup file on mac. At least not with sed
There was a problem hiding this comment.
-i '' it seems to work with an empty string
There was a problem hiding this comment.
Ah... but note that this is run inside the vagrant box, so it runs on LInux and not on Mac
README.md
Outdated
| $ vagrant ssh | ||
| $ kubectl get pods | ||
| ``` | ||
|
|
||
| When the platform starts it will print out the public webhook urls and the local API IP and port. |
There was a problem hiding this comment.
We should have this into a paragraph (so it's easier to reach from the top of the document).
will is almost never a good idea in technical documentation. The same sentence without the will reads better. Even better would be:
During the bootstrapping phase, the Airy Core Platform prints out the public webhook URLs and the local address you can use to query the API.
README.md
Outdated
| $ vagrant ssh | ||
| $ kubectl get pods | ||
| ``` | ||
|
|
||
| When the platform starts it will print out the public webhook urls and the local API IP and port. | ||
| To refresh this information, you can run: |
There was a problem hiding this comment.
refresh as recreate? reload? I can't say
There was a problem hiding this comment.
View again. Maybe refetch?
There was a problem hiding this comment.
I put
To display this information again, you can run:
Also print can be used I think.
README.md
Outdated
| $ /vagrant/scripts/status.sh | ||
| ``` | ||
|
|
||
| You can stop, start or restart the Airy Core Platform virtual machine with the following commands |
There was a problem hiding this comment.
the document is using box instead of virtual machine (I"m fine with both but we have to stay consistent). Let's also add a : at the end of the sentence
README.md
Outdated
| $ vagrant reload | ||
| ``` | ||
|
|
||
| You can delete and re-create the whole environment with the following commands |
README.md
Outdated
|
|
||
| ### Connect the Facebook source | ||
|
|
||
| In order to work with the Facebook source, you will need to provide your Facebook credentials. The system will provision a demo credentials initially and if you want to put in your facebook credentials, please edit the `infrastructure/airy.conf` config file and then run the following command |
There was a problem hiding this comment.
will can be removed everywhere. Also :.
please is also not very good for technical documentation. In this case you must is correct (because the user has to do it)
There was a problem hiding this comment.
Maybe you need to ? Because he should do it because he needs it, maybe must is too implying?
| @@ -38,6 +38,12 @@ Since Minikube clusters are usually not exposed to the public internet, we | |||
| included an ngrok client to facilitate the integration of sources (via | |||
| webhooks). | |||
|
|
|||
| In order for the Airy Core Platform to be accessible from the outside (for example from Facebook, in order to send events to the Facebook webhook), | |||
There was a problem hiding this comment.
have included -> included
, which will create -> which creates (notice the comma also)
The Airy Core Platform prints out the public URL (active voice > passive voice)
No description provided.