Fix/re-introduce custom Jekyll tags for better glossary integration (k…

…ubernetes#6163)
kow3ns · Nov 6, 2017 · 53cf7de · 53cf7de
1 parent 0abbfdc
commit 53cf7de
Show file tree

Hide file tree

Showing 52 changed files with 546 additions and 225 deletions.
diff --git a/Gemfile b/Gemfile
@@ -1,4 +1,53 @@
 source "https://rubygems.org"
 
-gem "github-pages", group: :jekyll_plugins
+# gem "github-pages", group: :jekyll_plugins
+
+gem "jekyll", "3.6.0"
+
+group :github_pages_compatible do
+    gem "json", "~> 1.7", ">= 1.7.7"
+    gem "coffee-script", "~> 2.4"
+    gem "coffee-script-source", "~> 1.12"
+    gem "ethon", "~> 0.10"
+    gem "execjs", "~> 2.7"
+    gem "minima", "~> 2.0"
+    gem "terminal-table", "~> 1.4"
+    gem "unicode-display_width", "~> 1.1"
+end
+
+group :jekyll_plugins do
+   gem "jekyll-feed", "~> 0.6"
+   gem "jekyll-sitemap"
+   gem "jekyll-gist"
+   gem "jekyll-paginate", "1.1.0"
+   gem "jekyll-seo-tag"
+   gem "jekyll-avatar", "~> 0.4"
+   gem "jekyll-coffeescript", "~> 1.0"
+   gem "jekyll-default-layout", "~> 0.1"
+   gem "jekyll-github-metadata", "~> 2.2"
+   gem "jekyll-optional-front-matter", "~> 0.1"
+   gem "jekyll-readme-index", "0.0.3"
+   gem "jekyll-redirect-from", "~> 0.11"
+   gem "jekyll-relative-links", "~> 0.2"
+   gem "jekyll-swiss", "~> 0.4"
+   gem "jekyll-theme-architect", "0.0.3"
+   gem "jekyll-theme-cayman", "0.0.3"
+   gem "jekyll-theme-dinky", "0.0.3"
+   gem "jekyll-theme-hacker", "0.0.3"
+   gem "jekyll-theme-leap-day", "0.0.3"
+   gem "jekyll-theme-merlot", "0.0.3"
+   gem "jekyll-theme-midnight", "0.0.3"
+   gem "jekyll-theme-minimal", "0.0.3"
+   gem "jekyll-theme-modernist", "0.0.3"
+   gem "jekyll-theme-primer", "~> 0.1"
+   gem "jekyll-theme-slate", "0.0.3"
+   gem "jekyll-theme-tactile", "0.0.3"
+   gem "jekyll-theme-time-machine", "0.0.3"
+   gem "jekyll-titles-from-headings", "~> 0.1"
+end
+
 gem "jekyll-include-cache", "~> 0.1"
+
+gem "kramdown", "~> 1.11"
+gem "rouge", "~> 2.0"
+gem "pry"
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,123 +1,61 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    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)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.12.2)
     colorator (1.1.0)
-    ethon (0.10.1)
+    ethon (0.11.0)
       ffi (>= 1.3.0)
     execjs (2.7.0)
-    faraday (0.10.0)
+    faraday (0.13.1)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.14)
+    ffi (1.9.18)
     forwardable-extended (2.6.0)
-    gemoji (2.1.0)
-    github-pages (112)
-      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-architect (= 0.0.3)
-      jekyll-theme-cayman (= 0.0.3)
-      jekyll-theme-dinky (= 0.0.3)
-      jekyll-theme-hacker (= 0.0.3)
-      jekyll-theme-leap-day (= 0.0.3)
-      jekyll-theme-merlot (= 0.0.3)
-      jekyll-theme-midnight (= 0.0.3)
-      jekyll-theme-minimal (= 0.0.3)
-      jekyll-theme-modernist (= 0.0.3)
-      jekyll-theme-primer (= 0.1.5)
-      jekyll-theme-slate (= 0.0.3)
-      jekyll-theme-tactile (= 0.0.3)
-      jekyll-theme-time-machine (= 0.0.3)
-      jekyll-titles-from-headings (= 0.1.3)
-      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)
+    jekyll (3.6.0)
       addressable (~> 2.4)
       colorator (~> 1.0)
       jekyll-sass-converter (~> 1.0)
       jekyll-watch (~> 1.1)
