You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Remove all references to official public Staticman API instance. (mmistakes#2831)
* Updated Staticman docs
* remove any ref to official public instance in docs
* remove fallback instance for staticman v2
left staticman v1 untouched as I dunno how to deal with that
<h4class="page__comments-title">{{ site.data.ui-text[site.locale].comments_label | default: "Leave a Comment" }}</h4>
37
37
<pclass="small">{{ site.data.ui-text[site.locale].comment_form_info | default: "Your email address will not be published. Required fields are marked" }} <spanclass="required">*</span></p>
Copy file name to clipboardexpand all lines: docs/_docs/05-configuration.md
+9-6
Original file line number
Diff line number
Diff line change
@@ -334,7 +334,7 @@ For example,
334
334
| **disqus** | Disqus |
335
335
| **discourse** | Discourse |
336
336
| **facebook** | Facebook Comments |
337
-
| **staticman_v2** | Staticman v2 |
337
+
| **staticman_v2** | Staticman v2 / v3 |
338
338
| **staticman** | Staticman v1 (deprecated) |
339
339
| **utterances** | utterances |
340
340
| **custom** | Other |
@@ -425,13 +425,16 @@ Transform user comments into `_data` files that live inside of your GitHub repos
425
425
**Note:** Looking to migrate comments from a WordPress based site? Give [this tool](https://github.com/arthurlacoste/wordpress-comments-jekyll-staticman) a try.
426
426
{: .notice--info}
427
427
428
-
**Note:** Please note that as of September 2018, Staticman is reaching GitHub API limits due to its popularity, and it is recommended by its maintainer that users deploy their own instances for production (use `site.staticman.endpoint`).
428
+
**Note:** Please note that as of September 2018, Staticman is reaching GitHub API limits due to its popularity, and it is recommended by its maintainer that users deploy their own instances for production (use `site.staticman.endpoint`). Consult the Staticman "[Get Started](https://staticman.net/docs/index.html)" guide for more info.
429
429
{: .notice--warning}
430
430
431
-
##### Add Staticman as a collaborator
431
+
##### Add Staticman as a collaborator on GitHub (legacy)
432
432
433
-
1. Allow Staticman push access to your GitHub repository by clicking on **Settings**, then the **Collaborators** tab and adding `staticmanapp` as a collaborator.
434
-
2. To accept the pending invitation visit: `https://api.staticman.net/v2/connect/{your GitHub username}/{your repository name}`. Consult the Staticman "[Get Started](https://staticman.net/docs/index.html)" guide for more info.
433
+
1. Allow Staticman push access to your GitHub repository by clicking on **Settings**, then the **Collaborators** tab and adding your GitHub bot as a collaborator.
434
+
2. To accept the pending invitation visit: `https://{your Staticman v2/3 API}/v[2|3]/connect/{your GitHub username}/{your repository name}`.
435
+
436
+
**Note:** The new GitHub App authentication method is recommended for GitHub repositories to avoid the API rate limit.
437
+
{: .notice--info}
435
438
436
439
##### Configure Staticman
437
440
@@ -524,7 +527,7 @@ By default comment moderation is enabled in `staticman.yml`. As new comments are
524
527
525
528
To skip this moderation step simply set `moderation: false`.
526
529
527
-
**ProTip:** Create a GitHub webhook that sends a `POST` request to the following payload URL `https://api.staticman.net/v2/webhook` and triggers a "Pull request" event to delete Staticman branches on merge.
530
+
**ProTip:** Create a GitHub webhook that sends a `POST` request to the following payload URL `https://{your Staticman API URL}/v2/webhook` and triggers a "Pull request" event to delete Staticman branches on merge.
0 commit comments