added config to page

warrensbox · May 26, 2018 · d854363 · d854363
1 parent 50150ff
commit d854363
Show file tree

Hide file tree

Showing 10 changed files with 348 additions and 378 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,66 @@
 [![Build Status](https://travis-ci.org/warrensbox/terraform-switcher.svg?branch=master)](https://travis-ci.org/warrensbox/terraform-switcher)
 [![Go Report Card](https://goreportcard.com/badge/github.com/warrensbox/terraform-switcher)](https://goreportcard.com/report/github.com/warrensbox/terraform-switcher)
 [![CircleCI](https://circleci.com/gh/warrensbox/terraform-switcher/tree/master.svg?style=shield&circle-token=55ddceec95ff67eb38269152282f8a7d761c79a5)](https://circleci.com/gh/warrensbox/terraform-switcher)
-# terraform-switcher
 
-#remove this
+
+# Terraform Switcher 
+
+The tfswitch command lets you switch between different terraform versions. 
+If you do not have a particular version installed, tfswitch will download the version you desire.
+The installation is minimal and easy. 
+Simply select the version you require from the dropdown and start using terraform with ease. 
+
+<hr>
+
+## Installation
+
+At the moment, installation is available for most unix/linux based operating systems.
+
+### Homebrew
+
+Installation for MacOS is the easiest with Homebrew. [If you do not have homebrew installed, click here](https://brew.sh/). 
+
+
+```ruby
+brew install warrensbox/tap/tfswitch
+```
+
+To upgrade, simply run `brew upgrade warrensbox/tap/tfswitch`
+
+### Linux
+
+Installation for other linux operation systems.
+
+```sh
+curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
+```
+
+To upgrade, simply run 
+
+### Install from source
+
+Alternatively, you can install the binary from source [here](https://github.com/warrensbox/terraform-switcher/releases) 
+
+<hr>
+
+## How to use:
+
+<img src="https://s3.us-east-2.amazonaws.com/kepler-images/warrensbox/tfswitch.gif" alt="drawing" style="width: 480px;"/>
+
+1.  You can start using by typing the command `tfswitch` on your terminal. 
+2.  Select the version of terraform you require by using the up and down arrow.
+3.  Hit **Enter** to select the desired version
+
+<hr>
+
+## Additional Info
+
+[tfswitch main site](https://warrensbox.github.io/terraform-switcher/)
+
+
+## Issues
+
+Please open  *issues* here: [New Issue](https://github.com/warrensbox/terraform-switcher/issues)
 
 
 

diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,7 +1,8 @@
 theme: jekyll-theme-minimal
 github: [metadata] 
 repository: warrensbox/terraform-switcher
-logo: /assets/img/logo.png
+logo: /assets/img/tfswitchlogo.png
+title: tfswitch
 
 show_downloads: true
 

diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -14,13 +14,14 @@
   <body>
     <div class="wrapper">
       <header>
-        <h1 style="font-size:25px;"><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>
-
+        <!-- <h1 style="font-size:25px;"><a href="{{ "/" | absolute_url }}">{{ site.title | default: site.github.repository_name }}</a></h1> -->
+        <h1 style="font-size:25px; text-align: center"><a href="{{ "/" | absolute_url }}">tfswitch</a></h1>
+
         {% if site.logo %}
           <img src="{{site.logo | relative_url}}" alt="Logo" />
         {% endif %}
 
-        <p>{{ site.description | default: site.github.project_tagline }}</p>
+        <p style="text-align: center">{{ site.description | default: site.github.project_tagline }}</p>
         <!-- <p>Written in go</p> -->
         <img src="https://travis-ci.org/warrensbox/terraform-switcher.svg?branch=master" alt="Travis" />
         <img src="https://goreportcard.com/badge/github.com/warrensbox/terraform-switcher" alt="Go Report" />
@@ -38,9 +39,9 @@ <h1 style="font-size:25px;"><a href="{{ "/" | absolute_url }}">{{ site.title | d
 
         {% if site.show_downloads %}
         <ul>
-          <li><a href="{{ site.github.zip_url }}">Download <strong>MacOS</strong></a></li>
-          <li><a href="{{ site.github.tar_url }}">Download <strong>Linux</strong></a></li>
-          <li><a href="{{ site.github.repository_url }}">View On <strong>GitHub</strong></a></li>
+          <li><a href="https://github.com/warrensbox/terraform-switcher/releases/download/0.3.256/terraform-switcher_0.3.256_darwin_amd64.tar.gz">Download <strong>MacOS</strong></a></li>
+          <li><a href="https://github.com/warrensbox/terraform-switcher/releases/download/0.3.256/terraform-switcher_0.3.256_linux_amd64.tar.gz">Download <strong>Linux</strong></a></li>
+          <li><a href="https://github.com/warrensbox/terraform-switcher/releases">Releases On <strong>GitHub</strong></a></li>
         </ul>
         {% endif %}
       </header>

diff --git a/docs/_site/addtional.html b/docs/_site/addtional.html
@@ -0,0 +1,114 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+<!-- Begin Jekyll SEO tag v2.4.0 -->
+<title>terraform-switcher | The tfswitch command lets you switch between terraform versions</title>
+<meta name="generator" content="Jekyll v3.7.3" />
+<meta property="og:title" content="terraform-switcher" />
+<meta property="og:locale" content="en_US" />
+<meta name="description" content="The tfswitch command lets you switch between terraform versions" />
+<meta property="og:description" content="The tfswitch command lets you switch between terraform versions" />
+<link rel="canonical" href="http://localhost:4000/addtional.html" />
+<meta property="og:url" content="http://localhost:4000/addtional.html" />
+<meta property="og:site_name" content="terraform-switcher" />
+<script type="application/ld+json">
+{"description":"The tfswitch command lets you switch between terraform versions","@type":"WebPage","url":"http://localhost:4000/addtional.html","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"http://localhost:4000/assets/img/logo.png"}},"headline":"terraform-switcher","@context":"http://schema.org"}</script>
+<!-- End Jekyll SEO tag -->
+
+    <link rel="stylesheet" href="/assets/css/style.css?v=">
+    <!--[if lt IE 9]>
+    <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <!-- <h1 style="font-size:25px;"><a href="http://localhost:4000/">terraform-switcher</a></h1> -->
+        <h1 style="font-size:25px; text-align: center"><a href="http://localhost:4000/">tfswitch</a></h1>
+
+
+          <img src="/assets/img/logo.png" alt="Logo" />
+
+
+        <p style="text-align: center">The tfswitch command lets you switch between terraform versions</p>
+        <!-- <p>Written in go</p> -->
+        <img src="https://travis-ci.org/warrensbox/terraform-switcher.svg?branch=master" alt="Travis" />
+        <img src="https://goreportcard.com/badge/github.com/warrensbox/terraform-switcher" alt="Go Report" />
+
+        <hr style="margin-top: 20px;">
+
+
+
+
+
+
+
+        <ul>
+          <li><a href="https://github.com/warrensbox/terraform-switcher/releases/download/0.3.256/terraform-switcher_0.3.256_darwin_amd64.tar.gz">Download <strong>MacOS</strong></a></li>
+          <li><a href="https://github.com/warrensbox/terraform-switcher/releases/download/0.3.256/terraform-switcher_0.3.256_linux_amd64.tar.gz">Download <strong>Linux</strong></a></li>
+          <li><a href="https://github.com/warrensbox/terraform-switcher/releases">Releases On <strong>GitHub</strong></a></li>
+        </ul>
+
+      </header>
+      <section>
+
+
+<p><a href="index">Back to main</a></p>
+
+<h2 id="upgrade">Upgrade:</h2>
+
+<h3 id="homebrew">Homebrew</h3>
+
+<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">brew</span> <span class="n">upgrade</span> <span class="n">warrensbox</span><span class="o">/</span><span class="n">tap</span><span class="o">/</span><span class="n">tfswitch</span>
+</code></pre></div></div>
+<h3 id="linux">Linux</h3>
+
+<p>Rerun:</p>
+
+<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>curl <span class="nt">-L</span> https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
+</code></pre></div></div>
+
+<h2 id="uninstall">Uninstall:</h2>
+
+<h3 id="homebrew-1">Homebrew</h3>
+
+<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">brew</span> <span class="n">uninstall</span> <span class="n">warrensbox</span><span class="o">/</span><span class="n">tap</span><span class="o">/</span><span class="n">tfswitch</span>
+</code></pre></div></div>
+<h3 id="linux-1">Linux</h3>
+
+<p>Rerun:</p>
+
+<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code>rm /usr/local/bin/tfswitch
+</code></pre></div></div>
+
+<h2 id="troubleshoot">Troubleshoot:</h2>
+
+<p>Common issues:</p>
+<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="ss">install: </span><span class="n">can</span><span class="err">'</span><span class="n">t</span> <span class="n">change</span> <span class="n">permissions</span> <span class="n">of</span> <span class="sr">/usr/</span><span class="n">local</span><span class="o">/</span><span class="ss">bin: </span><span class="no">Operation</span> <span class="n">not</span> <span class="n">permitted</span>
+</code></pre></div></div>
+
+<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="s2">"Unable to remove symlink. You must have SUDO privileges"</span>
+</code></pre></div></div>
+
+<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="s2">"Unable to create symlink. You must have SUDO privileges"</span>
+</code></pre></div></div>
+<p>You probably need to have <strong>sudo</strong> privileges to install <em>tfswitch</em>.</p>
+
+<p><a href="#upgrade">Back to top</a>  <br />
+<a href="index">Back to main</a></p>
+
+
+      </section>
+      <footer>
+
+        <p><small>View other products &mdash; by <a href="http://warren.veerasingam.com/#about_me">Warren Veerasingam</a></small></p>
+      </footer>
+    </div>
+    <script src="/assets/js/scale.fix.js"></script>
+
+  </body>
+</html>
diff --git a/docs/_site/addtional.md b/docs/_site/addtional.md
@@ -0,0 +1,51 @@
+
+[Back to main](index)
+
+## Upgrade:
+
+### Homebrew
+
+```ruby
+brew upgrade warrensbox/tap/tfswitch
+```
+### Linux
+
+Rerun:
+
+```sh
+curl -L https://raw.githubusercontent.com/warrensbox/terraform-switcher/release/install.sh | bash
+```
+
+## Uninstall:
+
+### Homebrew
+
+```ruby
+brew uninstall warrensbox/tap/tfswitch
+```
+### Linux
+
+Rerun:
+
+```sh
+rm /usr/local/bin/tfswitch
+```
+
+## Troubleshoot:
+
+Common issues:
+```ruby
+install: can't change permissions of /usr/local/bin: Operation not permitted
+```
+
+```ruby
+"Unable to remove symlink. You must have SUDO privileges"
+```
+
+```ruby
+"Unable to create symlink. You must have SUDO privileges"
+```
+You probably need to have **sudo** privileges to install *tfswitch*.
+
+[Back to top](#upgrade)    
+[Back to main](index)
diff --git a/docs/_site/assets/img/logo.png b/docs/_site/assets/img/logo.png