Added basic support for authors/source location/license information

Tom Clark · Tom Clark · commit e449eb3b69de · 2012-06-17T20:42:14.000-04:00
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 tutorials.github.com
 ====================
 
-tutorials.github.com is a simple hack that uses GitHub Pages to fulfill a need of mine: easily collecting and forking programming tutorials and offering polyglot versions.
+tutorials.github.com is a simple hack that uses GitHub Pages to fulfill a need of mine: collecting disparate tutorials and allowing others to easily fork them so the full range of languages and systems is covered.
 
 Examples
 ========
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -37,7 +37,6 @@
         <h1><a href="http://tutorials.github.com">tutorials.github.com</a></h1>
         <p>Decentralized polyglot tutorials</p>
         <nav id="sidebar"></nav>
-        <p class="view"><a href="https://github.com/tutorials/tutorials.github.com">View the Project on GitHub <small>tutorials/tutorials.github.com</small></a></p>
         <ul id="download">
           <li><a href="https://github.com/tutorials/tutorials.github.com/zipball/master">Download <strong>ZIP File</strong></a></li>
           <li><a href="https://github.com/tutorials/tutorials.github.com/tarball/master">Download <strong>TAR Ball</strong></a></li>
@@ -54,7 +53,6 @@ <h1><a href="http://tutorials.github.com">tutorials.github.com</a></h1>
     </div>
     <!--[if !IE]><script>fixScale(document);</script><!--<![endif]-->
     <script id="sidebar_template" type="text/x-underscore" charset="utf-8">
