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

Fix misleading description of gitment #22

Merged
merged 1 commit into from Jan 10, 2018
Merged

Conversation

@wafer-li
Copy link
Member

wafer-li commented Jan 10, 2018

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our guidelines.
  • Tests for the changes have been added (for bug fixes / features).
    • Muse | Mist have been tested.
    • Pisces | Gemini have been tested.
  • Docs have been added / updated (for bug fixes / features).

PR Type

What kind of change does this PR introduce?

  • Bugfix.
  • Feature.
  • Code style update (formatting, local variables).
  • Refactoring (no functional changes, no api changes).
  • Build related changes.
  • CI related changes.
  • Documentation content changes.
  • Other... Please describe: Fix description of config

What is the current behavior?

The description of the gitment config is not clear enough.
Issue Number(s): N/A

What is the new behavior?

Description about this pull, in several words...

Fix the misleading description of gitment config.
Details will explain in Review.

  • Screens with this changes: N/A
  • Link to demo site with this changes: N/A

How to use?

In NexT _config.yml:

...

Does this PR introduce a breaking change?

  • Yes.
  • No.
Copy link
Member Author

wafer-li left a comment

It takes me a long time to figure out what the options are and make a working config.

You could check the demo here

gitment:
enable: false
mint: true # RECOMMEND, A mint on Gitment, to support count, language and proxy_gateway
count: true # Show comments count in post meta area
lazy: false # Comments lazy loading with a button
cleanly: false # Hide 'Powered by ...' on footer, and more
language: # Force language, or auto switch by theme
github_user: # MUST HAVE, Your Github ID
github_repo: # MUST HAVE, The repo you use to store Gitment comments
github_user: # MUST HAVE, Your Github Username

This comment has been minimized.

Copy link
@wafer-li

wafer-li Jan 10, 2018

Author Member

This option needs a GitHub Username in fact.

But the description above leads to the id which return by the API.

Therefore, I remove the comment near the top and change the ID to Username to make it more clear.

This comment has been minimized.

Copy link
@wafer-li

wafer-li Jan 10, 2018

Author Member

the description above

and

the comment near the top

means this comment

# You can get your Github ID from https://api.github.com/users/<Github username>
github_user: # MUST HAVE, Your Github ID
github_repo: # MUST HAVE, The repo you use to store Gitment comments
github_user: # MUST HAVE, Your Github Username
github_repo: # MUST HAVE, The name of the repo you use to store Gitment comments

This comment has been minimized.

Copy link
@wafer-li

wafer-li Jan 10, 2018

Author Member

In practice, someone will set the address of repo to this option.

But it just need the name of the repo.

Therefore, I supplement the description.

@ivan-nginx ivan-nginx self-requested a review Jan 10, 2018
Copy link
Member

ivan-nginx left a comment

Yeah, that's right. Thank's!

@ivan-nginx ivan-nginx merged commit 57a03be into theme-next:master Jan 10, 2018
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@wafer-li wafer-li deleted the wafer-li:patch-1 branch Jan 10, 2018
1v9 pushed a commit that referenced this pull request May 23, 2019
pull
tongluyang pushed a commit to tongluyang/hexo-theme-next that referenced this pull request Nov 19, 2019
Fix misleading description of gitment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.