Skip to content

Outdated Staticman Docs #2818

Closed
Closed
@VincentTam

Description

@VincentTam

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.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions