Ss/gh pages edit (#113)

* editing gh-pages site to be less disappointing * Made the metronome gh-pages site more accurate
dcos · Dec 14, 2016 · a65c719 · a65c719
1 parent 6abc7db
commit a65c719
Show file tree

Hide file tree

Showing 9 changed files with 156 additions and 106 deletions.
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+gem 'github-pages', group: :jekyll_plugins
 
 # Jekyll
 gem "jekyll"

diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
@@ -1,79 +1,174 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    RedCloth (4.2.9)
-    blankslate (2.1.2.4)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    classifier-reborn (2.0.3)
-      fast-stemmer (~> 1.0)
+    RedCloth (4.3.2)
+    activesupport (4.2.7)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
-    coffee-script-source (1.9.1.1)
-    colorator (0.1)
-    execjs (2.5.2)
-    fast-stemmer (1.0.2)
-    ffi (1.9.10)
-    hitimes (1.2.2)
-    jekyll (2.5.3)
-      classifier-reborn (~> 2.0)
-      colorator (~> 0.1)
-      jekyll-coffeescript (~> 1.0)
-      jekyll-gist (~> 1.0)
-      jekyll-paginate (~> 1.0)
+    coffee-script-source (1.11.1)
+    colorator (1.1.0)
+    ethon (0.10.1)
+      ffi (>= 1.3.0)
+    execjs (2.7.0)
+    faraday (0.10.0)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.14)
+    forwardable-extended (2.6.0)
+    gemoji (2.1.0)
+    github-pages (109)
+      activesupport (= 4.2.7)
+      github-pages-health-check (= 1.3.0)
+      jekyll (= 3.3.1)
+      jekyll-avatar (= 0.4.2)
+      jekyll-coffeescript (= 1.0.1)
+      jekyll-default-layout (= 0.1.4)
+      jekyll-feed (= 0.8.0)
+      jekyll-gist (= 1.4.0)
+      jekyll-github-metadata (= 2.2.0)
+      jekyll-mentions (= 1.2.0)
+      jekyll-optional-front-matter (= 0.1.2)
+      jekyll-paginate (= 1.1.0)
+      jekyll-readme-index (= 0.0.3)
+      jekyll-redirect-from (= 0.11.0)
+      jekyll-relative-links (= 0.2.1)
+      jekyll-sass-converter (= 1.3.0)
+      jekyll-seo-tag (= 2.1.0)
+      jekyll-sitemap (= 0.12.0)
+      jekyll-swiss (= 0.4.0)
+      jekyll-theme-primer (= 0.1.1)
+      jekyll-titles-from-headings (= 0.1.2)
+      jemoji (= 0.7.0)
+      kramdown (= 1.11.1)
+      liquid (= 3.0.6)
+      listen (= 3.0.6)
+      mercenary (~> 0.3)
+      minima (= 2.0.0)
+      rouge (= 1.11.1)
+      terminal-table (~> 1.4)
+    github-pages-health-check (1.3.0)
+      addressable (~> 2.3)
+      net-dns (~> 0.8)
+      octokit (~> 4.0)
+      public_suffix (~> 2.0)
+      typhoeus (~> 0.7)
+    html-pipeline (2.4.2)
+      activesupport (>= 2)
+      nokogiri (>= 1.4)
+    i18n (0.7.0)
+    jekyll (3.3.1)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
       jekyll-sass-converter (~> 1.0)
       jekyll-watch (~> 1.1)
       kramdown (~> 1.3)
-      liquid (~> 2.6.1)
+      liquid (~> 3.0)
       mercenary (~> 0.3.3)
-      pygments.rb (~> 0.6.0)
-      redcarpet (~> 3.1)
+      pathutil (~> 0.9)
+      rouge (~> 1.7)
       safe_yaml (~> 1.0)
-      toml (~> 0.1.0)
+    jekyll-avatar (0.4.2)
+      jekyll (~> 3.0)
     jekyll-coffeescript (1.0.1)
       coffee-script (~> 2.2)
-    jekyll-gist (1.2.1)
+    jekyll-default-layout (0.1.4)
+      jekyll (~> 3.0)
+    jekyll-feed (0.8.0)
+      jekyll (~> 3.3)
+    jekyll-gist (1.4.0)
+      octokit (~> 4.2)
+    jekyll-github-metadata (2.2.0)
+      jekyll (~> 3.1)
+      octokit (~> 4.0, != 4.4.0)
+    jekyll-mentions (1.2.0)
+      activesupport (~> 4.0)
+      html-pipeline (~> 2.3)
+      jekyll (~> 3.0)
+    jekyll-optional-front-matter (0.1.2)
+      jekyll (~> 3.0)
     jekyll-paginate (1.1.0)
-    jekyll-redirect-from (0.8.0)
+    jekyll-readme-index (0.0.3)
+      jekyll (~> 3.0)
+    jekyll-redirect-from (0.11.0)
       jekyll (>= 2.0)
+    jekyll-relative-links (0.2.1)
+      jekyll (~> 3.3)
     jekyll-sass-converter (1.3.0)
       sass (~> 3.2)
