Rewrite documentation on installing plugins#8921
Conversation
mattr-
left a comment
There was a problem hiding this comment.
This is a great improvement on the previous documentation. Thanks!
I did suggest a small wording change and have a question about continuing to document the gems key.
docs/_docs/plugins/installation.md
Outdated
| ## Using a Gemfile | ||
|
|
||
| The maintenance of various gem dependencies may be greatly simplified by using a Gemfile (usually at the root of site's source) in conjunction | ||
| with a Rubygem named `bundler`. The Gemfile however **should** list all the primary dependencies of your site, including Jekyll itself, not |
There was a problem hiding this comment.
"...a Rubygem named Bundler"
Proper nouns FTW.
There was a problem hiding this comment.
I'm choosing to leave this in lowercase because it references the actual gem-name (bundler) instead of the library.
However, the consequent mention has been corrected as requested.
There was a problem hiding this comment.
I'm choosing to leave this in lowercase because it references the actual gem-name (
bundler) instead of the library.
Got it. I was thinking about the distinction between Bundler (the project) v bundler (the executable which does a thing). See also Perl and perl.
Carry on.
chrisfinazzo
left a comment
There was a problem hiding this comment.
A few small changes - see comments.
|
Thank you for the reviews @mattr- and @chrisfinazzo. |
|
@ashmaroli, everything looks good. ;) |
|
@jekyllbot: merge +doc |
Ashwin Maroli: Rewrite documentation on installing plugins (#8921) Merge pull request 8921
Summary
Rewrite to reduce gotchas for a novice user working with plugins in their site
Context
Closes #8917
/cc @EmilySeville7cfg to provide feedback.
Preview URL