From 577c2584ac09b0a961a75b0b73a35e4f968c151f Mon Sep 17 00:00:00 2001 From: Adarsh Pandit Date: Tue, 13 Nov 2012 11:48:04 -0800 Subject: [PATCH] Update docs to reflect new JSON scheme * Update `README.md` to include a notice of new direction * Update `CONTRIBUTING.md` with JSON info and linting before commiting * Update links to learn.thoughtbot or json file * Add gist for RegEx * Update Product Design link to old md page --- CONTRIBUTING.md | 7 +++++++ README.md | 44 +++++++++++++++++++++++++------------------- 2 files changed, 32 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b510a5..92fac77 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,13 @@ Contributing * Use the present tense in commit messages * Shorten commit messages to 50 characters with bulleted details + +> In which format should my contributions be submitted? + +* Pull requests should be in JSON format +* PRs should be validated before submission using [jsonlint](https://github.com/zaach/jsonlint). +* Considering using [this regex](https://gist.github.com/4068038) for converting Markdown to JSON + Merging Pull Requests (for admins) ---------------------------------- diff --git a/README.md b/README.md index c98eaae..b033d98 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +NOTE: +===== + +As of 11/13/2012, this is now a JSON-only data resource. To browse the trails, visit [learn.thoughtbot.com](https://learn.thoughtbot.com) + Trail map ========= @@ -30,25 +35,26 @@ To use these, you may want to first set up your laptop with Trails ------ -* [CSS](/thoughtbot/trail-map/blob/master/trails/css.md) -* [Code Review](/thoughtbot/trail-map/blob/master/trails/code-review.md) -* [Git](/thoughtbot/trail-map/blob/master/trails/git.md) -* [Grids](/thoughtbot/trail-map/blob/master/trails/grids.md) -* [HTML](/thoughtbot/trail-map/blob/master/trails/html.md) -* [Information Design](/thoughtbot/trail-map/blob/master/trails/information-design.md) -* [iOS](/thoughtbot/trail-map/blob/master/trails/ios.md) -* [Javascript](/thoughtbot/trail-map/blob/master/trails/javascript.md) -* [Open Source](/thoughtbot/trail-map/blob/master/trails/open-source.md) -* [Postgres](/thoughtbot/trail-map/blob/master/trails/postgres.md) -* [Rails](/thoughtbot/trail-map/blob/master/trails/rails.md) -* [Refactoring](/thoughtbot/trail-map/blob/master/trails/refactoring.md) -* [Ruby](/thoughtbot/trail-map/blob/master/trails/ruby.md) -* [Sass](/thoughtbot/trail-map/blob/master/trails/sass.md) -* [Test-Driven Development](/thoughtbot/trail-map/blob/master/trails/test-driven-development.md) -* [Typography](/thoughtbot/trail-map/blob/master/trails/typography.md) -* [Unix](/thoughtbot/trail-map/blob/master/trails/unix.md) -* [Vim](/thoughtbot/trail-map/blob/master/trails/vim.md) -* [Visual Design](/thoughtbot/trail-map/blob/master/trails/visual-design.md) +* [CSS](https://learn.thoughtbot.com/css) +* [Code Review](/thoughtbot/trail-map/blob/master/trails/code-review.json) +* [Design Principles](https://learn.thoughtbot.com/design+principles) +* [Git](https://learn.thoughtbot.com/git) +* [Grids](/thoughtbot/trail-map/blob/master/trails/grids.json) +* [HTML](/thoughtbot/trail-map/blob/master/trails/html.json) +* [Information Design](/thoughtbot/trail-map/blob/master/trails/information-design.json) +* [Javascript](https://learn.thoughtbot.com/javascript) +* [Open Source](/thoughtbot/trail-map/blob/master/trails/open-source.json) +* [Product Design](/thoughtbot/trail-map/blob/master/trails/product-design.md) +* [Postgres](/thoughtbot/trail-map/blob/master/trails/postgres.json) +* [Rails](https://learn.thoughtbot.com/rails) +* [Refactoring](https://learn.thoughtbot.com/refactoring) +* [Ruby](https://learn.thoughtbot.com/ruby) +* [Sass](https://learn.thoughtbot.com/sass) +* [Test-Driven Development](https://learn.thoughtbot.com/test-driven+development) +* [Typography](https://learn.thoughtbot.com/typography) +* [Unix](https://learn.thoughtbot.com/unix) +* [Vim](https://learn.thoughtbot.com/vim) +* [iOS](/thoughtbot/trail-map/blob/master/trails/ios.json) Contributing ------------