-    jekyll-sitemap (0.8.1)
-    jekyll-watch (1.2.1)
-      listen (~> 2.7)
-    kramdown (1.8.0)
-    liquid (2.6.2)
-    listen (2.10.1)
-      celluloid (~> 0.16.0)
+    jekyll-seo-tag (2.1.0)
+      jekyll (~> 3.3)
+    jekyll-sitemap (0.12.0)
+      jekyll (~> 3.3)
+    jekyll-swiss (0.4.0)
+    jekyll-theme-primer (0.1.1)
+      jekyll (~> 3.3)
+    jekyll-titles-from-headings (0.1.2)
+      jekyll (~> 3.3)
+    jekyll-watch (1.5.0)
+      listen (~> 3.0, < 3.1)
+    jemoji (0.7.0)
+      activesupport (~> 4.0)
+      gemoji (~> 2.0)
+      html-pipeline (~> 2.2)
+      jekyll (>= 3.0)
+    json (1.8.3)
+    kramdown (1.11.1)
+    liquid (3.0.6)
+    listen (3.0.6)
       rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
+      rb-inotify (>= 0.9.7)
     maruku (0.7.2)
-    mercenary (0.3.5)
-    parslet (1.5.0)
-      blankslate (~> 2.0)
-    posix-spawn (0.3.11)
-    pygments.rb (0.6.3)
+    mercenary (0.3.6)
+    mini_portile2 (2.1.0)
+    minima (2.0.0)
+    minitest (5.10.1)
+    multipart-post (2.0.0)
+    net-dns (0.8.0)
+    nokogiri (1.6.8.1)
+      mini_portile2 (~> 2.1.0)
+    octokit (4.6.2)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    pathutil (0.14.0)
+      forwardable-extended (~> 2.6)
+    posix-spawn (0.3.12)
+    public_suffix (2.0.4)
+    pygments.rb (1.0.0)
       posix-spawn (~> 0.3.6)
-      yajl-ruby (~> 1.2.0)
-    rb-fsevent (0.9.5)
-    rb-inotify (0.9.5)
+      yajl-ruby (~> 1.2)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.7)
       ffi (>= 0.5.0)
-    rdiscount (2.1.8)
-    redcarpet (3.3.2)
+    rdiscount (2.2.0.1)
+    redcarpet (3.3.4)
+    rouge (1.11.1)
     safe_yaml (1.0.4)
-    sass (3.4.16)
-    timers (4.0.1)
-      hitimes
-    toml (0.1.2)
-      parslet (~> 1.5.0)
-    yajl-ruby (1.2.1)
+    sass (3.4.22)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
+    thread_safe (0.3.5)
+    typhoeus (0.8.0)
+      ethon (>= 0.8.0)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.1.2)
+    yajl-ruby (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   RedCloth
+  github-pages
   jekyll
   jekyll-coffeescript
   jekyll-redirect-from
@@ -85,3 +180,6 @@ DEPENDENCIES
   pygments.rb
   rdiscount
   redcarpet
+
+BUNDLED WITH
+   1.13.6
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -37,9 +37,6 @@
                   <li {% if page.tab == "docs" %}class="active"{% endif %}>
                     <a href="{{ site.baseurl }}/docs/">Docs</a>
                   </li>
-                  <li {% if page.tab == "resources" %}class="active"{% endif %}>
-                    <a href="{{ site.baseurl }}/resources.html">Resources</a>
-                  </li>
                   <li {% if page.tab == "support" %}class="active"{% endif %}>
                     <a href="{{ site.baseurl }}/support.html">Support</a>
                   </li>

diff --git a/docs/_layouts/docs.html b/docs/_layouts/docs.html
@@ -5,13 +5,6 @@
 <div class="row">
     <div class="col-sm-3">
 
-        <h5>Welcome</h5>
-        <ul class="list-unstyled">
-            <li><a href="{{ site.baseurl }}/docs/"> Overview </a></li>
-            <li><a href="{{ site.baseurl }}/docs/getting_started.html"> Getting Started </a></li>
-            <li><a href="{{ site.baseurl }}/docs/recipes.html">Recipes</a></li>
-        </ul>
-
         <h5>Development</h5>
         <ul class="list-unstyled">
             <li><a href="{{ site.baseurl }}/docs/contributing.html">Contributor Guidelines</a></li>

diff --git a/docs/docs/getting_started.md b/docs/docs/getting_started.md
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -2,7 +2,8 @@
 title: Metronome
 ---
 
-# Overview
+# Metronome
 
+This site includes only contributor guidelines and the REST API reference.
 
-_Coming soon ..._
+View the full documentation in the Jobs section of the [the DC/OS documentation site](https://dcos.io/docs/1.8/usage/jobs/).
diff --git a/docs/docs/recipes.md b/docs/docs/recipes.md
diff --git a/docs/index.md b/docs/index.md
@@ -9,9 +9,12 @@ title: Cron Service for DC/OS
   </p>
 </div>
 
-## Overview
+## Documentation
+Metronome documentation lives on the [DC/OS docs site](https://dcos.io/docs/1.8/usage/jobs/).
 
-## Features
+## Contributing
+Learn how to [contribute to the Metronome project]({{ site.baseurl }}/docs/contributing.html).
 
-## Examples
+## API Reference
+Use the [Metronome REST API]({{ site.baseurl }}/docs/generated/api.html)
 
diff --git a/docs/resources.md b/docs/resources.md