-      kramdown (~> 1.3)
-      liquid (~> 3.0)
+      kramdown (~> 1.14)
+      liquid (~> 4.0)
       mercenary (~> 0.3.3)
       pathutil (~> 0.9)
-      rouge (~> 1.7)
+      rouge (>= 1.7, < 3)
       safe_yaml (~> 1.0)
-    jekyll-avatar (0.4.2)
+    jekyll-avatar (0.5.0)
       jekyll (~> 3.0)
     jekyll-coffeescript (1.0.1)
       coffee-script (~> 2.2)
     jekyll-default-layout (0.1.4)
       jekyll (~> 3.0)
-    jekyll-feed (0.8.0)
+    jekyll-feed (0.9.2)
       jekyll (~> 3.3)
-    jekyll-gist (1.4.0)
+    jekyll-gist (1.4.1)
       octokit (~> 4.2)
-    jekyll-github-metadata (2.2.0)
+    jekyll-github-metadata (2.9.3)
       jekyll (~> 3.1)
       octokit (~> 4.0, != 4.4.0)
     jekyll-include-cache (0.1.0)
       jekyll (~> 3.3)
-    jekyll-mentions (1.2.0)
-      activesupport (~> 4.0)
-      html-pipeline (~> 2.3)
-      jekyll (~> 3.0)
-    jekyll-optional-front-matter (0.1.2)
+    jekyll-optional-front-matter (0.3.0)
       jekyll (~> 3.0)
     jekyll-paginate (1.1.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-redirect-from (0.12.1)
+      jekyll (~> 3.3)
+    jekyll-relative-links (0.5.1)
       jekyll (~> 3.3)
-    jekyll-sass-converter (1.3.0)
-      sass (~> 3.2)
-    jekyll-seo-tag (2.1.0)
+    jekyll-sass-converter (1.5.0)
+      sass (~> 3.4)
+    jekyll-seo-tag (2.3.0)
       jekyll (~> 3.3)
-    jekyll-sitemap (0.12.0)
+    jekyll-sitemap (1.1.1)
       jekyll (~> 3.3)
     jekyll-swiss (0.4.0)
     jekyll-theme-architect (0.0.3)
@@ -138,66 +76,101 @@ GEM
       jekyll (~> 3.3)
     jekyll-theme-modernist (0.0.3)
       jekyll (~> 3.3)
-    jekyll-theme-primer (0.1.5)
-      jekyll (~> 3.3)
+    jekyll-theme-primer (0.5.2)
+      jekyll (~> 3.5)
+      jekyll-github-metadata (~> 2.9)
+      jekyll-seo-tag (~> 2.2)
     jekyll-theme-slate (0.0.3)
       jekyll (~> 3.3)
     jekyll-theme-tactile (0.0.3)
       jekyll (~> 3.3)
     jekyll-theme-time-machine (0.0.3)
       jekyll (~> 3.3)
-    jekyll-titles-from-headings (0.1.3)
+    jekyll-titles-from-headings (0.5.0)
       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.6)
-    kramdown (1.11.1)
-    liquid (3.0.6)
-    listen (3.0.6)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9.7)
+    kramdown (1.15.0)
+    liquid (4.0.0)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
     mercenary (0.3.6)
-    mini_portile2 (2.1.0)
-    minima (2.0.0)
-    minitest (5.10.1)
+    method_source (0.9.0)
+    minima (2.1.1)
+      jekyll (~> 3.3)
     multipart-post (2.0.0)
-    net-dns (0.8.0)
-    nokogiri (1.6.8.1)
-      mini_portile2 (~> 2.1.0)
-    octokit (4.6.2)
+    octokit (4.7.0)
       sawyer (~> 0.8.0, >= 0.5.3)
-    pathutil (0.14.0)
+    pathutil (0.16.0)
       forwardable-extended (~> 2.6)
-    public_suffix (2.0.4)
-    rb-fsevent (0.9.8)
-    rb-inotify (0.9.7)
-      ffi (>= 0.5.0)
-    rouge (1.11.1)
+    pry (0.11.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.0)
+    rb-fsevent (0.10.2)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rouge (2.2.1)
     safe_yaml (1.0.4)
-    sass (3.4.23)
+    sass (3.5.3)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
     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)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  github-pages
