Merge pull request #1 from udondan/docs

moves whole documentation to gihub pages & uese new jekyll theme
groupon · Nov 24, 2017 · 392c39d · 392c39d
2 parents 009677f + 38ffcd2
commit 392c39d
Show file tree

Hide file tree

Showing 24 changed files with 1,586 additions and 969 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/404.html b/docs/404.html
@@ -0,0 +1,6 @@
+---
+title: 404 - Not found
+sidenav_toc: false
+---
+<p><strong>Page not found :(</strong></p>
+<p>The requested page could not be found.</p>
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,15 @@
+gem "jekyll", "~> 3.6.2"
+
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.6"
+end
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]
+
+
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,70 @@
+
+title: Engineering
+
+baseurl: /ansible-silo
+
+# The repo_url can be used to link to document in your repository.
+# Example {{ site.repo_url }}README.md
+repo_url: https://github.com/groupon/ansible-silo/blob/master/
+
+# The doc_src value will be used to link to the source of the document.
+# Make this point to the branch & path where you documentation is stored.
+# Leave blank to disable source linking.
+doc_src: https://github.com/groupon/ansible-silo/blob/master/docs/
+
+description: >-
+  Silo provides a controlled environment for Ansible and its dependencies.
+  It works as a drop-in replacement for Ansible on your local machine or on any remote host.
+  Silo also makes it easy to run multiple Ansible versions in parallel on the same system.
+  Furthermore you can bundle your playbooks (incl. configuration, roles, plugins etc) in a
+  custom Docker image which inherits Silo and therefore generate a versioned, shippable,
+  complete and self-contained executable package which runs your playbooks in any
+  environment. (where you have access to a Docker daemon)
+
+top_navigation:
+  - title: Documentation
+    active: true
+    url: /
+  - title: GitHub
+    url: https://github.com/groupon/ansible-silo
+  - title: Docker Hub
+    url: https://hub.docker.com/r/grpn/ansible-silo/
+  - title: Travis CI
+    url: https://travis-ci.org/groupon/ansible-silo
+  - title: Engineering Jobs
+    url: http://www.groupon.com/techjobs
+
+markdown: kramdown
+highlighter: rouge
+
+kramdown:
+  input: GFM
+  auto_ids: true
+  hard_wrap: false
+  highlighter: rouge
+
+sass:
+  sass_dir: _sass
+
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - groupon_jekyll_theme.gemspec
+  - Makefile
+
+css:
+  - /assets/layout.css
+  - /assets/content.css
+  - /assets/syntax.css
+
+js:
+  - https://code.jquery.com/jquery-3.2.1.min.js
+
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: default
+      language: en
+      css: []
+      js: []
diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html
@@ -0,0 +1,9 @@
+{% if site.doc_src %}
+    <div id="view_source">[<a href="{{ site.doc_src }}{{ page.path }}">View source for this page</a>]</div>
+{% endif %}
+<div id="bottom_spacer"></div>
+</section>
+</div>
+</body>
+
+</html>
diff --git a/docs/_includes/header.html b/docs/_includes/header.html
@@ -0,0 +1,48 @@
+<!DOCTYPE html>
+<!--
+  Groupon Jekyll Theme
+  © 2017 Groupon Inc
+  All rights reserved
+-->
+{% include logic.html %}
+<html lang="{{ page.language }}">
+<head>
+    <meta charset="utf-8">
+    <title>{% if page.title %}{{ page.title }} | {% endif %}{{ site.title }} | Groupon</title>
+    <meta http-equiv="x-ua-compatible" content="ie=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link rel="apple-touch-icon" sizes="152x152" href="//www2.grouponcdn.com/layout/assets/grpn-favicon-152x152-ed288e134e.png">
+    <link rel="mask-icon" href="//www2.grouponcdn.com/layout/assets/grpn-favicon-319296fcd8.svg" color="#53a318">
+    <link rel="icon" type="image/png" href="//www2.grouponcdn.com/layout/assets/grpn-favicon-96x96-65e46e4853.png" sizes="96x96">
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,400i,700,700i|Roboto+Mono" rel="stylesheet">
+    {% for item in css %}
+        {% unless item contains '://' %}
+            {% assign url = item | relative_url %}
+        {% else %}
+            {% assign url = item %}
+        {% endunless %}
+        <link rel="stylesheet" href="{{ url }}">
+    {% endfor %}
+    {% for item in js %}
+        {% unless item contains '://' %}
+            {% assign url = item | relative_url %}
+        {% else %}
+            {% assign url = item %}
+        {% endunless %}
+        <script src="{{ url }}"></script>
+    {% endfor %}
+    <meta name="description" content="{{ site.description }}">
+    <script src="https://code.jquery.com/jquery-3.2.1.min.js" integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4=" crossorigin="anonymous"></script>
+</head>
+<body>
+    <header>
+        <div class="min_width">
+            <a href="{{ site.baseurl }}/" id="logo" title="Groupon"><img src="https://www2.grouponcdn.com/layout/assets/grpn_logo_white-b8a7246dbd.svg" alt="Groupon"></a>
+            <span id="team">{{ site.title }}</span>
+        </div>
+        {% include topnav.html %}
+    </header>
+    <div class="min_width" id="wrapper">
+        {% include sidenav.html %}
+        <section id="content">
+            <h1>{{ page.title }}</h1>
diff --git a/docs/_includes/logic.html b/docs/_includes/logic.html
@@ -0,0 +1,87 @@
+{% comment %}
+This file contains global variable assignments, helpers to keep the templates clean
+{% endcomment %}
+
+{% comment %}
+This block collects CSS files to include, defined on site, layout and page level.
+The result list will be available as "css"
+{% endcomment %}
+{% assign css = "" | split: "" %}
+{% for f in site.css %}
+    {% assign css = css | push: f %}
+{% endfor %}
+{% for f in layout.css %}
+    {% assign css = css | push: f %}
+{% endfor %}
+{% for f in page.css %}
+    {% assign css = css | push: f %}
+{% endfor %}
+
+{% comment %}
+This block collects JS files to include, defined on site, layout and page level.
+The result list will be available as "js"
+{% endcomment %}
+{% assign js = "" | split: "" %}
+{% for f in site.js %}
+    {% assign js = js | push: f %}
+{% endfor %}
+{% for f in layout.js %}
+    {% assign js = js | push: f %}
+{% endfor %}
+{% for f in page.js %}
+    {% assign js = js | push: f %}
+{% endfor %}
+
+{% comment %}
+This block checks if the Sidebar should be displayed based on settings from layout and page.
+The result (true/false) will be available as sidenav
+{% endcomment %}
+{% assign sidenav = false %}
+{% if page.sidenav == true %}
+    {% assign sidenav = true %}
+{% else %}
+    {% if page.sidenav != true and page.sidenav != false and layout.sidenav == true %}
+        {% assign sidenav = true %}
+    {% endif %}
+{% endif %}
+
+{% comment %}
+This block checks if the Sidebar ToC should be displayed based on settings from layout and page.
+The result (true/false) will be available as sidenav_toc
+{% endcomment %}
+{% assign sidenav_toc = false %}
+{% if page.sidenav_toc == true %}
+    {% assign sidenav_toc = true %}
+{% else %}
+    {% if page.sidenav_toc != true and page.sidenav_toc != false and layout.sidenav_toc == true %}
+        {% assign sidenav_toc = true %}
+    {% endif %}
+{% endif %}
+{% comment %}
+If the sidebar ToC should be shown, additional CSS and JS files will be included
+{% endcomment %}
+{% if sidenav_toc == true %}
+    {% assign js = js   | push: "https://cdnjs.cloudflare.com/ajax/libs/tocbot/3.0.5/tocbot.min.js" %}
+    {% assign css = css | push: "https://cdnjs.cloudflare.com/ajax/libs/tocbot/3.0.5/tocbot.css" %}
+    {% assign js = js   | push: "/assets/toc.js" %}
+{% endif %}
+
+{% comment %}
+This block checks if the asciinema should be loaded based on settings from layout and page.
+The result (true/false) will be available as asciinema
+{% endcomment %}
+{% assign asciinema = false %}
+{% if page.asciinema == true %}
+    {% assign asciinema = true %}
+{% else %}
+    {% if page.asciinema != true and page.asciinema != false and layout.asciinema == true %}
+        {% assign asciinema = true %}
+    {% endif %}
+{% endif %}
+{% comment %}
+If asciinema should be used, additional CSS and JS files will be included
+{% endcomment %}
+{% if asciinema == true %}
+    {% assign js = js   | push: "https://cdnjs.cloudflare.com/ajax/libs/asciinema-player/2.4.1/asciinema-player.min.js" %}
+    {% assign css = css | push: "https://cdnjs.cloudflare.com/ajax/libs/asciinema-player/2.4.1/asciinema-player.min.css" %}
+{% endif %}
diff --git a/docs/_includes/sidenav.html b/docs/_includes/sidenav.html
@@ -0,0 +1,26 @@
+{% if sidenav or sidenav_toc %}
+    <aside id="sidebar">
+{% endif %}
+{% if site.side_navigation %}
+    <nav id="sidenav">
+        <ul>
+            {% for item in site.side_navigation %}
+                {% if item.header %}
+                    <li class="header">{{ item.header }}</li>
+                {% endif %}
+                {% unless item.url contains '://' %}
+                    {% assign url = item.url | relative_url %}
+                {% else %}
+                    {% assign url = item.url %}
+                {% endunless %}
+                <li><a{% if item.url == page.url %} class="active"{% endif %} href="{{ url }}">{{ item.title }}</a></li>
+            {% endfor %}
+        </ul>
+    </nav>
+{% endif %}
+{% if sidenav_toc %}
+    <nav id="toc"></nav>
+{% endif %}
+{% if sidenav or sidenav_toc %}
+    </aside>
+{% endif %}
diff --git a/docs/_includes/topnav.html b/docs/_includes/topnav.html
@@ -0,0 +1,14 @@
+{% if site.top_navigation %}
+    <div id="nav">
+        <ul class="min_width">
+            {% for item in site.top_navigation %}
+                {% unless item.url contains '://' %}
+                    {% assign url = item.url | relative_url %}
+                {% else %}
+                    {% assign url = item.url %}
+                {% endunless %}
+                <li{% if item.url == page.url or item.active == true %} class="active"{% endif %}><a href="{{ url }}">{{ item.title }}</a></li>
+            {% endfor %}
+        </ul>
+    </div>
+{% endif %}
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -0,0 +1,9 @@
+---
+css: []
+js: []
+sidenav: true
+sidenav_toc: true
+---
+{% include header.html %}
+{{ content }}
+{% include footer.html %}
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}
diff --git a/docs/_layouts/post.html b/docs/_layouts/post.html
@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+{{ content }}
diff --git a/docs/_layouts/swagger.html b/docs/_layouts/swagger.html
@@ -0,0 +1,62 @@
+---
+layout: default
+css:
+  - https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.4.4/swagger-ui.css
+  - assets/swagger-ui-overrides.css
+js:
+  - https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.4.4/swagger-ui-bundle.js
+  - https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.4.4/swagger-ui-standalone-preset.js
+
+sidenav: true
+sidenav_toc: false
+---
+<script>
+    var swagger_spec = "{{ page.swagger_spec | relative_url }}"
+    $(function() {
+        // Build a system
+        const ui = SwaggerUIBundle({
+            url: swagger_spec,
+            dom_id: '#swagger-ui',
+            deepLinking: true,
+            validatorUrl: null,
+            filter: false,
+            presets: [
+                SwaggerUIBundle.presets.apis,
+                SwaggerUIStandalonePreset
+            ],
+            plugins: [
+
+            ],
+            layout: "StandaloneLayout"
+        })
+        window.ui = ui
+    });
+</script>
+{{ content }}
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="position:absolute;width:0;height:0">
+  <defs>
+    <symbol viewBox="0 0 20 20" id="unlocked">
+          <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V6h2v-.801C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8z"></path>
+    </symbol>
+    <symbol viewBox="0 0 20 20" id="locked">
+      <path d="M15.8 8H14V5.6C14 2.703 12.665 1 10 1 7.334 1 6 2.703 6 5.6V8H4c-.553 0-1 .646-1 1.199V17c0 .549.428 1.139.951 1.307l1.197.387C5.672 18.861 6.55 19 7.1 19h5.8c.549 0 1.428-.139 1.951-.307l1.196-.387c.524-.167.953-.757.953-1.306V9.199C17 8.646 16.352 8 15.8 8zM12 8H8V5.199C8 3.754 8.797 3 10 3c1.203 0 2 .754 2 2.199V8z"/>
+    </symbol>
+    <symbol viewBox="0 0 20 20" id="close">
+      <path d="M14.348 14.849c-.469.469-1.229.469-1.697 0L10 11.819l-2.651 3.029c-.469.469-1.229.469-1.697 0-.469-.469-.469-1.229 0-1.697l2.758-3.15-2.759-3.152c-.469-.469-.469-1.228 0-1.697.469-.469 1.228-.469 1.697 0L10 8.183l2.651-3.031c.469-.469 1.228-.469 1.697 0 .469.469.469 1.229 0 1.697l-2.758 3.152 2.758 3.15c.469.469.469 1.229 0 1.698z"/>
+    </symbol>
+    <symbol viewBox="0 0 20 20" id="large-arrow">
+      <path d="M13.25 10L6.109 2.58c-.268-.27-.268-.707 0-.979.268-.27.701-.27.969 0l7.83 7.908c.268.271.268.709 0 .979l-7.83 7.908c-.268.271-.701.27-.969 0-.268-.269-.268-.707 0-.979L13.25 10z"/>
+    </symbol>
+    <symbol viewBox="0 0 20 20" id="large-arrow-down">
+      <path d="M17.418 6.109c.272-.268.709-.268.979 0s.271.701 0 .969l-7.908 7.83c-.27.268-.707.268-.979 0l-7.908-7.83c-.27-.268-.27-.701 0-.969.271-.268.709-.268.979 0L10 13.25l7.418-7.141z"/>
+    </symbol>
+    <symbol viewBox="0 0 24 24" id="jump-to">
+      <path d="M19 7v4H5.83l3.58-3.59L8 6l-6 6 6 6 1.41-1.41L5.83 13H21V7z"/>
+    </symbol>
+    <symbol viewBox="0 0 24 24" id="expand">
+      <path d="M10 18h4v-2h-4v2zM3 6v2h18V6H3zm3 7h12v-2H6v2z"/>
+    </symbol>
+  </defs>
+</svg>
+
+<div id="swagger-ui"></div>
diff --git a/docs/_sass/.gitignore b/docs/_sass/.gitignore
diff --git a/docs/demo.json → docs/asciicasts.json b/docs/demo.json → docs/asciicasts.json