-      <em>(Click on us!)</em>
       <% _(visible).each(function(values, name) { %>
         <h3><%= name %> (<%= visible_counts[name] %>)</h3>
         <ul>
diff --git a/index.md b/index.md
@@ -7,14 +7,10 @@ ignore: true
 README
 ======
 
-tutorials.github.com is a simple hack that uses GitHub Pages to fulfill a need of mine: easily collecting and forking programming tutorials and offering polyglot versions.
-
-Amazon has proven (citation needed) that faceted navigation is superior to search, so let's use that idea for education!
+tutorials.github.com is a simple hack that uses GitHub Pages to fulfill a need of mine: collecting disparate tutorials and allowing others to easily fork them so the full range of languages and systems is covered.
 
 For now, each topic is its own page, and you use the sidebar navigation to drill down into a variant that's most useful to you.  It might not look like it, but __the navigation is clickable!__  Try clicking on a language in the [Hello, World!](/pages/hello-world.html) example to get a feel for the navigation.
 
-I _really_ like the idea of customized documentation.  If you're looking for documentation, you no longer have to parse a generic tutorial for what's relavent to you and your setup.  And if you're an author, you no longer need to inline special directions if someone's on xyz architecture.  Just fork the repo, copy an existing tutorial, update the tags, and send a pull request!
-
 In the future, I'll add cookies so the site will apply filters for you and a central collection of tags/values so we have some consistency across various tutorials.
 
 This project originated as a full-blown rails app backed by a database, and I reached a point where I needed user accounts and git repos.  Dreading that, I threw it all away for a simpler, git-based workflow to upload data.  I sincerely hope you enjoy it and find it useful.
@@ -34,9 +30,4 @@ Contributing
 - Add a new file (or modify an existing one)
 - Send me a pull request
 
-Hi, Hacker News!
-================
-
-I appreciate the upvotes!
-
 Note: This project is not affiliated with GitHub Inc.
diff --git a/javascripts/sidebar.js b/javascripts/sidebar.js
@@ -7,6 +7,25 @@ $(function() {
   // Mark all tutorials as visible
   tutorials.show();
 
+  // Render license/source information
+  _(tutorials).each(function(tutorial){
+    t = $(tutorial)
+    d = t.data()
+    attribution = ""
+    if(d.authorGithub) {
+      attribution += '<li>Author: <a href="http://github.com/' + d.authorGithub + '">' + d.authorGithub + '</a></li>'
+    } else if(d.author) {
+      attribution += "<li>Author: " + d.author + "</li>"
+    }
+    if(d.source) {
+      attribution += '<li><a href="' + d.source + '">Original Source</a></li>'
+      if(d.license) {
+        attribution += '<li><a href="' + d.license + '">License</a></li>'
+      }
+    }
+    if(attribution) { t.prepend("<ul>" + attribution + "</ul>")}
+  });
+
   dict = _.chain(tutorials)
     .reduce(function(lookup, tutorial) {
       _($(tutorial).data().facets).each(function(val, key) {
diff --git a/pages/another_test.md b/pages/another_test.md
@@ -27,6 +27,7 @@ puts markdown.to_html
 
 Here's a test of GFM:
 
+* User: @mojombo
 * SHA: be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
 * User@SHA ref: mojombo@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
 * User/Project@SHA: mojombo/god@be6a8cc1c1ecfe9489fb51e4869af15a13fc2cd2
diff --git a/pages/hello-world.md b/pages/hello-world.md
@@ -8,7 +8,7 @@ Hello, World!
 
 Here are some examples of "Hello, World!" in various programming languages.
 
-<div markdown="1" class="tutorial" data-author="Whitespace" data-facets='{"Language": "ActionScript", "Type System": "Static"}'>
+<div markdown="1" class="tutorial" data-facets='{"Language": "ActionScript", "Type System": "Static"}'>
 ActionScript
 ------------
 
diff --git a/pages/installing-mysql.md b/pages/installing-mysql.md
@@ -6,7 +6,13 @@ title: Installing MySQL
 Installing MySQL
 ================
 
-<div markdown="1" class="tutorial" data-author="Whitespace" data-facets='{"Operating System": "Ubuntu", "Package Management": "APT", "MySQL Version": "5.1"}'>
+<div
+  markdown="1"
+  class="tutorial"
+  data-author="Ubuntu Documentation Team"
+  data-source="https://help.ubuntu.com/11.10/serverguide/mysql.html"
+  data-license="https://help.ubuntu.com/legal.html"
+  data-facets='{"Operating System": "Ubuntu 11.10", "Package Management": "APT", "MySQL Version": "5.1"}'>
 To install MySQL, run the following command from a terminal prompt:
 
 {% highlight sh %}
@@ -48,9 +54,17 @@ After making a change to `/etc/mysql/my.cnf` the __mysql__ daemon will need to b
 {% highlight sh %}
 sudo /etc/init.d/mysql restart
 {% endhighlight %}
+
+---------------------------------------------------------
+
 </div>
 
-<div markdown="1" class="tutorial" data-author="Whitespace" data-facets='{"Operating System": "OS X", "Package Management": "Source", "MySQL Version": "5.1"}'>
+<div
+  markdown="1"
+  class="tutorial"
+  data-author-github="hivelogic"
+  data-source="http://hivelogic.com/articles/compiling-mysql-on-snow-leopard/"
+  data-facets='{"Operating System": "OS X", "Package Management": "Source", "MySQL Version": "5.1"}'>
 These are instructions for compiling and installing a 64-bit version of [MySQL](http://www.mysql.com/), the world's most popular open source database, on Mac OS X 10.6 (Snow Leopard).
 
 The benefits of manually building MySQL yourself in `/usr/local` are detailed [here](http://hivelogic.com/articles/using_usr_local/). I also wrote a in-depth explanation of why you might want to build MySQL yourself in my [Compiling MySQL on Leopard](http://hivelogic.com/articles/installing-mysql-on-mac-os-x/) article.
@@ -202,9 +216,17 @@ sudo gem install mysql -- --with-mysql-dir=/usr/local/mysql
 {% endhighlight %}
 
 That should do it.
+
+---------------------------------------------------------
+
 </div>
 
-<div markdown="1" class="tutorial" data-facets='{"Operating System": "OS X", "Package Management": "Homebrew", "MySQL Version": "5.5"}'>
+<div
+  markdown="1"
+  class="tutorial"
+  data-author-github="trey"
+  data-source="http://solutions.trey.cc/2010/02/28/installing-mysql-on-snow-leopard-using-homebrew/"
+  data-facets='{"Operating System": "OS X", "Package Management": "Homebrew", "MySQL Version": "5.5"}'>
 If you already have a `/usr/local` folder and it's not owned by your user:
 
 {% highlight sh %}
@@ -241,3 +263,7 @@ And make sure it automatically starts again on login:
 {% highlight sh %}
 launchctl load -w /usr/local/Cellar/mysql/5.1.43/com.mysql.mysqld.plist
 {% endhighlight %}
+
+---------------------------------------------------------
+
+</div>
