Include step to add "webrick" gem on "Testing your GitHub Pages site locally with Jekyll" page

[caseycarroll]

Code of Conduct

• I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll

What part(s) of the article would you like to see updated?

Ruby 3.0 no longer bundles the webrick gem. The docs should include a step to add gem webrick to the reader's Gemfile.

After completing prerequisites for "Testing your GitHub Pages site locally with Jekyll", bundle exec jekyll serve fails because jekyll can't find the webrick gem.

I suggest the following changes under the "Building your site locally" section

1. Open Git Bash.
2. Navigate to the publishing source for your site. For more information about publishing sources, see "About GitHub Pages."
++ 3. Open the project's Gemfile
++ 4. Add the `webrick` gem anywhere in the file
++ ```gem "webrick"```
++ 5. Save and close Gemfile
6. Run your Jekyll site locally. 
7. To preview your site, in your web browser, navigate to http://localhost:4000.

For more info see jekyll/jekyll#8523

Additional information

No response

[stevecat]

Hi @caseycarroll! Thanks for opening this ✨

It looks like webrick will become a dependancy of Jekyll in v4.3.0 onwards (see: jekyll/jekyll#8524 and jekyll/jekyll#8778 (comment)) which will resolve this.

I don't think we should include this as part of the procedural because it's only going to help folks with Ruby 3.0 and versions of Jekyll prior to webrick being added as a dependancy. I think adding a note callout could really help those folks stuck in this particular scenario though. We can come back and remove it later.

I've just closed #14511 as I think it will be easier to start over. I'd suggest adding a {% note %} callout below the procedural, mentioning that folks using Ruby 3.0 and Jekyll v4.2.x and older will need to add gem "webrick" to their project's Gemfile and run bundle install.

I'll include a link to our docs on callout tags below:

https://github.com/github/docs/blob/main/contributing/content-markup-reference.md#callout-tags

You (or anyone else!) can open a PR to work on this! 😸

[caseycarroll]

@stevecat thank you for looking into this! I totally agree with your suggestion. I'm glad to hear Jekyll will include webrick. If I have time, I'll implement that suggestion, but yes, anyone else should feel free to take this one!

[mohsinaav]

Tyvm.

This is really helpful for someone like me who is a total beginner in jekyll and ruby.