Skip to content

Commit 2301fdf

Browse files
authoredApr 13, 2021
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
1 parent 8a39b74 commit 2301fdf

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed
 

‎_includes/comments.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h4 class="page__comments-title">{{ site.data.ui-text[site.locale].comments_titl
3535
<div class="page__comments-form">
3636
<h4 class="page__comments-title">{{ site.data.ui-text[site.locale].comments_label | default: "Leave a Comment" }}</h4>
3737
<p class="small">{{ site.data.ui-text[site.locale].comment_form_info | default: "Your email address will not be published. Required fields are marked" }} <span class="required">*</span></p>
38-
<form id="new_comment" class="page__comments-form js-form form" method="post" action="{{ site.comments.staticman.endpoint | default: 'https://api.staticman.net/v2/entry/' }}{{ site.repository }}/{{ site.comments.staticman.branch }}/comments">
38+
<form id="new_comment" class="page__comments-form js-form form" method="post" action="{{ site.comments.staticman.endpoint }}{{ site.repository }}/{{ site.comments.staticman.branch }}/comments">
3939
<div class="form__spinner">
4040
<i class="fas fa-spinner fa-spin fa-3x fa-fw"></i>
4141
<span class="sr-only">{{ site.data.ui-text[site.locale].loading_label | default: "Loading..." }}</span>

‎docs/_docs/05-configuration.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ For example,
334334
| **disqus** | Disqus |
335335
| **discourse** | Discourse |
336336
| **facebook** | Facebook Comments |
337-
| **staticman_v2** | Staticman v2 |
337+
| **staticman_v2** | Staticman v2 / v3 |
338338
| **staticman** | Staticman v1 (deprecated) |
339339
| **utterances** | utterances |
340340
| **custom** | Other |
@@ -425,13 +425,16 @@ Transform user comments into `_data` files that live inside of your GitHub repos
425425
**Note:** Looking to migrate comments from a WordPress based site? Give [this tool](https://github.com/arthurlacoste/wordpress-comments-jekyll-staticman) a try.
426426
{: .notice--info}
427427

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.
429429
{: .notice--warning}
430430

431-
##### Add Staticman as a collaborator
431+
##### Add Staticman as a collaborator on GitHub (legacy)
432432

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}
435438

436439
##### Configure Staticman
437440

@@ -524,7 +527,7 @@ By default comment moderation is enabled in `staticman.yml`. As new comments are
524527

525528
To skip this moderation step simply set `moderation: false`.
526529

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.
528531
{: .notice--info}
529532

530533
![pull-request webhook]({{ "/assets/images/mm-staticman-pr-webhook.jpg" | relative_url }})

‎staticman.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# For example, you can have one property to handle comment submission and
44
# another one to handle posts.
55
# To encrypt strings use the following endpoint:
6-
# https://api.staticman.net/v2/encrypt/{TEXT TO BE ENCRYPTED}
6+
# https://{your Staticman API URL}/v[2|3]/encrypt/{TEXT TO BE ENCRYPTED}
77

88
comments:
99
# (*) REQUIRED

0 commit comments

Comments
 (0)
Please sign in to comment.