From cfbae7cea2b1b8fc88eace7d85afc1f1616e0435 Mon Sep 17 00:00:00 2001
From: digitalcraftsman <digitalcraftsman@users.noreply.github.com>
Date: Fri, 12 Feb 2016 21:55:58 +0100
Subject: [PATCH] docs: Add guideline for showcase additions

---
 docs/content/community/contributing.md | 54 +++++++++++++++++++++++++-
 docs/layouts/section/showcase.html     | 21 ++++++----
 2 files changed, 66 insertions(+), 9 deletions(-)

diff --git a/docs/content/community/contributing.md b/docs/content/community/contributing.md
index 2b3266862..5c0cd8ff2 100644
--- a/docs/content/community/contributing.md
+++ b/docs/content/community/contributing.md
@@ -2,7 +2,7 @@
 aliases:
 - /doc/contributing/
 - /meta/contributing/
-lastmod: 2015-05-25
+lastmod: 2015-02-12
 date: 2013-07-01
 menu:
   main:
@@ -66,3 +66,55 @@ of the following paths:
     go build -o hugo main.go
     mv hugo /usr/local/bin/
 
+
+# Showcase additions
+
+You got your new website running and it's powered by Hugo? Great. You can add your website with a few steps to the [showcase](/showcase/).
+
+First, make sure that you created a [fork](https://help.github.com/articles/fork-a-repo/) of Hugo on Github and cloned your fork on your local computer. Next, create a seperate branch for your additions:
+
+```
+# You can choose a different descriptive branch name if you like
+git checkout -b showcase-addition
+```
+
+Let's create a new document that contains some metadata of your homepage. Replace `example` in the following examples with something unique like the name of your website. Inside the terminal enter the following commands:
+
+```
+cd docs
+hugo new showcase/example.md
+```
+
+You should find the new file at `content/showcase/example.md`. Open it in an editor. The file should contain a frontmatter with predefined variables like below:
+
+```
+---
+date: 2016-02-12T21:01:18+01:00
+description: ""
+license: ""
+licenseLink: ""
+sitelink: http://spf13.com/
+sourceLink: https://github.com/spf13/spf13.com
+tags:
+- personal
+- blog
+thumbnail: /img/spf13-tn.jpg
+title: example
+---
+```
+
+Add at least values for `sitelink`, `title`,  `description` and a path for `thumbnail`.
+
+Furthermore, we need to create the thumbnail of your website. **It's important that the thumbnail has the required dimensions of 600px by 400px.** Give your thumbnail a name like `example-tn.png` or `example-tn.jpg`. Save it under `docs/static/img/`.
+
+Check a last time that everything works as expected. Start Hugo's built-in server in order to inspect your local copy of the showcase in the browser:
+
+    hugo server
+
+If everything looks fine, we are ready to commit your additions. For the sake of best practices, please make sure that your commit follows our [code contribution guideline](https://github.com/spf13/hugo#code-contribution-guideline).
+
+    git commit -m"Add example.com to the showcase"
+
+Last but not least, we're ready to create a [pull request](https://github.com/spf13/hugo/compare).
+
+
diff --git a/docs/layouts/section/showcase.html b/docs/layouts/section/showcase.html
index 21446f5eb..6ba46911b 100644
--- a/docs/layouts/section/showcase.html
+++ b/docs/layouts/section/showcase.html
@@ -1,12 +1,17 @@
 {{ partial "header.html" . }}
 
-   <h1 id="title">Hugo-built Sites (with source)</h1>
-        <div class="row">
-        {{ range .Data.Pages.ByDate }}
-            {{ .Render "thumbnail"}}
-        {{ end }}
-        </div>
-  <br><br>
-  If you want to be added to this page, please send a <a href="https://github.com/spf13/hugo/pulls">pull request</a>.
+<h1 id="title">Hugo-built Sites (with source)</h1>
+
+<div class="row">
+	{{ range .Data.Pages.ByDate }}
+    	{{ .Render "thumbnail"}}
+    {{ end }}
+</div>
+
+<hr>
+
+<blockquote>
+If you want to be added to this page, please send a <a href="https://github.com/spf13/hugo/pulls">pull request</a>. Check out the <a href="{{ relref . "community/contributing.md#showcase-additions" }}">how-to guide</a>.
+</blockquote>
 
 {{ partial "footer.html" . }}