Merge pull request #28 from l-mb/main

Adding HTMLProofer to Travis build
aquarist-labs · Apr 23, 2021 · 71bf75f · 71bf75f
2 parents a75d5b2 + 6cbea14
commit 71bf75f
Show file tree

Hide file tree

Showing 9 changed files with 67 additions and 23 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,25 @@
 language: ruby
 rvm:
-- 2.3
-script: bundle exec jekyll build
+- 2.7
+script:
+  - bundle exec jekyll build
+  - bundle exec rake test
+
+cache:
+  directories:
+  - $TRAVIS_BUILD_DIR/tmp/.htmlproofer #https://github.com/gjtorikian/html-proofer/issues/381
+
+env:
+  global:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true # speeds up installation of html-proofer
+
+addons:
+  apt:
+    packages:
+    - libcurl4-openssl-dev # required to avoid SSL errors
+
+sudo: false
+
 deploy:
   provider: pages
   skip_cleanup: true

diff --git a/FAQ.md b/FAQ.md
@@ -42,7 +42,7 @@ it's still Ceph underneath.
 **A:** Look at the [issue](https://github.com/aquarist-labs/aquarium/issues) list or
 check out our Slack channel (see below) and ask one of the friendly contributors.
 You can also view our [project board](https://github.com/orgs/aquarist-labs/projects/3)
-and check our [Review Guidelines](CONTRIBUTING.md).
+and check our [Review Guidelines](https://github.com/aquarist-labs/aquarium/blob/main/CONTRIBUTING.md).
 
 If you want to get your hands dirty as soon as possible, you can also run the
 script at `tools/setup-dev.sh`. This will ensure you have a basic development

diff --git a/Gemfile b/Gemfile
@@ -18,3 +18,7 @@ group :jekyll_plugins do
   gem "kramdown", ">= 2.3.0"
   gem "rake"
 end
+
+group :test do
+  gem 'html-proofer'
+end
diff --git a/LICENSE.md b/LICENSE.md
@@ -11,6 +11,6 @@ This work is licensed under a
 
 [![CC BY-SA 4.0][cc-by-sa-image]][cc-by-sa]
 
-[cc-by-sa]: http://creativecommons.org/licenses/by-sa/4.0/
+[cc-by-sa]: https://creativecommons.org/licenses/by-sa/4.0/
 [cc-by-sa-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png
 [cc-by-sa-shield]: https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1,34 @@
+abort('Please run this using `bundle exec rake`') unless ENV["BUNDLE_BIN_PATH"]
+require 'html-proofer'
+
+desc "Test the website"
+task :test do
+  sh "bundle exec jekyll build"
+  options = {
+    :check_sri => true,
+    :check_external_hash => true,
+    :check_favicon => false,
+    :check_html => true,
+    :check_img_http => true,
+    :check_opengraph => true,
+    :enforce_https => true,
+    :cache => {
+      :timeframe => '6w'
+    },
+    :validation => { 
+      :report_eof_tags => true,
+      :report_invalid_tags => true,
+      :report_mismatched_tags => true,
+      :report_missing_doctype => true,
+      :report_missing_names => true,
+      :report_script_embeds => true
+    }
+  }
+  begin
+    HTMLProofer.check_directory("_site/", options).run
+  rescue => msg
+    puts "#{msg}"
+  end
+end
+
+task :default => [:test]
diff --git a/_config.yml b/_config.yml
@@ -23,6 +23,11 @@ header_pages:
   - FAQ.md
   - LICENSE.md
 
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - Rakefile
+
 collections:
   minutes:
     output: true
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -1,22 +1,5 @@
 <!DOCTYPE html>
 <html lang="{{ page.lang | default: site.lang | default: "en" }}">
-  <head>
-    <style>
-      {
-        box-sizing: border-box;
-      }
-      /* Set additional styling options for the columns*/
-      .column {
-        float: left;
-        width: 50%;
-      }
-      .row:after {
-        content: "";
-        display: table;
-        clear: both;
-      }
-    </style>
-  </head>
   {%- include head.html -%}
 
   <body>

diff --git a/_posts/2021-04-19-hello-world-blog.md b/_posts/2021-04-19-hello-world-blog.md
@@ -12,7 +12,7 @@ Welcome to Aquarium!
 If you want to get involved, look at the [issue](https://github.com/aquarist-labs/aquarium/issues) list or
 check out our Slack channel (see below) and ask one of the friendly contributors.
 You can also view our [project board](https://github.com/orgs/aquarist-labs/projects/3)
-and check our [Review Guidelines](CONTRIBUTING.md).
+and check our [Review Guidelines](https://github.com/aquarist-labs/aquarium/blob/main/CONTRIBUTING.md).
 
 If you want to get your hands dirty as soon as possible, you can also run the
 script at `tools/setup-dev.sh`. This will ensure you have a basic development

diff --git a/index.md b/index.md
@@ -8,7 +8,7 @@ list_title: "Blogs"
 
 Aquarium is a [SUSE](https://suse.com/)-sponsored Open Source
 project to build an easy-to-use, rock-solid appliance wrapped around the
-[Ceph](http://ceph.io) project. The project started development in January 2021,
+[Ceph](https://ceph.io) project. The project started development in January 2021,
 and has become a passion project for the storage team at SUSE.
 
 We are investigating the beginnings of a new storage appliance project in