Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Outdated Staticman Docs #2818

Closed
VincentTam opened this issue Feb 10, 2021 · 0 comments · Fixed by #2831
Closed

Outdated Staticman Docs #2818

VincentTam opened this issue Feb 10, 2021 · 0 comments · Fixed by #2831

Comments

@VincentTam
Copy link
Contributor

VincentTam commented Feb 10, 2021

Motivation

  1. Staticman's maintainer recommended users to move away from any public API instance in Staticman public instance not available eduardoboucas/staticman#317 (comment).
  2. The current section about adding a GitHub bot as a collaborator is a legacy authentication method. To stop other users using your own GitHub bot, extra work (not documented) needs to be done. That's too complicated for normal users. Switching to GitHub App circumvents this problem because one can make it private (so that others can't use it) and limit the repos to which it's installed.

Suggestion

In eduardoboucas/staticman#367 (comment), Staticman's maintainer suggested to stop mentioning all references to the current public instance. We should follow suit as the reliability of the public instance is no longer guaranteed.

In this repo, the public instance is used as a fallback URL.

<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">

# https://api.staticman.net/v2/encrypt/{TEXT TO BE ENCRYPTED}

https://github.com/mmistakes/minimal-mistakes/blob/7bb68edf0353a72e82a4c39c6b153eca6721a1eb/docs/_docs/05-configuration.md lines 434, 527

The default should be removed, and the associated part of the doc has to be rewritten as a consequence.

As the author of the part for Staticman's native GitLab support in v3 in this repo's docs in #2043, I'm going to propose a PR to keep things up to the current situation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants