WIP: Do not advise users to install Jekyll outside of Bundler #6927
Conversation
|
The purpose of This does mean that there may be a difference between the system Jekyll and the Bundler Jekyll. If this issue needs fixing, it might require a more wholistic view of how we expect users to install/run Jekyll then this PR currently provides. |
I think this is the key here. No question, this is incomplete at the moment. Over time, the trend in the documentation has become more "Bundler-oriented" and it is expected to be part of your gem management (on some level) with regard to Jekyll projects. #4368 was an early attempt at this, but I think things have matured to the point where it warrants consideration again. Obviously, we shouldn't dictate environments if at all possible, but not doing this at some point just sounds like a compatibility headache that users shouldn't have to worry about. It doesn't solve the entire problem (which itself is nigh-impossible because software is hard) but it does make the management of these things a bit easier by removing some complexity from the equation. |
chrisfinazzo
changed the title
Agreed. /cc: @jekyll/documentation |
pathawks
changed the title
|
We should link to https://jekyllrb.com/tutorials/using-jekyll-with-bundler/ in the About Bundler section, and even merge the whole so that we keep it a quickstart guide. |
pathawks
changed the title
docs/index.html
Outdated
| <p class="line"> | ||
| <span class="path">~</span> | ||
| <span class="prompt">$</span> | ||
| <span class="command">bundle add jekyll && bundle install</span> |
There was a problem hiding this comment.
Should we use & instead here?
There was a problem hiding this comment.
@crispgm, I used it because it is the convention in Bash to indicate “Run this command, now run that command” after the first one completes. I don’t know enough with regard to character encodings to say if this would cause Unicode issues and not display correctly in some browsers.
There was a problem hiding this comment.
@chrisfinazzo there is no issues with &&, I mean we should use & to show a & in HTML.
There was a problem hiding this comment.
Tried it out just to be sure, looks the same, so I'm 👍🏼 on this.
| gem install bundler | ||
|
|
||
| # Add Jekyll to your Gemfile and install its dependencies | ||
| bundle add jekyll && bundle install |
There was a problem hiding this comment.
One would need to run bundle init or be certain they have a valid Gemfile before they can run bundle add
There was a problem hiding this comment.
I’m not sure where this Gemfile would exist. Some directory that is a parent of all of a users Jekyll sites?
There was a problem hiding this comment.
This is why the docs currently recommend the jekyll new approach after gem install jekyll. Its a lot simpler..
There was a problem hiding this comment.
I considered whether or not to expicitly mention bundle init here, as it is already described in some detail on the tutorial that we will be linking. Is that just repeating ourselves for no reason?
There was a problem hiding this comment.
bundle add jekyll is detailed in that tutorial as well.. So, your concern is actually moot since bundle init is a necessary step for bundle add jekyll to run successfully..
docs/_docs/quickstart.md
Outdated
| @@ -26,7 +29,7 @@ If you encounter any unexpected errors during the above, please refer to the [tr | |||
|
|
|||
| ## About Bundler | |||
|
|
|||
| `gem install jekyll bundler` installs the [jekyll](https://rubygems.org/gems/jekyll/) and [bundler](https://rubygems.org/gems/bundler) gems through [RubyGems](https://rubygems.org/). You need only to install the gems one time — not every time you create a new Jekyll project. Here are some additional details: | |||
| `gem install bundler` installs the [bundler](https://rubygems.org/gems/bundler) gem through [RubyGems](https://rubygems.org/). You need only to install it once — not every time you create a new Jekyll project. Here are some additional details: | |||
There was a problem hiding this comment.
You may consider rewording this sentence to:
- You need only to install it once — not every time you create a new Jekyll project.
+ You only need to install it once — not every time you create a new Jekyll project.There was a problem hiding this comment.
Ok, will update.
Might be a little while as I just finished restoring from a Time Machine backup.
Tl;dr, 10.13.4 "delta" Installer is 💩 .
|
@jekyllbot: merge +docs |
| <p class="line"> | ||
| <span class="path">~</span> | ||
| <span class="prompt">$</span> | ||
| <span class="command">bundle add jekyll & & bundle install</span> |
There was a problem hiding this comment.
I'm...not that clever. Sorry about this - as written, it's a syntax error. Fix is in #6969.
This probably should have been in #6881. It seems reasonable to me that Jekyll should be under Bundler's purview. This is consistent w/ instructions here and is useful if you don't run
jekyll new(which callsbundle installinternally). The wording is a bit repetitive, so that might need to be tweaked.