From fd1871eb7da7c19ff2da354b3c899012258617db Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Sun, 6 Feb 2022 19:32:23 -0800 Subject: [PATCH 1/4] readme: link to further docker details --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b392275293..d8a98bbc20 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,13 @@ For more details, read on. ## Quickstart with Docker ## -To build and view site with docker: +To build and view site with Docker: docker-compose up -It will incrementally build and serve site at `http://localhost:4000` +It will incrementally build and serve site at `http://localhost:4000`. + +For more details on the Docker option, see [this issue](https://github.com/scala/docs.scala-lang/issues/1286). ## Contributing ## From aca3aa817996b5d4ec9cc33d388c55c45bda203e Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Sun, 6 Feb 2022 19:51:31 -0800 Subject: [PATCH 2/4] recommend installing gems locally not globally --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index d8a98bbc20..a6283b2386 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,7 @@ This repository contains the source for the Scala documentation website, as well To build and view the site locally: - gem install bundler - bundle install + gem install --user-install bundler jekyll bundle exec jekyll serve -I ([Trouble on MacOS?](https://github.com/scala/docs.scala-lang/issues/1150)) From 30c73d5ef0cd53d1dd11211d4fd73545dbf82c1a Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Sun, 6 Feb 2022 19:52:33 -0800 Subject: [PATCH 3/4] use modern bundler version --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 6b8f07e6a6..c19b452bb9 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -91,4 +91,4 @@ DEPENDENCIES kramdown-parser-gfm BUNDLED WITH - 1.17.2 + 2.3.6 From e27b9ed9bcf61f8d819197b46c981e5834532fcf Mon Sep 17 00:00:00 2001 From: Seth Tisue Date: Sun, 6 Feb 2022 19:54:45 -0800 Subject: [PATCH 4/4] add webrick to gemfile as recommended by https://www.earthinversion.com/blogging/how-to-install-jekyll-on-appple-m1-macbook/ --- Gemfile | 2 ++ Gemfile.lock | 2 ++ 2 files changed, 4 insertions(+) diff --git a/Gemfile b/Gemfile index 26b5aee372..2152cdafa4 100644 --- a/Gemfile +++ b/Gemfile @@ -13,3 +13,5 @@ gem 'kramdown-parser-gfm' # browser during development. To use, uncomment # and do: # bundle exec jekyll liveserve --incremental + +gem "webrick", "~> 1.7" diff --git a/Gemfile.lock b/Gemfile.lock index c19b452bb9..0bbe4414f9 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -79,6 +79,7 @@ GEM rb-inotify (~> 0.9, >= 0.9.7) typhoeus (1.4.0) ethon (>= 0.9.0) + webrick (1.7.0) yell (2.2.2) PLATFORMS @@ -89,6 +90,7 @@ DEPENDENCIES jekyll-redirect-from jekyll-scalafiddle kramdown-parser-gfm + webrick (~> 1.7) BUNDLED WITH 2.3.6