Skip to content

Commit d6a31c4

Browse files
committed
Long time coming: drop all ruby/nanoc in favor of wintersmith wrapped by grunt
We lose a few features that were working properly in nanoc, but we can reimplement them quickly and strategically now that the hurdle of getting the old build out of master is accomplished
1 parent b97a034 commit d6a31c4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+204
-1361
lines changed

.rbenv-gemsets

Lines changed: 0 additions & 1 deletion
This file was deleted.

.rbenv-version

Lines changed: 0 additions & 1 deletion
This file was deleted.

Gemfile

Lines changed: 0 additions & 8 deletions
This file was deleted.

Gemfile.lock

Lines changed: 0 additions & 28 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# The jQuery Learning Site
22

33
* Primary Domain: [http://learn.jquery.com](http://learn.jquery.com)
4-
* Staging Domain: [http://stage.learn.jquery.com](http://stage.learn.jquery.com) *(not currently up to date)*
4+
* Staging Domain: [http://stage.learn.jquery.com](http://stage.learn.jquery.com)
55

66
## About
77

@@ -10,7 +10,7 @@ The goal of this site is twofold:
1010
1. To serve as a central, trustworthy, narrative compendium of information about how to use jQuery and JavaScript.
1111
2. To remain a timely, vibrant, and community-driven reference with a low barrier to contribution.
1212

13-
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.
13+
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, Rebecca [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.
1414

1515

1616
## How This Site Works
@@ -37,68 +37,17 @@ Each of the articles on the site has some [YAML "Front Matter"](https://github.c
3737

3838
`level: advanced`
3939

40-
* github - the github username of the person to whom the article should be [publicly attributed in the footer](http://learn.jqnetwork.dev/using-jquery-core/feature-browser-detection/). defaults to `jquery`. **We will likely be improving this to use GitHub's API to figure out who's worked a given article**
41-
42-
`github: dmethvin`
43-
44-
In addition, there is an `attribution` property, which contains a list of names of people who have worked on the article. It is not used in the site rendering, but is there for what we'll refer to as "historical purposes," as it is most often used to refer to work originally from jQuery Fundamentals. It can be a simple
45-
46-
`attribution: jQuery Fundamentals`
47-
48-
or a YAML list
49-
50-
```
51-
attribution:
52-
- jQuery Fundamentals
53-
- Johnny Appleseed
54-
```
55-
56-
5740
## How Can I Help?
5841

5942
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/).
6043

6144
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.
6245

46+
## Building && Working Locally
6347

64-
## How Do I Set Up a Local Development and Preview Environment?
65-
66-
*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.*
67-
68-
*If you **only** want to work with and edit content, you don't actually have to get the project running locally, you can just edit/add Markdown content inside of the `content` directory. Of course, you won't be able to preview your content locally*
69-
70-
* Clone/fork this repo<br/>
71-
* Change to the newly cloned repository's directory<br/>
72-
`> cd learn.jquery.com`
73-
* Install the dependencies<br/>
74-
`> gem install bundler && bundle install`
75-
* Run the nanoc server<br/>
76-
`> nanoc view &`
77-
* Set the site to watch for changes and re-compile<br/>
78-
`> nanoc watch`
79-
* The site should be running on http://localhost:3000. Use the `--port` option to specify a different port.
80-
81-
## I Don't (Know If I) Already Have a Ruby Development Environment
82-
83-
#### Mac OS X/Linux:
84-
85-
You actually probably already **do** have some Ruby available, but it's probably not Ruby 1.9. We recommend setting up:
86-
87-
* [rbenv](https://github.com/sstephenson/rbenv)
88-
* [ruby-build](https://github.com/sstephenson/ruby-build)
89-
* [rbenv-bundler](https://github.com/carsomyr/rbenv-bundler)
90-
* [rbenv-gemset](https://github.com/jamis/rbenv-gemset)
91-
92-
Once you get that all squared away (and yes, we know that might be a big 'once'), you'll want to set your fork to use the Ruby > 1.9 you installed while you were setting up `rbenv`.
93-
94-
`cd ~/THE_DIRECTORY_WHERE_YOU_CLONE_GIT_REPOS/learn.jquery.com`
95-
`rbenv local 1.9.3-p0`
96-
97-
Then, you can follow the instructions above, starting at "Install the dependencies"
98-
99-
#### Windows
48+
As this site is part of the jQuery network of sites, its presentation is controlled by our [web base template](https://github.com/jquery/web-base-template). To preview the site locally, first follow the [instructions there](https://github.com/jquery/web-base-template) to set up a local version of the jQuery WordPress network. Then, clone this repo and run the following steps (node.js required).
10049

101-
* Grab the latest Ruby package from the Windows-only [rubyinstaller.org](http://rubyinstaller.org/)
102-
* Install it
103-
* [Meta-bullet point: This section probably lacks detail. If a Windows-Ruby developer wants to help us flesh this section out, **please do**!]
104-
* Follow the instructions above, starting at "Install the dependencies"
50+
1. `npm install`
51+
2. `cp config-sample.json config.json`
52+
3. Edit config.json to use the username and password for your local WordPress network
53+
4. `grunt`

Rakefile

Lines changed: 0 additions & 1 deletion
This file was deleted.

Rules

Lines changed: 0 additions & 189 deletions
This file was deleted.

config-sample.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
{
2+
"output": "./page",
3+
"contents": "./content",
4+
"templates": "./layouts",
5+
"locals": {
6+
"url": "http://learn.jquery.com",
7+
"name": "jQuery Learning Site",
8+
"owner": "jQuery Foundation"
9+
},
10+
"plugins": ["/node_modules/wintersmith-ordered-pages/plugin.coffee"],
211
"url": "dev.learn.jquery.com",
312
"username": "admin",
4-
"password": "secret"
13+
"password": "sample"
514
}

0 commit comments

Comments
 (0)