Permalink
Browse files

Convert trails from markdown to JSON

* The trail-map is now JSON-only for use at learn.thoughtbot.com
* All Pull Requests should update the JSON as per CONTRIBUTING.md

Notes on this commit:

Convert ruby trail to json
Convert code-review to json
Convert css trail to json
Convert git trail to json
Convert grids trail to json
Convert html trail to json
Convert information-design trail to json
Convert ios trail to json
Convert Javascript trail to JSON
Convert open-source trail to json
Add prerequisites to open-source trail
Convert postgres trail to json
Convert rails trail to json
Convert refactoring trail to json
Convert rubymotion trail to json
Convert sass trail to json
Convert test-driven-development trail to json
Convert typography trail to json
Convert unix trail to json
Convert vim trail to json
Convert visual-design trail to json
Lint json and resolve errors
Add descriptions to trails
Use name instead of title in ruby trail resources

Change resource json to match <a> tag properties
* url => uri
* name => title

Rename visual-design and postgres trails
* Visual Design => Design Principles
* Postgres => SQL
Fix typo in git trail
Fix capitalization of trail names
Refactor test-driven-development into testing trail

Remove markdown-style code ticks ("`")
* Code ticks are not currently being parsed in json, and as such
  currently distract from content rather than adding clarity.
* The parsed trail-maps on learn.thoughtbot.com/javascript, for
  example, look fine without <code> wrappers.
* If we miss these, we can always bring them back.

Simplify format of validations in trails

* Always use an array of strings as the validations for a step
* This is in keeping with the original intention of the json trail-map
  spec.
* Links can be added by including them in the validations string, but in
  general should not be used in validations and will likely fit better
  as a resource.

Fix formatting of ruby trail

* For some reason, there was an invalid "guides" element. This has been
  converted into a step
  • Loading branch information...
