yttt/yamatotoma.to
2
0
Fork 0
Code Pull requests Activity Actions

Staticman documentation enhancement (#514)

Browse source 
* Add a link to Staticman: Webhooks

* Clearer README on Staticman reCAPTCHA and endpoint

* Update README after owner's feedback

* Update staticman.yml after owner's feedback

* Further improve Staticman templates

* Corrected Staticman config instructions

* Update staticman.yml

* Update _config.yml

* Update README.md
This commit is contained in:
Vincent Tam 2019-07-08 21:36:17 +02:00 • committed by Dean Attali
parent 375e16d085
commit 94161dbef7
3 changed files with 20 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -116,9 +116,9 @@ To use Facebook comments, create a Facebook app using [Facebook developers](http
#### Staticman comments
To use Staticman, you first need to invite `staticmanlab` as a collaborator to your repository (by going to your repository **Settings** page, navigate to the **Collaborators** tab, and add the username `staticmanlab`), and then accept the invitation by going to `https://staticman3.herokuapp.com/v3/connect/github/<username>/<repo-name>`. Lastly, fill in your `repository` and `branch` in the Staticman section of `_config.yml`.
To use Staticman, you first need to invite `staticmanlab` as a collaborator to your repository (by going to your repository **Settings** page, navigate to the **Collaborators** tab, and add the username `staticmanlab`), and then accept the invitation by going to `https://staticman3.herokuapp.com/v3/connect/github/<username>/<repo-name>`. Lastly, fill in the `staticman` parameters in the Staticman section of `_config.yml`. You may also choose a different Staticman instance other than `staticmanlab`.
Optional: It is suggested to enable reCAPTCHA to avoid massive spam comments. You may refer to `_config.yml` for detailed instructions.
Optional: You may want to configure a webhook to prevent old inactive branches (representing approved comments) from stacking up. You can refer to [Staticman's documenation](https://staticman.net/docs/webhooks) for details. Make sure to input the **Payload URL** according to your chosen `endpoint`. For example, the default `endpoint` is `https://staticman3.herokuapp.com/v3/entry/github/`, so the corresponding **Payload URL** should be `https://staticman3.herokuapp.com/v1/webhook`.
#### JustComments