Merge pull request hashicorp#2490 from mitchellh/docs-revamp

Reformat docs using htmlbeautifier and pandoc
punkle · Jul 25, 2015 · c656a01 · c656a01
2 parents 40f2173 + e0be4ef
commit c656a01
Show file tree

Hide file tree

Showing 100 changed files with 6,028 additions and 5,581 deletions.
diff --git a/website/Gemfile b/website/Gemfile
@@ -3,3 +3,5 @@ source "https://rubygems.org"
 ruby "2.2.2"
 
 gem "middleman-hashicorp", github: "hashicorp/middleman-hashicorp"
+gem "middleman-breadcrumbs"
+gem "htmlbeautifier"
diff --git a/website/Gemfile.lock b/website/Gemfile.lock
@@ -69,6 +69,7 @@ GEM
     hitimes (1.2.2)
     hooks (0.4.0)
       uber (~> 0.0.4)
+    htmlbeautifier (1.1.0)
     htmlcompressor (0.2.0)
     http_parser.rb (0.6.0)
     i18n (0.7.0)
@@ -92,6 +93,8 @@ GEM
       middleman-sprockets (>= 3.1.2)
       sass (>= 3.4.0, < 4.0)
       uglifier (~> 2.5)
+    middleman-breadcrumbs (0.1.0)
+      middleman (>= 3.3.5)
     middleman-core (3.3.12)
       activesupport (~> 4.1.0)
       bundler (~> 1.1)
@@ -179,4 +182,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  htmlbeautifier
+  middleman-breadcrumbs
   middleman-hashicorp!
diff --git a/website/Makefile b/website/Makefile
@@ -8,3 +8,10 @@ dev: init
 
 build: init
 	PACKER_DISABLE_DOWNLOAD_FETCH=true PACKER_VERSION=1.0 bundle exec middleman build
