Add 'webrick' warning note to "Quickstart" Docs#8727
Merged
jekyllbot merged 1 commit intojekyll:masterfrom Jul 22, 2021
Merged
Conversation
|
Agree. It should included in docs. Almost all Jekyll template I found were getting webrick error. |
DirtyF
approved these changes
Jul 22, 2021
Member
|
@jekyll: merge +docs |
jekyllbot
added a commit
that referenced
this pull request
Jul 22, 2021
github-actions bot
pushed a commit
that referenced
this pull request
Jul 22, 2021
Miguel Brandão: Add 'webrick' warning note to "Quickstart" Docs (#8727) Merge pull request 8727
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a 🔦 documentation change.
Summary
For Ruby 3.0.0 and higher,
bundle exec jekyll servewill fail because of a missing dependency:webrick.The documentation doesn't mention this problem, while it states that all Ruby versions above 2.4.0 are supported. This is confusing to new users who will probably install the latest Ruby version and thus will be unable to move past step 5 of the Quickstart.
This PR aims to put a band-aid in this situation by adding a warning at the end of the instructions, allowing affected users to quickly identify and solve the problem.
Context
I came across this problem when starting a new site and getting a bunch of errors on step 5 of the Quickstart.
A quick search lead me to this discussion which explained what was happening and provided a working solution.