From 01604cdc7e4025ef91be38e2973ac018ab4fa392 Mon Sep 17 00:00:00 2001 From: Jeremy Singer-Vine Date: Mon, 23 Apr 2012 01:20:04 -0400 Subject: [PATCH 1/8] Get straight to the goals of the site. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c2aa1fcd..e8e052c7 100755 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ ## About -Spread across the internet is lot of information about how to learn and use jQuery. This content ranges in quality from excellent to terrible, and is often stuck inside CMSes where only the original author can ever update the content. The goal of this site is twofold +The goal of this site is twofold: -1. To serve as a central, trustworthy, narrative compendium of information about how to use jQuery and JavaScript -2. To remain a timely, vibrant, and community-driven reference with a low barrier to contribution +1. To serve as a central, trustworthy, narrative compendium of information about how to use jQuery and JavaScript. +2. To remain a timely, vibrant, and community-driven reference with a low barrier to contribution. -Much of the initial content - and spirit - is from [jQuery Fundamentals](https://github.com/rmurphey/jqfundamentals), an open-source book about jQuery, originally released in 2010 by [Rebecca Murphey](http://www.rebeccamurphey.com/) and bequeathed unto the jQuery Project to serve as the foundation for this site. +Much of the initial content - and spirit - is from [jQuery Fundamentals](https://github.com/rmurphey/jqfundamentals), an open-source book about jQuery. The book was originally released in 2010 by [Rebecca Murphey](http://www.rebeccamurphey.com/) and bequeathed unto the jQuery Project to serve as the foundation for this site. ## How Does This Site Work From d6163ff044ac9e6025483d8a41076126c4d34a39 Mon Sep 17 00:00:00 2001 From: Jeremy Singer-Vine Date: Mon, 23 Apr 2012 01:26:10 -0400 Subject: [PATCH 2/8] Minimize passive language in the "How This Site Works" section. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e8e052c7..bc5d4c8e 100755 --- a/README.md +++ b/README.md @@ -13,9 +13,11 @@ The goal of this site is twofold: Much of the initial content - and spirit - is from [jQuery Fundamentals](https://github.com/rmurphey/jqfundamentals), an open-source book about jQuery. The book was originally released in 2010 by [Rebecca Murphey](http://www.rebeccamurphey.com/) and bequeathed unto the jQuery Project to serve as the foundation for this site. -## How Does This Site Work +## How This Site Works -This site consists of content maintained in [Markdown](http://daringfireball.net/projects/markdown/) files. For authoring and previewing content, these files are processed by [nanoc](http://nanoc.stoneship.org/), a Ruby-based [static site generator](http://www.mickgardner.com/2011/04/27/An-Introduction-To-Static-Site-Generators.html). For production on [learn.jquery.com](http://learn.jquery.com), the result of nanoc is post-processed by a node.js script that populates pages into the learning section of the jQuery Wordpress network. The template that controls the site's presentation is a [child theme](https://github.com/jquery/web-base-template/tree/master/themes/learn-jquery-com) of the jQuery [web base template](https://github.com/jquery/web-base-template), and any issues with the presentation should be directed to [that repository](https://github.com/jquery/web-base-template). +This site's core content consists of [Markdown](http://daringfireball.net/projects/markdown/) files. We use [nanoc](http://nanoc.stoneship.org/), a Ruby-based [static site generator](http://www.mickgardner.com/2011/04/27/An-Introduction-To-Static-Site-Generators.html), to process these files for previewing. For production on [learn.jquery.com](http://learn.jquery.com), a node.js script post-processes the nanoc results and puts them into the learning section of the jQuery Wordpress network. + +The template that controls the site's appearance is a [child theme](https://github.com/jquery/web-base-template/tree/master/themes/learn-jquery-com) of the jQuery [web base template](https://github.com/jquery/web-base-template), and any issues with the presentation should be directed to [that repository](https://github.com/jquery/web-base-template). ### Site Organisation From c34ca2c009a6555542a567ba98d77e0ce128c664 Mon Sep 17 00:00:00 2001 From: Jeremy Singer-Vine Date: Mon, 23 Apr 2012 01:31:49 -0400 Subject: [PATCH 3/8] De-Anglicize "Organi(s/z)ation" and simplify section. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bc5d4c8e..80fb5c86 100755 --- a/README.md +++ b/README.md @@ -19,9 +19,11 @@ This site's core content consists of [Markdown](http://daringfireball.net/projec The template that controls the site's appearance is a [child theme](https://github.com/jquery/web-base-template/tree/master/themes/learn-jquery-com) of the jQuery [web base template](https://github.com/jquery/web-base-template), and any issues with the presentation should be directed to [that repository](https://github.com/jquery/web-base-template). -### Site Organisation +### Site Organization -All of the content lives inside of the subdirectories of the `content` directory. Each of these subdirectories is considered a **category**, and contains one or more **articles** as well as a `dex.md` file that specifies the category's human-readable title, as well as an overview of the category for its landing page. The order that categories and articles appear in the site is controlled by the [`order.yml`](https://github.com/jquery/learn.jquery.com/blob/master/order.yml) file, which simply lists the folder names and file names in the order they should appear. Categories or articles that do not appear in this file will not be published in the production site. +All of the content lives inside of the subdirectories of the `content` directory. Each of these subdirectories is considered a **category**, and contains one or more **articles**. Each category also contains a `dex.md` file that contains the category's human-readable title and an overview, which will appear on the category's landing page. + +An [`order.yml`](https://github.com/jquery/learn.jquery.com/blob/master/order.yml) file controls the order that categories and articles appear in the site. Categories or articles that do not appear in this file will not be published in the production site. ### YAML Conventions From d23a4ec50bf0717b9047198ec4a60fefa1e56f4b Mon Sep 17 00:00:00 2001 From: Jeremy Singer-Vine Date: Mon, 23 Apr 2012 01:35:28 -0400 Subject: [PATCH 4/8] Minor tweak to "YAML Conventions > level" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 80fb5c86..6c2676c5 100755 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Each of the articles on the site has some [YAML "Front Matter"](https://github.c `title: "jQuery Event Extensions"` -* level - the approximate level of jQuery experience required to find the article useful. must be `beginner`, `intermediate`, or `advanced` +* level - the approximate level of jQuery experience required to find the article useful. Options: `beginner`, `intermediate`, or `advanced` `level: advanced` From c2ff6c652ef1e32127c2cb193a15b31256f5ffb5 Mon Sep 17 00:00:00 2001 From: Jeremy Singer-Vine Date: Mon, 23 Apr 2012 01:42:07 -0400 Subject: [PATCH 5/8] Tweaks to "How Can I Help?" section, clarifying what you can/can't do without git. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6c2676c5..06362e61 100755 --- a/README.md +++ b/README.md @@ -56,9 +56,9 @@ attribution: ## How Can I Help? -The entire site is managed via [this Git repository](https://github.com/jquery/learn.jquery.com). If you'd like to contribute new articles, make edits to existing content, or work on the site itself, the first thing you'll need is a [fork](http://help.github.com/fork-a-repo/). When you have changes you'd like to have reviewed and integrated into the site, submit a [pull request](http://help.github.com/send-pull-requests/). +The entire site is managed via [this Git repository](https://github.com/jquery/learn.jquery.com). If you'd like to contribute new articles, make edits to existing content, or work on the site itself, the first thing you'll need is a [fork](http://help.github.com/fork-a-repo/). When you have changes you'd like to have reviewed for integration into the site, submit a [pull request](http://help.github.com/send-pull-requests/). -If you aren't already familiar with Git, you'll still need a fork and a GitHub account, but you can can edit files directly via [GitHub's in-browser editor](https://github.com/blog/905-edit-like-an-ace), but you won't be able to create new content. We encourage you to [learn how to use Git and GitHub](http://help.github.com/), it'll probably pretty useful no matter what. +If you're unfamiliary with Git, you can still contribute by editing files directly via [GitHub's in-browser editor](https://github.com/blog/905-edit-like-an-ace). But you won't be able to create new content, and you'll still need a GitHub account and a fork of this repository. So we encourage you to [learn how to use Git and GitHub](http://help.github.com/); it'll probably pretty useful no matter what. ## How Do I Get This Running Locally? From d2d7c9ccf7d663f3b3351747221a704762af6ca0 Mon Sep 17 00:00:00 2001 From: Jeremy Singer-Vine Date: Mon, 23 Apr 2012 01:44:40 -0400 Subject: [PATCH 6/8] Minor tweaks to final two README sections. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 06362e61..6bb0b0db 100755 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ The entire site is managed via [this Git repository](https://github.com/jquery/l If you're unfamiliary with Git, you can still contribute by editing files directly via [GitHub's in-browser editor](https://github.com/blog/905-edit-like-an-ace). But you won't be able to create new content, and you'll still need a GitHub account and a fork of this repository. So we encourage you to [learn how to use Git and GitHub](http://help.github.com/); it'll probably pretty useful no matter what. -## How Do I Get This Running Locally? +## How Do I Preview This Project Locally? *This project requires Ruby >= 1.9 and [Bundler](http://gembundler.com/). If you don't already have a Ruby development environment, please see the corresponding section below.* @@ -78,7 +78,7 @@ If you're unfamiliary with Git, you can still contribute by editing files direct `> nanoc watch` * The site should be running on http://localhost:3000. Use the `--port` option to specify a different port. -## I Don't (Know If I?) Already Have a Ruby Development Environment +## I Don't (Know If I) Already Have a Ruby Development Environment #### Mac OS X/Linux: From 8b04d5e5f292712a49f84d58a861df3b760fbbbe Mon Sep 17 00:00:00 2001 From: Jeremy Singer-Vine Date: Mon, 23 Apr 2012 01:49:47 -0400 Subject: [PATCH 7/8] Clarify history of jQuery Fundamentals and fix broken link to Murphey's website. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6bb0b0db..494902a2 100755 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ The goal of this site is twofold: 1. To serve as a central, trustworthy, narrative compendium of information about how to use jQuery and JavaScript. 2. To remain a timely, vibrant, and community-driven reference with a low barrier to contribution. -Much of the initial content - and spirit - is from [jQuery Fundamentals](https://github.com/rmurphey/jqfundamentals), an open-source book about jQuery. The book was originally released in 2010 by [Rebecca Murphey](http://www.rebeccamurphey.com/) and bequeathed unto the jQuery Project to serve as the foundation for this site. +Much of the initial content - and spirit - comes from [jQuery Fundamentals](https://github.com/rmurphey/jqfundamentals), an open-source book about jQuery, originally written by [Rebecca Murphey](http://www.rmurphey.com/) and released in 2010. In 2011, Murphey [bequeathed the book](http://rmurphey.com/blog/2011/03/17/the-future-of-jquery-fundamentals-and-a-confession/) unto the jQuery Project to serve as the foundation for this site. ## How This Site Works From 83a7ee91a6422a779c5cb70850527a878438d4f6 Mon Sep 17 00:00:00 2001 From: "adam j. sontag" Date: Mon, 23 Apr 2012 19:33:24 -0400 Subject: [PATCH 8/8] Fix typo in readme and continue to tweak local dev setup header --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 494902a2..2dec8433 100755 --- a/README.md +++ b/README.md @@ -58,10 +58,10 @@ attribution: The entire site is managed via [this Git repository](https://github.com/jquery/learn.jquery.com). If you'd like to contribute new articles, make edits to existing content, or work on the site itself, the first thing you'll need is a [fork](http://help.github.com/fork-a-repo/). When you have changes you'd like to have reviewed for integration into the site, submit a [pull request](http://help.github.com/send-pull-requests/). -If you're unfamiliary with Git, you can still contribute by editing files directly via [GitHub's in-browser editor](https://github.com/blog/905-edit-like-an-ace). But you won't be able to create new content, and you'll still need a GitHub account and a fork of this repository. So we encourage you to [learn how to use Git and GitHub](http://help.github.com/); it'll probably pretty useful no matter what. +If you're unfamiliar with Git, you can still contribute by editing files directly via [GitHub's in-browser editor](https://github.com/blog/905-edit-like-an-ace). But you won't be able to create new content, and you'll still need a GitHub account and a fork of this repository. So we encourage you to [learn how to use Git and GitHub](http://help.github.com/); it'll probably pretty useful no matter what. -## How Do I Preview This Project Locally? +## How Do I Set Up a Local Development and Preview Environment? *This project requires Ruby >= 1.9 and [Bundler](http://gembundler.com/). If you don't already have a Ruby development environment, please see the corresponding section below.*