Add 'webrick' warning note to "Quickstart" Docs #8727
Merged
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 serve
will 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.