1 parent 4d60e67 commit b16f7507a18aafff597930cd862b93a50da5c5aa @calebthompson calebthompson committed with Adarsh Pandit Oct 9, 2012
@@ -0,0 +1,39 @@
+{
+ "name": "Code Review",
+ "description": "A peer review of source code. It is intended to find and fix mistakes overlooked in the initial development phase, improving both the overall quality of software and the developers' skills.",
+ "steps": [
+ {
+ "name": "Read about code reviews.",
+ "resources": [
+ {
+ "title": "Feature branch code reviews",
+ "uri": "http://goo.gl/jIcOv"
+ },
+ {
+ "title": "Best practices of peer code review",
+ "uri": "http://goo.gl/A8Boc"
+ }
+ ]
+ },
+ {
+ "name": "Review someone else's code",
+ "validations": [
+ "Comment on a specific line number.",
+ "Comment constructively and politely.",
+ "Learn something valuable from the comments.",
+ "Express appreciation to the author.",
+ "Review the code in a timely manner."
+ ]
+ },
+ {
+ "name": "Have your code reviewed",
+ "validations": [
+ "Create small pull requests, which are easier to review.",
+ "Take comments as constructive and not personal criticism.",
+ "Learn something valuable from the comments.",
+ "Express appreciation to the reviewer.",
+ "Respond to comments in a timely manner."
+ ]
+ }
+ ]
+}
View
@@ -1,27 +0,0 @@
-Code Review
-===========
-
-Critical Learning
------------------
-
-* Read [feature branch code reviews](http://goo.gl/jIcOv).
-* Read [Best Practices of Peer Code Review](http://goo.gl/A8Boc).
-
-Validation
-----------
-
-You know how to review code when you can:
-
-* Comment on a specific line number.
-* Comment constructively and politely.
-* Learn something valuable from the comments.
-* Express appreciation to the author.
-* Review the code in a timely manner.
-
-You know how to have your code reviewed when you can:
-
-* Create small pull requests, which are easier to review.
-* Take comments as constructive and not personal criticism.
-* Learn something valuable from the comments.
-* Express appreciation to the reviewer.
-* Respond to comments in a timely manner.
View
@@ -0,0 +1,47 @@
+{
+ "name": "CSS",
+ "description": "A language used for describing the the look and formatting of HTML.",
+ "steps": [
+ {
+ "name": "Learn the basics",
+ "references": [
+ {
+ "title": "CSS3 for Web Designers",
+ "uri": "http://www.abookapart.com/products/css3-for-web-designers"
+ },
+ {
+ "title": "CSS Floats 101",
+ "uri": "http://www.alistapart.com/articles/css-floats-101/"
+ },
+ {
+ "title": "CSS Positioning 101",
+ "uri": "http://www.alistapart.com/articles/css-positioning-101/"
+ }
+ ],
+ "validations": [
+ "Control each part of the box model (width, height, padding, border).",
+ "Layout objects with floats",
+ "Space text.",
+ "Style text."
+ ]
+ },
+ {
+ "name": "Expand your knowledge",
+ "references": [
+ {
+ "title": "Responsive Web Design",
+ "uri": "http://www.abookapart.com/products/responsive-web-design"
+ },
+ {
+ "title": "Code Academy Web Fundamentals",
+ "uri": "http://www.codecademy.com/tracks/web"
+ }
+ ],
+ "validations": [
+ "Build a grid.",
+ "Minimize problems with browser defaults.",
+ "Use @media queries to provide different layouts to devices with differing widths."
+ ]
+ }
+ ]
+}
View
@@ -1,25 +0,0 @@
-CSS
-===
-
-Critical learning
------------------
-
-* Read [CSS3 for Web Designers](http://www.abookapart.com/products/css3-for-web-designers).
-* Read [CSS Floats 101](http://www.alistapart.com/articles/css-floats-101/).
-* Read [CSS Positioning 101](http://www.alistapart.com/articles/css-positioning-101/).
-* Read [Responsive Web Design](http://www.abookapart.com/products/responsive-web-design).
-* Complete [Code Academy Web Fundamentals](http://www.codecademy.com/tracks/web).
-
-Validation
-----------
-
-You know everyday CSS when you can:
-
-* Build a grid.
-* Control each part of the box model (width, height, padding, border).
-* Layout objects with floats.
-* Minimize problems with browser defaults.
-* Space text.
-* Style text.
-* Use `@media` queries to provide different layouts to devices with differing
- widths.
@@ -0,0 +1,56 @@
+{
+ "name": "Design Principles",
+ "description": "The fundamental ideas about the practice of good visual design.",
+ "prerequisites": [
+ "css",
+ "grids",
+ "html",
+ "typography"
+ ],
+ "steps": [
+ {
+ "name": "Critical Learning",
+ "resources": [
+ {
+ "title": "Read Visual Grammar.",
+ "uri": "http://amzn.to/visual-grammar"
+ },
+ {
+ "title": "Read Universal Principles of Design.",
+ "uri": "http://amzn.to/universal-principles"
+ },
+ {
+ "title": "Read Andy Rutledge's \"Gestalt Principles\":"
+ },
+ {
+ "title": "1",
+ "uri": "http://www.andyrutledge.com/gestalt-principles-1-figure-ground-relationship.php"
+ },
+ {
+ "title": "2",
+ "uri": "http://www.andyrutledge.com/gestalt-principles-2-similarity.php"
+ },
+ {
+ "title": "3",
+ "uri": "http://www.andyrutledge.com/gestalt-principles-3.php"
+ },
+ {
+ "title": "4",
+ "uri": "http://www.andyrutledge.com/common-fate.php"
+ },
+ {
+ "title": "5",
+ "uri": "http://www.andyrutledge.com/closure.php"
+ },
+ {
+ "title": "Read 101 Things I Learned in Architecture School",
+ "uri": "http://amzn.to/101-things-learned"
+ }
+ ],
+ "validations": [
+ "Intentionally break visual design principles in your design.",
+ "Use the vocabulary of visual design principles when articulating the reasons for your design and when critiquing teammates' designs."
+ ]
+ }
+ ]
+}
View
@@ -0,0 +1,134 @@
+{
+ "name": "Git",
+ "description": "A distributed revision control and source code management system with an emphasis on speed.",
+ "steps": [
+ {
+ "name": "Learn everyday git",
+ "resources": [
+ {
+ "title": "Try Git",
+ "uri": "http://try.github.com"
+ },
+ {
+ "title": "Watch the Normal Workflow gitcast",
+ "uri": "http://blip.tv/scott-chacon/c2-normal-workflow-4113486"
+ }
+ ],
+ "validations": [
+ "Initialize a repository",
+ "Clone a repository",
+ "Ignore files",
+ "Add a file to staging",
+ "Unstage a file",
+ "Check status",
+ "View a diff",
+ "Create a commit",
+ "Push to origin",
+ "Pull remote changes locally",
+ "Resolve a conflict",
+ "Create a branch",
+ "Merge a branch into master",
+ "Push to a remote branch",
+ "Rebase origin/master into a branch"
+ ]
+ },
+ {
+ "name": "Intermediate Git",
+ "resources": [
+ {
+ "title": "Watch the Distributed Workflow gitcast.",
+ "uri": "http://blip.tv/scott-chacon/c8-dist-workflow-4113615"
+ },
+ {
+ "title": "Read Chapter 3 of Pro Git",
+ "uri": "http://git-scm.com/book/en/Git-Branching"
+ },
+ {
+ "title": "Read gitready articles that interest you.",
+ "uri": "http://gitready.com"
+ }
+ ],
+ "validations": [
+ "Add a remote",
+ "Amend a commit",
+ "Show a commit by SHA hash",
+ "Stash changes",
+ "Squash commits",
+ "Create a tag"
+ ]
+ },
+ {
+ "name": "Advanced Git",
+ "resources": [
+ {
+ "title": "git-clone",
+ "uri": "http://git-scm.com/docs/git-clone"
+ },
+ {
+ "title": "git-init",
+ "uri": "http://git-scm.com/docs/git-init"
+ },
+ {
+ "title": "git-add",
+ "uri": "http://git-scm.com/docs/git-add"
+ },
+ {
+ "title": "git-branch",
+ "uri": "http://git-scm.com/docs/git-branch"
+ },
+ {
+ "title": "git-checkout",
+ "uri": "http://git-scm.com/docs/git-checkout"
+ },
+ {
+ "title": "git-commit",
+ "uri": "http://git-scm.com/docs/git-commit"
+ },
+ {
+ "title": "git-diff",
+ "uri": "http://git-scm.com/docs/git-diff"
+ },
+ {
+ "title": "git-merge",
+ "uri": "http://git-scm.com/docs/git-merge"
+ },
+ {
+ "title": "git-pull",
+ "uri": "http://git-scm.com/docs/git-pull"
+ },
+ {
+ "title": "git-push",
+ "uri": "http://git-scm.com/docs/git-push"
+ },
+ {
+ "title": "git-rebase",
+ "uri": "http://git-scm.com/docs/git-rebase"
+ },
+ {
+ "title": "git-reset",
+ "uri": "http://git-scm.com/docs/git-reset"
+ },
+ {
+ "title": "git-show",
+ "uri": "http://git-scm.com/docs/git-show"
+ },
+ {
+ "title": "git-stash",
+ "uri": "http://git-scm.com/docs/git-stash"
+ },
+ {
+ "title": "git-status",
+ "uri": "http://git-scm.com/docs/git-status"
+ }
+ ],
+ "validations": [
+ "Cherry pick commits",
+ "Reorder commits",
+ "Keep either file in merge conflicts",
+ "Restore lost commits",
+ "Visualize commits differently using git log flags",
+ "Visualize changes differently using git diff flags"
+ ]
+ }
+ ]
+}
Oops, something went wrong.

0 comments on commit b16f750

Please sign in to comment.