Upgrade to Jekyll 3.0

Gemfile:

  - Upgrade to Jekyll 3.x (3.0.1 tested).  This brings several new
    features I want to use, most notably *collections* which allows us
    to add blog-like collections. I've converted the `_releases` and
    `_alerts` pages into collections, although their plugins are
    maintained to handle the Download and Active Alert features.

  - Upgrade to latest Kramdown.

  - Lock Less at 2.4.0.  This prevents breaking our Less plugin.  Jekyll
    3.x provides native support for SCSS, so we may want to switch to
    that in time.

  - Lock HTML Proofer at 2.1.0.  The most recent version was taking
    forever to check our pages (I never actually got it to complete).
    I'll look into it when I get more time.

Makefile:

  - New `make clean` command.  Jekyll 3.x by default attempts to do
    incremental rebuilds.  The new `jekyll clean` command cleans up the
    metadata necessary for than so that a full build is performed, and
    this new `make clean` command is a wrapper around it so that we
    automatically do full rebuilds in the relevant cases.  Note: our
    plugins aren't fully compatible with the incremental rebuilds, but
    I'd like to fix that in the future.

  - Remove WEBrick hack to enable previewing with default URL paths (/
    instead of /index.html).

  - Filter out compliants from Rouge

README.md:

  - Now that Alerts (_alerts) are part of a collection, the file names
    are no longer parsed for dates, so instructions on adding the date
    to the YAML metadata have been added.