+
+format:
+	bundle exec htmlbeautifier -t 2 source/*.erb
+	bundle exec htmlbeautifier -t 2 source/layouts/*.erb
+	@pandoc -v > /dev/null || echo "pandoc must be installed in order to format markdown content"
+	pandoc -v > /dev/null && find . -iname "*.html.markdown" | xargs -I{} bash -c "pandoc -r markdown -w markdown --tab-stop=4 --atx-headers -s --columns=80 {} > {}.new"\; || true
+	pandoc -v > /dev/null && find . -iname "*.html.markdown" | xargs -I{} bash -c "mv {}.new {}"\; || true
diff --git a/website/README.md b/website/README.md
@@ -21,3 +21,13 @@ make dev
 
 Then open up `localhost:4567`. Note that some URLs you may need to append
 ".html" to make them work (in the navigation and such).
+
+## Keeping Tidy
+
+To keep the source code nicely formatted, there is a `make format` target. This
+runs `htmlbeautify` and `pandoc` to reformat the source code so it's nicely formatted.
+
+    make format
+
+Note that you will need to install pandoc yourself. `make format` will skip it
+if you don't have it installed.
diff --git a/website/config.rb b/website/config.rb
@@ -4,6 +4,8 @@
 
 set :base_url, "https://www.packer.io/"
 
+activate :breadcrumbs
+
 activate :hashicorp do |h|
   h.version         = ENV["PACKER_VERSION"]
   h.bintray_enabled = ENV["BINTRAY_ENABLED"]

diff --git a/website/source/assets/stylesheets/_footer.scss b/website/source/assets/stylesheets/_footer.scss
@@ -12,45 +12,45 @@ footer {
     margin-left: -20px;
   }
 
-	ul {
-  	margin-top: 40px;
-  	@include respond-to(mobile) {
-    	margin-left: $baseline;
-    	margin-top: $baseline;
+  ul {
+    margin-top: 40px;
+    @include respond-to(mobile) {
+      margin-left: $baseline;
+      margin-top: $baseline;
     }
 
-		li {
-  		display: inline;
-  		margin-right: 50px;
-  		@include respond-to(mobile) {
-    		margin-right: 20px;
-    		display: list-item;
+    li {
+      display: inline;
+      margin-right: 50px;
+      @include respond-to(mobile) {
+        margin-right: 20px;
+        display: list-item;
       }
     }
 
-		.hashi-logo {
-  		background: image-url('logo_footer.png') no-repeat center top;
-  		height: 40px;
-  		width: 40px;
-  		background-size: 37px 40px;
-  		text-indent: -999999px;
-  		display: inline-block;
-  		margin-top: -10px;
-  		margin-right: 0;
-  		@include respond-to(mobile) {
-    		margin-top: -50px;
-    		margin-right: $baseline;
-  		}
-		}
-	}
+    .hashi-logo {
+      background: image-url('logo_footer.png') no-repeat center top;
+      height: 40px;
+      width: 40px;
+      background-size: 37px 40px;
+      text-indent: -999999px;
+      display: inline-block;
+      margin-top: -10px;
+      margin-right: 0;
+      @include respond-to(mobile) {
+        margin-top: -50px;
+        margin-right: $baseline;
+      }
+    }
+  }
 
-	.active {
+  .active {
     color: $green;
-	}
+  }
 
-	button {
+  button {
     margin-top: 20px;
-	}
+  }
 }
 
 .page-wrap {

diff --git a/website/source/assets/stylesheets/_helpers.scss b/website/source/assets/stylesheets/_helpers.scss
@@ -70,17 +70,17 @@ $mono: 'Inconsolata', 'courier new', courier, mono-space;
   background-color: #000;
   color: $white;
 
-	a {
+  a {
     color: inherit;
 
     &:hover {
-		  color: $green;
-		}
+      color: $green;
+    }
 
-		&:active {
-		  color: darken($green, 30%);
-		}
-	}
+    &:active {
+      color: darken($green, 30%);
+    }
+  }
 }
 
 .white-background {
@@ -102,9 +102,9 @@ $mono: 'Inconsolata', 'courier new', courier, mono-space;
   color: $orange;
   font-size: 20px;
 
-	a:hover, a:active, a:visited {
+  a:hover, a:active, a:visited {
     color: inherit;
-	}
+  }
 }
 
 // media queries
@@ -170,13 +170,13 @@ $break-lg: 980px;
 
 @mixin transform-scale($value) {
   -webkit-transform: scale($value);
-  	 -moz-transform: scale($value);
-  				transform: scale($value);
+     -moz-transform: scale($value);
+          transform: scale($value);
 }
 
 @mixin transition($type, $speed, $easing) {
-	-webkit-transition: $type $speed $easing;
-	   -moz-transition: $type $speed $easing;
+  -webkit-transition: $type $speed $easing;
+     -moz-transition: $type $speed $easing;
        -o-transition: $type $speed $easing;
           transition: $type $speed $easing;
 }

diff --git a/website/source/assets/stylesheets/_reset.scss b/website/source/assets/stylesheets/_reset.scss
@@ -14,10 +14,10 @@ form, input, textarea, button {
   line-height: 1.0;
   color: inherit;
 
-	&:focus {
-  	line-height: 1.0;
-  	box-shadow: none !important;
-  	outline: none;
-  	vertical-align: middle;
-	}
+  &:focus {
+    line-height: 1.0;
+    box-shadow: none !important;
+    outline: none;
+    vertical-align: middle;
+  }
 }
diff --git a/website/source/community/index.html.markdown b/website/source/community/index.html.markdown
@@ -1,22 +1,25 @@
 ---
-layout: "community"
-page_title: "Community"
-description: |-
-  Packer is a new project with a growing community. Despite this, there are dedicated users willing to help through various mediums.
----
+description: |
+    Packer is a new project with a growing community. Despite this, there are
+    dedicated users willing to help through various mediums.
+layout: community
+page_title: Community
+...
 
 # Community
 
 Packer is a new project with a growing community. Despite this, there are
 dedicated users willing to help through various mediums.
 
-**IRC:**&nbsp;`#packer-tool` on Freenode.
+**IRC:** `#packer-tool` on Freenode.
 
-**Mailing List:**&nbsp;[Packer Google Group](http://groups.google.com/group/packer-tool)
+**Mailing List:** [Packer Google
+Group](http://groups.google.com/group/packer-tool)
 
-**Bug Tracker:**&nbsp;[Issue tracker on GitHub](https://github.com/mitchellh/packer/issues).
-Please only use this for reporting bugs. Do not ask for general help here. Use IRC
-or the mailing list for that.
+**Bug Tracker:** [Issue tracker on
+GitHub](https://github.com/mitchellh/packer/issues). Please only use this for
+reporting bugs. Do not ask for general help here. Use IRC or the mailing list
+for that.
 
 ## People
 
@@ -25,62 +28,82 @@ to Packer in some core way. Over time, faces may appear and disappear from this
 list as contributors come and go.
 
 <div class="people">
-	<div class="person">
-		<img class="pull-left" src="http://www.gravatar.com/avatar/54079122b67de9677c1f93933ce8b63a.png?s=125">
-		<div class="bio">
-			<h3>Mitchell Hashimoto (<a href="https://github.com/mitchellh">@mitchellh</a>)</h3>
-			<p>
-			Mitchell Hashimoto is the creator of Packer. He developed the
-			core of Packer as well as the Amazon, VirtualBox, and VMware
-			builders. In addition to Packer, Mitchell is the creator of
-			<a href="http://www.vagrantup.com">Vagrant</a>. He is self
-			described as "automation obsessed."
-			</p>
-		</div>
-	</div>
-
-	<div class="person">
-		<img class="pull-left" src="http://www.gravatar.com/avatar/2acc31dd6370a54b18f6755cd0710ce6.png?s=125">
-		<div class="bio">
-			<h3>Jack Pearkes (<a href="https://github.com/pearkes">@pearkes</a>)</h3>
-			<p>
-			<a href="http://jack.ly/">Jack Pearkes</a> created and maintains the DigitalOcean builder
-			for Packer. Outside of Packer, Jack is an avid open source
-			contributor and software consultant.</p>
-		</div>
-	</div>
-
-	<div class="person">
-		<img class="pull-left" src="http://www.gravatar.com/avatar/2f7fc9cb7558e3ea48f5a86fa90a78da.png?s=125">
-		<div class="bio">
-			<h3>Mark Peek (<a href="https://github.com/markpeek">@markpeek</a>)</h3>
-			<p>
-			In addition to Packer, Mark Peek helps maintain
-			various open source projects such as
-			<a href="https://github.com/cloudtools">cloudtools</a> and
-			<a href="https://github.com/ironport">IronPort Python libraries</a>.
-			Mark is also a <a href="https://FreeBSD.org">FreeBSD committer</a>.</p>
-		</div>
-	</div>
-
-	<div class="person">
-		<img class="pull-left" src="http://www.gravatar.com/avatar/1fca64df3d7db1e2f258a8956d2b0aff.png?s=125">
-		<div class="bio">
-			<h3>Ross Smith II (<a href="https://github.com/rasa" target="_blank">@rasa</a>)</h3>
-			<p>
-<a href="http://smithii.com/" target="_blank">Ross Smith</a> maintains our VMware builder on Windows, and provides other valuable assistance.
-Ross is an open source enthusiast, published author, and freelance consultant.</p>
-		</div>
-	</div>
-
-	<div class="person">
-		<img class="pull-left" src="http://www.gravatar.com/avatar/c9f6bf7b5b865012be5eded656ebed7d.png?s=125">
-		<div class="bio">
-			<h3>Rickard von Essen<br/>(<a href="https://github.com/rickard-von-essen" target="_blank">@rickard-von-essen</a>)</h3>
-			<p>
-Rickard von Essen maintains our Parallels Desktop builder. Rickard is an polyglot programmer and consults on Continuous Delivery.</p>
-		</div>
-	</div>
-
-	<div class="clearfix"></div>
+
+<div class="person">
+
+    <img class="pull-left" src="http://www.gravatar.com/avatar/54079122b67de9677c1f93933ce8b63a.png?s=125">
+    <div class="bio">
+      <h3>Mitchell Hashimoto (<a href="https://github.com/mitchellh">@mitchellh</a>)</h3>
+      <p>
+      Mitchell Hashimoto is the creator of Packer. He developed the
+      core of Packer as well as the Amazon, VirtualBox, and VMware
+      builders. In addition to Packer, Mitchell is the creator of
+      <a href="http://www.vagrantup.com">Vagrant</a>. He is self
+      described as "automation obsessed."
+      </p>
+    </div>
+
+</div>
+
+<div class="person">
+
+    <img class="pull-left" src="http://www.gravatar.com/avatar/2acc31dd6370a54b18f6755cd0710ce6.png?s=125">
+    <div class="bio">
+      <h3>Jack Pearkes (<a href="https://github.com/pearkes">@pearkes</a>)</h3>
+      <p>
+      <a href="http://jack.ly/">Jack Pearkes</a> created and maintains the DigitalOcean builder
+      for Packer. Outside of Packer, Jack is an avid open source
+      contributor and software consultant.</p>
+    </div>
+
+</div>
+
+<div class="person">
+
+    <img class="pull-left" src="http://www.gravatar.com/avatar/2f7fc9cb7558e3ea48f5a86fa90a78da.png?s=125">
+    <div class="bio">
+      <h3>Mark Peek (<a href="https://github.com/markpeek">@markpeek</a>)</h3>
+      <p>
+      In addition to Packer, Mark Peek helps maintain
+      various open source projects such as
+      <a href="https://github.com/cloudtools">cloudtools</a> and
+      <a href="https://github.com/ironport">IronPort Python libraries</a>.
+      Mark is also a <a href="https://FreeBSD.org">FreeBSD committer</a>.</p>
+    </div>
+
+</div>
+
+<div class="person">
+
+    <img class="pull-left" src="http://www.gravatar.com/avatar/1fca64df3d7db1e2f258a8956d2b0aff.png?s=125">
+    <div class="bio">
+      <h3>Ross Smith II (<a href="https://github.com/rasa" target="_blank">@rasa</a>)</h3>
+      <p>
+
+<a href="http://smithii.com/" target="_blank">Ross Smith</a> maintains our
+VMware builder on Windows, and provides other valuable assistance. Ross is an
+open source enthusiast, published author, and freelance consultant.
+</p>
+    </div>
+
+</div>
+
+<div class="person">
+
+    <img class="pull-left" src="http://www.gravatar.com/avatar/c9f6bf7b5b865012be5eded656ebed7d.png?s=125">
+    <div class="bio">
+      <h3>Rickard von Essen<br/>(<a href="https://github.com/rickard-von-essen" target="_blank">@rickard-von-essen</a>)</h3>
+      <p>
+
+Rickard von Essen maintains our Parallels Desktop builder. Rickard is an
+polyglot programmer and consults on Continuous Delivery.
+</p>
+    </div>
+
+</div>
+
+<div class="clearfix">
+
+</div>
+
 </div>