Skip to content
New issue

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

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

Already on GitHub? # to your account

Fix staticman v2/v3 comments not showing #2351

Merged
merged 1 commit into from
Dec 19, 2019

Conversation

akhy
Copy link
Contributor

@akhy akhy commented Dec 19, 2019

This is a bug fix.

Summary

According to the most recent docs, branch and endpoint should be inside site.comments.staticman config instead of site.staticman.

Context

https://mmistakes.github.io/minimal-mistakes/docs/configuration/#staticman-v3

According to the most recent docs, `branch` and `endpoint` should be inside `site.comments.staticman` config.
@deadlydog
Copy link
Contributor

FYI @mmistakes this was actually a breaking change. I had my blog's _config.yml set to use the latest commit via:

remote_theme: mmistakes/minimal-mistakes

And never noticed until today that comments were no longer showing up on my blog. Before finding this PR, a quick fix was to do:

remote_theme: mmistakes/minimal-mistakes@26c1989

Now that I see the actual change you applied, I'm sure I can update my _config.yml appropriately to have it place the variables in their new expected place. The fix was simply to indent the lines:

staticman:
  branch: "master"
  endpoint: "https://MyEndpoint.herokuapp.com/v3/entry/github/"

to (added 2 spaces in front of each line):

  staticman:
    branch: "master"
    endpoint: "https://MyEndpoint.herokuapp.com/v3/entry/github/"

I'm posting the fix for others who come across this issue and find this PR.

Just thought I'd mention this, as you may not have realized you were making a breaking change here, and may want to communicate it somehow in the ReadMe for others that discover their comments have suddenly gone missing.

@mmistakes
Copy link
Owner

That’s one of the big drawbacks of using remote themes. Every commit to the repo has the possibility of breaking your site. This is why I encourage installing it by locking at specific versions or commits... as you’ve pointed out above.

@deadlydog
Copy link
Contributor

Yeah, I'll be locking it via commit message going forward. I also found a bug introduced by this PR and created the PR above to address it :) Thanks for your great theme and hard work!

kamil-adam pushed a commit to twocolumn/minimal-mistakes that referenced this pull request Apr 1, 2020
According to the most recent docs, `branch` and `endpoint` should be inside `site.comments.staticman` config.
jesuswasrasta pushed a commit to jesuswasrasta/jesuswasrasta.github.io that referenced this pull request Jul 8, 2020
According to the most recent docs, `branch` and `endpoint` should be inside `site.comments.staticman` config.
kamil-adam pushed a commit to twocolumn/minimal-mistakes that referenced this pull request Oct 23, 2020
According to the most recent docs, `branch` and `endpoint` should be inside `site.comments.staticman` config.
kamil-adam pushed a commit to twocolumn/minimal-mistakes that referenced this pull request Mar 15, 2021
According to the most recent docs, `branch` and `endpoint` should be inside `site.comments.staticman` config.
kaitokikuchi pushed a commit to kaitokikuchi/kaitokikuchi.github.io that referenced this pull request Sep 4, 2023
According to the most recent docs, `branch` and `endpoint` should be inside `site.comments.staticman` config.
chukycheese pushed a commit to chukycheese/chukycheese.github.io that referenced this pull request Sep 18, 2023
According to the most recent docs, `branch` and `endpoint` should be inside `site.comments.staticman` config.
# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants