Add Dev Container

[bethmaloney]

Add Dev Container support to simplify initial setup.

I'm using Ruby 3.2 as 3.3 is throwing an error undefined method []' for nil (NoMethodError) when I try to run bundle exec jekyll serve. I also had to add webrick to GemFile to prevent an error when using Ruby 3.x. The Ruby LSP is also throwing an error but I don't think there's actually much ruby in this project so I might look at what's causing that error later (unless someone else can sort it out).

I'm far from a ruby expert so let me know if any of the versions, etc are wrong and I'll fix them. I have to admit this took longer then I expected to get running.

[fredericDelaporte]

I do not know if any NHibernate contributor is much knowledgeable about Ruby. I just know it was not running for me under Windows. Instead, I test it with a Linux VM (Debian running with VirtualBox), and have no issue with it.

Since this project is only meant for running as a GitHub page, doing some Microsoft related changes in it does not look sound to me.

[bethmaloney]

Hi @fredericDelaporte,

Sorry that's my fault for not explaining the rationale for adding Dev Containers to this project. Dev Containers are a way of using containers to setup a development environment for you. They're usable in both windows (WSL2) and Linux and while primarily supported by VS Code and GitHub other editors such as IntelliJ are adding support.

When I first tried to get the project running locally I wasn't sure what OS or Ruby versions were supported or honestly even how to install (I'm not a Ruby dev). And to be honest I didn't really want to install Ruby for just this project. By using Dev Containers the Ruby version and OS are fixed and the Bundler version is automatically updated to the correct version. This makes it easier for new contributors as they only need to launch the dev container and all of the dependencies are taken care of.

If you'd like to test this without installing WSL2/Docker Desktop you can run it straight from your browser using GitHub. Navigate to the branch on my repo and select code -> Create Codespace. GitHub provides all users with a few hundred minutes of Code Space for free so you should be fine to test it out. You'll note that you can restore the Gems and launch the documentation server from the editor in your browser. The experience locally is very similiar.

The configuration will use the docker image at https://hub.docker.com/_/microsoft-devcontainers-ruby. Specifically Debian Bookworm with Ruby 3.2.

I'll note that many popular projects use Dev Containers to improve the on-boarding experience including:

• Playwright
• TypeScript
• Jekyll

My aim with this PR is to make it as simple as possible to run the doc server locally and contribute to this repo.