Skip to content

Import bundler guides from bundler.io/guides#425

Merged
hsbt merged 16 commits intomainfrom
migrate-bundler-guides
Mar 4, 2026
Merged

Import bundler guides from bundler.io/guides#425
hsbt merged 16 commits intomainfrom
migrate-bundler-guides

Conversation

@hsbt
Copy link
Copy Markdown
Member

@hsbt hsbt commented Mar 3, 2026

I migrated guides sections of https://bundler.io/docs.html to https://guides.rubygems.org/.

The current contents have some of duplicates and obsolated section with https://guides.rubygems.org/. And https://guides.rubygems.org/ also have same obsolated contents.

After merging this, I will update and organize the whole contents of https://guides.rubygems.org/.

Copilot AI review requested due to automatic review settings March 3, 2026 09:46
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Migrates a set of Bundler guides from bundler.io into this Jekyll-based guides site (guides.rubygems.org), and wires them into the site navigation so they can be browsed as a cohesive “Bundler” section.

Changes:

  • Added multiple Bundler-focused guide pages (getting started, workflow, Gemfile, groups, Rails/Sinatra/RubyMotion, plugins, etc.).
  • Updated the default layout sidebar to include a new “Bundler” navigation section linking to the imported guides.
  • Added a data-driven “Known Plugins” list (_data/known_plugins.yml) and a page to render it.

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 15 comments.

Show a summary per file
File Description
using_bundler_in_applications.en.md New guide covering Bundler usage in applications (init/install/exec/update/troubleshooting).
updating_gems.md New guide explaining conservative vs full dependency updates.
sinatra.md New guide showing Bundler setup for Sinatra apps.
rubymotion.md New guide showing Bundler setup for RubyMotion apps.
rubygems_tls_ssl_troubleshooting_guide.md New TLS/SSL troubleshooting guide for RubyGems/Bundler connectivity issues.
rubygems.md New guide describing Bundler usage while developing gems.
rationale.md New “Why Bundler exists” overview and workflow rationale.
rails.md New guide describing Bundler usage in Rails apps.
groups.md New guide on Bundler groups and related configuration.
git_bisect.md New guide describing git bisect workflows with Bundler.
git.md New guide describing installing gems from git sources.
getting_started.md New Bundler “What is Bundler?” + introductory workflows and links.
gemfile_ruby.md New guide documenting the ruby directive in Gemfiles.
gemfile.md New guide documenting Gemfile structure, sources, groups, and related options.
faq.md New Bundler FAQ page.
deploying.md New guide documenting deployment best practices with Bundler.
credits.md Updates pagination (next) to flow into the new Bundler section.
creating_gem.en.md New guide describing creating a gem with Bundler (long-form tutorial).
bundler_workflow.md New recommended workflow doc (including a longer walkthrough).
bundler_sharing.md New guide on sharing bundled apps + lockfiles + repo hygiene.
bundler_setup.md New guide on bundler/setup, Bundler.setup, and requiring gems.
bundler_plugins.md New guide describing Bundler plugin development and usage.
bundler_known_plugins.md New page rendering a list of known Bundler plugins from data.
bundler_in_a_single_file_ruby_script.md New guide covering bundler/inline usage in single-file scripts.
bundler_docker_guide.md New guide describing Bundler behavior/vars in Docker and multi-app containers.
bundler_2_upgrade.md New guide covering Bundler 2 upgrade concepts and autoswitching.
_layouts/default.html Adds “Bundler” section to the left navigation sidebar.
_data/known_plugins.yml Adds data source for Bundler “Known Plugins” list.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

## The Problems

### Why am I seeing `certificate verify failed`?
[verify-failed]: #why-am-i-seeing--code-certificate-verify-failed--code--
Copy link

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Table of Contents links use reference targets like #why-am-i-seeing--code-certificate-verify-failed--code--, but with kramdown these headings will not generate IDs containing --code-...--. As a result, the TOC links will be broken. Update the reference target(s) to match kramdown-generated heading IDs (e.g. #why-am-i-seeing-certificate-verify-failed), or add explicit IDs to the headings using kramdown syntax.

Suggested change
[verify-failed]: #why-am-i-seeing--code-certificate-verify-failed--code--
[verify-failed]: #why-am-i-seeing-certificate-verify-failed

Copilot uses AI. Check for mistakes.
Comment thread git.md
Comment on lines +61 to +62
git 'https://github.com/rails/rails.git', branch: '5-0-stable' do
git 'https://github.com/rails/rails.git', tag: 'v5.0.0' do
Copy link

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This Ruby snippet is syntactically incomplete: each git ... do block needs a body and an end (or the examples should omit do). As written, readers copying this will get a syntax error. Consider showing one complete example and/or replacing the other lines with commented alternatives.

Suggested change
git 'https://github.com/rails/rails.git', branch: '5-0-stable' do
git 'https://github.com/rails/rails.git', tag: 'v5.0.0' do
gem 'railties'
end
# Alternatively:
# git 'https://github.com/rails/rails.git', branch: '5-0-stable' do
# gem 'railties'
# end
# git 'https://github.com/rails/rails.git', tag: 'v5.0.0' do
# gem 'railties'
# end

Copilot uses AI. Check for mistakes.
Comment thread groups.md Outdated
Comment thread deploying.md Outdated
Comment thread rails.md Outdated
Comment thread bundler_plugins.md Outdated
even [install new OS certificates][update-os-certs].

### Why am I seeing `read server hello A`?
[read-server]: #why-am-i-seeing--code-read-server-hello-a--code--
Copy link

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same issue as above: the [read-server] reference points to #why-am-i-seeing--code-read-server-hello-a--code--, which won't match the kramdown-generated heading ID for "Why am I seeing read server hello A?". Update the reference target (or add an explicit heading ID) so the TOC link works.

Suggested change
[read-server]: #why-am-i-seeing--code-read-server-hello-a--code--
[read-server]: #why-am-i-seeing-read-server-hello-a

Copilot uses AI. Check for mistakes.
Comment thread bundler_plugins.md Outdated
Comment thread bundler_plugins.md
<a name="deploying-your-plugin" id="deploying_your_plugin"></a>

Deploy your plugin to RubyGems so others can install it. For instructions on deploying to RubyGems, visit
[this guide.](./creating_gem.html#releasing-the-gem)
Copy link

Copilot AI Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same broken internal link issue here: ./creating_gem.html#releasing-the-gem won't resolve to the guide added in this PR (/creating_gem.en). Update the link target to the correct path so the section link works.

Suggested change
[this guide.](./creating_gem.html#releasing-the-gem)
[this guide.](/creating_gem.en#releasing-the-gem)

Copilot uses AI. Check for mistakes.
Comment thread creating_gem.md Outdated
hsbt and others added 9 commits March 4, 2026 16:04
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@hsbt hsbt merged commit bf8320a into main Mar 4, 2026
1 check passed
@hsbt hsbt deleted the migrate-bundler-guides branch March 4, 2026 08:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants