Skip to content

Commit

Permalink
working setup for windows, improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
emilybache committed Jan 21, 2025
1 parent 9683076 commit 4ae5cda
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 104 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ _site
.jekyll-cache
credentials.txt
.idea
Gemfile.lock
5 changes: 4 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -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"
102 changes: 0 additions & 102 deletions Gemfile.lock

This file was deleted.

13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4ae5cda

Please sign in to comment.