+  coffee-script (~> 2.4)
+  coffee-script-source (~> 1.12)
+  ethon (~> 0.10)
+  execjs (~> 2.7)
+  jekyll (= 3.6.0)
+  jekyll-avatar (~> 0.4)
+  jekyll-coffeescript (~> 1.0)
+  jekyll-default-layout (~> 0.1)
+  jekyll-feed (~> 0.6)
+  jekyll-gist
+  jekyll-github-metadata (~> 2.2)
   jekyll-include-cache (~> 0.1)
+  jekyll-optional-front-matter (~> 0.1)
+  jekyll-paginate (= 1.1.0)
+  jekyll-readme-index (= 0.0.3)
+  jekyll-redirect-from (~> 0.11)
+  jekyll-relative-links (~> 0.2)
+  jekyll-seo-tag
+  jekyll-sitemap
+  jekyll-swiss (~> 0.4)
+  jekyll-theme-architect (= 0.0.3)
+  jekyll-theme-cayman (= 0.0.3)
+  jekyll-theme-dinky (= 0.0.3)
+  jekyll-theme-hacker (= 0.0.3)
+  jekyll-theme-leap-day (= 0.0.3)
+  jekyll-theme-merlot (= 0.0.3)
+  jekyll-theme-midnight (= 0.0.3)
+  jekyll-theme-minimal (= 0.0.3)
+  jekyll-theme-modernist (= 0.0.3)
+  jekyll-theme-primer (~> 0.1)
+  jekyll-theme-slate (= 0.0.3)
+  jekyll-theme-tactile (= 0.0.3)
+  jekyll-theme-time-machine (= 0.0.3)
+  jekyll-titles-from-headings (~> 0.1)
+  json (~> 1.7, >= 1.7.7)
+  kramdown (~> 1.11)
+  minima (~> 2.0)
+  pry
+  rouge (~> 2.0)
+  terminal-table (~> 1.4)
+  unicode-display_width (~> 1.1)
 
 BUNDLED WITH
-   1.15.2
+   1.15.4
diff --git a/_data/glossary/_example.yml b/_data/glossary/_example.yml
@@ -1,5 +1,6 @@
 id: _example
 name: Example K8s Term
+full-link: kubernetes.io/docs/link-to-long-dedicated-docs-page
 aka:
 - Slang K8s Term
 - Misnomer
@@ -10,8 +11,17 @@ related:
 - id-of-commonly-used-with-term
 tags:
 - Some Tag
-short-description: |
-  Required. One or two lines that provide a minimum definition. Do not repeat the term. Write about the plural of the term. Prefer fragments. Model after tooltips. End with a period.
-long-description: |
-  Optional. Longer additional text to appear after (in conjunction with) short description. Provide where the short description is not sufficient as the intro paragraph to a topic. Write complete but concise sentences.
+short-description: >
+  Required.
+  Markdown allowed (e.g. for cross-linking).
+  One or two lines that provide a minimum definition.
+  Do not repeat the term.
+  Prefer fragments.
+  End with a period.
+long-description: >
+  Optional.
+  Markdown allowed.
+  Longer additional text to appear after (in conjunction with) short description.
+  Provide where the short description is not sufficient as the intro paragraph to a topic.
+  Write complete but concise sentences.
   **See /_includes/templates/glossary/README.md for the official style guide.**
diff --git a/_data/glossary/application-architect.yaml b/_data/glossary/application-architect.yaml
@@ -4,7 +4,7 @@ related:
   - application-developer
 tags:
   - user-type
-short-description: |
+short-description: >
   A person responsible for the high-level design of an application.
 long-description: >
   An architect ensures that an app's implementation allows it to interact with its surrounding components in a scalable, maintainable way.

diff --git a/_data/glossary/application-developer.yaml b/_data/glossary/application-developer.yaml
@@ -4,7 +4,7 @@ related:
   - application-architect
 tags:
   - user-type
-short-description: |
+short-description: >
   A person who writes an application that runs in a Kubernetes cluster.
 long-description: >
   An application developer focuses on one part of an application.

diff --git a/_data/glossary/approver.yaml b/_data/glossary/approver.yaml
@@ -2,7 +2,7 @@ id: approver
 name: Approver
 tags:
 - community
-short-description: |
+short-description: >
   A person who can review and approve Kubernetes code contributions.
 long-description: >
   While code review is focused on code quality and correctness, approval is focused on the holistic acceptance of a contribution.