From 4ae5cda9f443c91743fb0fd6ed14e1c1665f268b Mon Sep 17 00:00:00 2001 From: Emily Bache Date: Tue, 21 Jan 2025 12:01:42 +0000 Subject: [PATCH] working setup for windows, improve docs --- .gitignore | 1 + Gemfile | 5 ++- Gemfile.lock | 102 --------------------------------------------------- README.md | 13 ++++++- 4 files changed, 17 insertions(+), 104 deletions(-) delete mode 100644 Gemfile.lock diff --git a/.gitignore b/.gitignore index 13e9110..28ae6b4 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ _site .jekyll-cache credentials.txt .idea +Gemfile.lock diff --git a/Gemfile b/Gemfile index c099a2e..0fe96fc 100644 --- a/Gemfile +++ b/Gemfile @@ -29,7 +29,10 @@ end gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby] # Performance-booster for watching directories on Windows -gem "wdm", "~> 0.1.0" if Gem.win_platform? +gem "wdm", "~> 0.2.0" if Gem.win_platform? + +# needed to fix https://github.com/apache/arrow-site/issues/447 +gem "logger" # check for broken links gem "html-proofer" diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index b2274d2..0000000 --- a/Gemfile.lock +++ /dev/null @@ -1,102 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - addressable (2.8.6) - public_suffix (>= 2.0.2, < 6.0) - colorator (1.1.0) - concurrent-ruby (1.2.3) - em-websocket (0.5.3) - eventmachine (>= 0.12.9) - http_parser.rb (~> 0) - ethon (0.16.0) - ffi (>= 1.15.0) - eventmachine (1.2.7) - ffi (1.16.3) - forwardable-extended (2.6.0) - html-proofer (4.4.3) - addressable (~> 2.3) - mercenary (~> 0.3) - nokogiri (~> 1.13) - parallel (~> 1.10) - rainbow (~> 3.0) - typhoeus (~> 1.3) - yell (~> 2.0) - zeitwerk (~> 2.5) - http_parser.rb (0.8.0) - i18n (1.14.1) - concurrent-ruby (~> 1.0) - jekyll (4.2.2) - addressable (~> 2.4) - colorator (~> 1.0) - em-websocket (~> 0.5) - i18n (~> 1.0) - jekyll-sass-converter (~> 2.0) - jekyll-watch (~> 2.0) - kramdown (~> 2.3) - kramdown-parser-gfm (~> 1.0) - liquid (~> 4.0) - mercenary (~> 0.4.0) - pathutil (~> 0.9) - rouge (~> 3.0) - safe_yaml (~> 1.0) - terminal-table (~> 2.0) - jekyll-feed (0.17.0) - jekyll (>= 3.7, < 5.0) - jekyll-sass-converter (2.2.0) - sassc (> 2.0.1, < 3.0) - jekyll-seo-tag (2.8.0) - jekyll (>= 3.8, < 5.0) - jekyll-sitemap (1.4.0) - jekyll (>= 3.7, < 5.0) - jekyll-watch (2.2.1) - listen (~> 3.0) - kramdown (2.4.0) - rexml - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) - liquid (4.0.4) - listen (3.8.0) - rb-fsevent (~> 0.10, >= 0.10.3) - rb-inotify (~> 0.9, >= 0.9.10) - mercenary (0.4.0) - mini_portile2 (2.8.5) - nokogiri (1.16.2) - mini_portile2 (~> 2.8.2) - racc (~> 1.4) - parallel (1.24.0) - pathutil (0.16.2) - forwardable-extended (~> 2.6) - public_suffix (5.0.4) - racc (1.7.3) - rainbow (3.1.1) - rb-fsevent (0.11.2) - rb-inotify (0.10.1) - ffi (~> 1.0) - rexml (3.2.6) - rouge (3.30.0) - safe_yaml (1.0.5) - sassc (2.4.0) - ffi (~> 1.9) - terminal-table (2.0.0) - unicode-display_width (~> 1.1, >= 1.1.1) - typhoeus (1.4.1) - ethon (>= 0.9.0) - unicode-display_width (1.8.0) - webrick (1.8.1) - yell (2.2.2) - zeitwerk (2.6.13) - -PLATFORMS - ruby - -DEPENDENCIES - html-proofer - jekyll (~> 4.2.0) - jekyll-feed (~> 0.6) - jekyll-seo-tag - jekyll-sitemap - tzinfo-data - webrick - -BUNDLED WITH - 2.2.3 diff --git a/README.md b/README.md index 49248ba..6d23653 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,22 @@ Teaching materials for Technical Agile Coaches This repo contains the sourcecode for [sammancoaching.org](sammancoaching.org) which is designed to provide resources for technical agile coaches to use in their work. For more information, please read this book [Technical Agile Coaching](https://leanpub.com/techagilecoach) by Emily Bache. This site is maintained by the members of the [Samman Technical Coaching Society](https://sammancoaching.org/society/index.html). ## Development +You can either run jekyll natively on your platform, or use docker. -To test locally: +### Native Jekyll +First install Ruby, which includes the utility 'bundler'. Use Bundler in the same folder as this README to get all the dependencies: + + bundle install + +Note this will use the Gemfile and will create a Gemfile.lock itemizing all the versions of your gems. I found a problem installing wdm that was fixed by using this workaround 'gem install wdm -- --with-cflags=-Wno-implicit-function-declaration' + +Then launch the jekyll application locally, again using bundler: bundle exec jekyll serve +Launch your local site: [http://127.0.0.1:4000/](http://127.0.0.1:4000/) + +### Using Docker Instead of using jekyll locally you can get a prebuilt docker image with Ruby, Jekyll etc. installed: dockerinit