_alerts/*:

  - Now that alerts are part of a collection, the file names are no
    longer parsed to provide dates, so a `date:` field has been added to
    the YAML metadata.

_config.yml:

  - Some variables renamed per upgrade instructions.

  - Switched from old default syntax highlighter Pygments to new default
    Rouge.  I tried to use Rouge options to keep new output as similar
    to old output as possible to making diffing easy, but Rouge adds
    extra CSS class info.

  - Move `_alerts` and `_releases` into Jekyll 3.x "collections", which
    provide the organizational features we were using plugins to
    manange.  I haven't removed the old plugins because we still use
    some of their features (alerts.rb provides active issue and banner
    features; releases.rb provides info to Download page)

  - _layouts/* can no longer provide default global metadata; that is now
    provided in the new `defaults:` section in _config.yml.

_layouts/*:

  - Default metadata can no longer be provided in the layout files for
    collections, so I've removed it and left a message to see
    _config.yml.

_plugins/*:

  - Remove filter_for.rb. It's completely broken on Jekyll 3.x because
    of changes to Liquid which prevent adding new arguments to the
    inherited Liquid::For class. Existing uses of filter_for have been
    migrated to built-in for loops prefaced by sorts.

  - Remove remove-html-extension.rb: at it said in the comments, this
    was a temporary hack to get us to Jekyll 3.0.

_releases/*:

  - Rename all the files: prefix a v to the file name so the output html
    (e.g. v10.0.0.html) is the same as the source filename (e.g.
    v10.0.0.md).  This is necessary to migrate them to a Jekyll collection.

  - Remove %v from titles: we have to explicitly set the title, like we
    used to.  Again required for migration to collections.

_templates/events.html & en/rss/events.rss:

  - Sort events by date and then loop with regular for loop rather than
    filter_for

en/alerts.html & en/rss/alerts.rss:

  - Sort alerts by date and then loop with regular for loop rather than
    filter_for

en/bitcoin-core/index.md & en/version-history.html & en/rss/releases.rss:

  - Sort alerts by date and then loop with regular for loop rather than
    filter_for

.gitignore

@@ -10,3 +10,4 @@ Thumbs.db
 .bundle
 vendor
 _cache
+.jekyll-metadata

Gemfile

@@ -16,10 +16,10 @@ group :development do
   gem 'ffi-icu'
   ## When we upgrade to Jekyll 3.0.0 or higher, remove
   ## _plugin/remove-html-extension.rb
-  gem 'jekyll', '~>1.3.0'
+  gem 'jekyll', '~>3.0'
   gem 'json'
-  gem 'less'
-  gem 'kramdown', '~>1.6.0'
+  gem 'less', '2.4.0'
+  gem 'kramdown'
   gem 'RedCloth'
   gem 'therubyracer' # required by less
   gem 'jshintrb', '~>0.3.0'
@@ -29,5 +29,5 @@ end
 ## you can put whatever you want here and bundler will tell us humans to
 ## install the new Gems.
 group :slow_test do
-  gem 'html-proofer'
+  gem 'html-proofer', '2.1.0'
 end

Gemfile.lock

@@ -2,22 +2,16 @@ GEM
   remote: https://rubygems.org/
   specs:
     RedCloth (4.2.9)
-    addressable (2.3.7)
-    classifier (1.3.3)
-      fast-stemmer (>= 1.0.0)
+    addressable (2.4.0)
     colorator (0.1)
     colored (1.2)
-    commander (4.1.5)
-      highline (~> 1.6.11)
     commonjs (0.2.7)
-    ethon (0.7.3)
+    ethon (0.8.0)
       ffi (>= 1.3.0)
     execjs (2.6.0)
-    fast-stemmer (1.0.2)
-    ffi (1.9.3)
-    ffi-icu (0.1.2)
+    ffi (1.9.10)
+    ffi-icu (0.1.10)
       ffi (~> 1.0, >= 1.0.9)
-    highline (1.6.20)
     html-proofer (2.1.0)
       addressable (~> 2.3)
       colored (~> 1.2)
@@ -26,58 +20,51 @@ GEM
       parallel (~> 1.3)
       typhoeus (~> 0.7)
       yell (~> 2.0)
-    jekyll (1.3.0)
-      classifier (~> 1.3)
+    jekyll (3.0.1)
       colorator (~> 0.1)
-      commander (~> 4.1.3)
-      liquid (~> 2.5.2)
-      listen (~> 1.3)
-      maruku (~> 0.6.0)
-      pygments.rb (~> 0.5.0)
-      redcarpet (~> 2.3.0)
-      safe_yaml (~> 0.9.7)
+      jekyll-sass-converter (~> 1.0)
+      jekyll-watch (~> 1.1)
+      kramdown (~> 1.3)
+      liquid (~> 3.0)
+      mercenary (~> 0.3.3)
+      rouge (~> 1.7)
+      safe_yaml (~> 1.0)
+    jekyll-sass-converter (1.4.0)
+      sass (~> 3.4)
+    jekyll-watch (1.3.0)
+      listen (~> 3.0)
     jshintrb (0.3.0)
       execjs
       multi_json (>= 1.3)
       rake
-    json (1.8.1)
-    kramdown (1.6.0)
+    json (1.8.3)
+    kramdown (1.9.0)
     less (2.4.0)
       commonjs (~> 0.2.7)
-    libv8 (3.16.14.3)
-    liquid (2.5.4)
-    listen (1.3.1)
+    libv8 (3.16.14.13)
+    liquid (3.0.6)
+    listen (3.0.5)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-      rb-kqueue (>= 0.2)
-    maruku (0.6.1)
-      syntax (>= 1.0.0)
     mercenary (0.3.5)
-    mini_portile (0.6.2)
+    mini_portile2 (2.0.0)
     multi_json (1.11.2)
-    nokogiri (1.6.6.2)
-      mini_portile (~> 0.6.0)
-    parallel (1.4.1)
-    posix-spawn (0.3.6)
-    pygments.rb (0.5.4)
-      posix-spawn (~> 0.3.6)
-      yajl-ruby (~> 1.1.0)
+    nokogiri (1.6.7.1)
+      mini_portile2 (~> 2.0.0.rc2)
+    parallel (1.6.1)
     rake (10.4.2)
-    rb-fsevent (0.9.3)
-    rb-inotify (0.9.2)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.5)
       ffi (>= 0.5.0)
-    rb-kqueue (0.2.0)
-      ffi (>= 0.5.0)
-    redcarpet (2.3.0)
-    ref (1.0.5)
-    safe_yaml (0.9.7)
-    syntax (1.0.0)
-    therubyracer (0.12.1)
+    ref (2.0.0)
+    rouge (1.10.1)
+    safe_yaml (1.0.4)
+    sass (3.4.20)
+    therubyracer (0.12.2)
       libv8 (~> 3.16.14.0)
       ref
-    typhoeus (0.7.1)
-      ethon (>= 0.7.1)
-    yajl-ruby (1.1.0)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
     yell (2.0.5)
 
 PLATFORMS
@@ -86,10 +73,10 @@ PLATFORMS
 DEPENDENCIES
   RedCloth
   ffi-icu
-  html-proofer
-  jekyll (~> 1.3.0)
+  html-proofer (= 2.1.0)
+  jekyll (~> 3.0)
   jshintrb (~> 0.3.0)
   json
-  kramdown (~> 1.6.0)
-  less
+  kramdown
+  less (= 2.4.0)
   therubyracer

Makefile

@@ -12,33 +12,34 @@ JEKYLL_LOG=._jekyll.log
 #######################
 
 ## `make` (no arguments): just build
-default: build
+default: clean build
 
 ## `make preview`: start the built-in Jekyll preview
-preview:
+preview: clean
 	$S bundle exec jekyll serve
 
 ## `make test`: don't build, but do run all tests
 test: pre-build-tests post-build-tests
 
 ## `make valid`: build and run fast tests
-valid: pre-build-tests-fast build post-build-tests-fast
+valid: clean pre-build-tests-fast build post-build-tests-fast
 
 ## `make all`: build and run all tests
-all: pre-build-tests build post-build-tests
+all: clean pre-build-tests build post-build-tests
 
 ## `make deployment`: for use on build server
-deployment: install-deps-deployment \
+deployment: clean install-deps-deployment \
     valid
 
 ## `make travis`: for use with Travis CI
-travis: travis-background-keepalive \
+travis: clean travis-background-keepalive \
     install-deps-development \
     all
 
 
 
 
+
 ## Install dependencies (development version)
 install-deps-development:
 	bundle install
@@ -95,6 +96,9 @@ manual-checks: manual-check-diff-sha256sums
 #################
 ERROR_ON_OUTPUT="sed '1s/^/ERROR:\n/' | if grep . ; then sed 1iERROR ; false ; else true ; fi"
 
+clean:
+	$S bundle exec jekyll clean
+
 ## Always build using the default locale so log messages can be grepped.
 ## This should not affect webpage output.
 build:
@@ -107,13 +111,9 @@ build:
 
 ## Jekyll annoyingly returns success even when it emits errors and
 ## exceptions, so we'll grep its output for error strings
-#
-## FIXME: temporarily ignoring errors from WEBrick because
-## _plugin/remove-html-extension does something hackish until we upgrade
-## to Jekyll 3.0.0
 check-for-build-errors:
 	$S egrep -i '(error|warn|exception)' $(JEKYLL_LOG) \
-	    | grep -vi webrick.*filehandler \
+	    | grep -vi 'rouge/lexers/shell.rb' \
 	    | eval $(ERROR_ON_OUTPUT)
 
 

README.md

@@ -592,6 +592,8 @@ coordination is usually conducted in #bitcoin-dev on Freenode.
     active: true
     ## Banner displayed if 'active: true'.  Can use HTML formatting
     banner: "<b>Chain fork</b> - Please stop mining on bitcoin version 0.8.0. Click here for more information."
+    ## Date of the alert in YYYY-MM-DD format
+    date: 2015-03-11
     ---
 
     {% comment %}

_alerts/2012-02-18-protocol-change.html

@@ -3,6 +3,7 @@
 shorturl: "feb20"
 active: false
 banner: ""
+date: 2012-02-18
 ---
 <p>
 In June 2010 the Bitcoin reference software version 0.2.10 introduced

_alerts/2012-03-16-critical-vulnerability.html

@@ -3,6 +3,7 @@
 shorturl: "critfix"
 active: false
 banner: ""
+date: 2012-03-16
 ---
 <p>
 A potential security vulnerability has been discovered in the Windows

_alerts/2012-05-14-dos.html

@@ -3,6 +3,7 @@
 shorturl: "dos"
 active: false
 banner: ""
+date: 2012-05-14
 ---
         <h2 id="risks">Risks</h2>
 <p>

_alerts/2013-03-11-chain-fork.html

@@ -3,6 +3,7 @@
 shorturl: "chainfork"
 active: false
 banner: ""
+date: 2013-03-11
 ---
         <h2 id="what-happened">What happened</h2>
 <p>

_alerts/2013-03-15-upgrade-deadline.html

@@ -3,6 +3,7 @@
 shorturl: "may15"
 active: false
 banner: ""
+date: 2013-03-15
 ---
         <h2 id="what-is-happening">What is happening</h2>
 <p>

_alerts/2013-08-11-android.html

@@ -3,6 +3,7 @@
 active: false
 shorturl: "android"
 banner: ""
+date: 2013-08-11
 ---
 
 <h2 id="what-happened">What happened</h2>

_alerts/2014-02-11-malleability.html

@@ -2,6 +2,7 @@
 title: "Transaction malleability"
 active: false
 banner: ""
+date: 2014-02-11
 ---
 
 <h2 id="what-happened">What happened</h2>

_alerts/2014-04-11-heartbleed.html

@@ -3,6 +3,7 @@
 shorturl: "heartbleed"
 active: false
 banner: ""
+date: 2014-04-11
 ---
 
 <h2 id="what-happened">What happened</h2>

_alerts/2015-07-04-spv-mining.md

@@ -5,6 +5,7 @@
 title: "Some Miners Generating Invalid Blocks"
 shorturl: "spv-mining"
 active: false
+date: 2015-07-04
 #banner: "WARNING: many wallets currently vulnerable to double-spending of confirmed transactions (click here to read)"
 bannerclass: "alert"
 ---

_config.yml

@@ -176,7 +176,7 @@ baseurl:    /
 
 source:      .
 destination: ./_site
-plugins:     ./_plugins
+plugins_dir: ./_plugins
 exclude:
     - Gemfile
     - Gemfile.lock
@@ -185,10 +185,9 @@ exclude:
 
 future:      true
 lsi:         false
-highlighter: rouge
-pygments:    true
 markdown:    kramdown
 permalink:   date
+excerpt_separator: "<!-- END_EXCERPT -->"
 
 rdiscount:
   extensions: []
@@ -198,7 +197,15 @@ kramdown:
   footnote_nr: 1
   entity_output: as_char
   toc_levels: 2..6
-  use_coderay: false
+  enable_coderay: false
+  syntax_highlighter: rouge
+  syntax_highlighter_opts:
+    ## With the 'text' option, no highlighting is applied by default. We
+    ## need this for backwards compatibility with existing code blocks.
+    default_lang: text
+
+    ## Might be useful in the future, but turn off for upgrade to Jekyll 3.0
+    css_class:
 
   coderay:
     coderay_wrap: div
@@ -505,3 +512,37 @@ devsearches:
     - "tx": "/en/developer-reference#tx"
     - "verack": "/en/developer-reference#verack"
     - "version": "/en/developer-reference#version"
+
+collections:
+  ## _alerts
+  alerts:
+    output: true
+    permalink: /en/alert/:path
+  ## _releases
+  releases:
+    output: true
+    permalink: /en/release/:path
+
+defaults:
+  - scope:
+      path: ""
+      type: alerts
+    values:
+      layout: alert
+      lang: en
+  - scope:
+      path: ""
+      type: releases
+    values:
+      layout: release
+      lang: en
+      breadcrumbs:
+        - bitcoin
+        - bcc
+        - bcc news
+        - RELEASE
+  - scope:
+      path: ""
+      type: posts
+    values:
+      lang: en

_layouts/alert.html

@@ -3,7 +3,7 @@
 # http://opensource.org/licenses/MIT.
 
 layout: base
-lang: en
+## Note: global variables like page.lang must be set in _config.yml for collections
 ---
 {% if page.canonical != nil %}
 <script>window.location.href='{{ page.canonical }}';</script>