Update docs to support JSON conversion #77

Merged
merged 1 commit into from Nov 13, 2012

Projects

None yet

2 participants

@adarsh
  • Add notices on README.md and CONTRIBUTING.md regarding new JSON-only status
  • Update links to learn.thoughtbot or json file
  • Add gist for RegEx
  • Update Product Design link to old .md page
@gabebw gabebw and 1 other commented on an outdated diff Nov 13, 2012
CONTRIBUTING.md
@@ -1,14 +1,20 @@
Contributing
============
+NOTE: All PRs should now be in JSON-only
@gabebw
gabebw Nov 13, 2012

Maybe remove "NOTE" and "now"? Do people need to know that they weren't in JSON before?

Instead of "NOTE", how about making it a subheading?

@adarsh
adarsh Nov 13, 2012

Good point. I definitely want to let people know about the change.

I'll mute the anxiety.

@gabebw gabebw commented on an outdated diff Nov 13, 2012
CONTRIBUTING.md
* Address issues wherever possible
* Prefix commit messages with [#XX] if addressing an existing issue number
* Use the present tense in commit messages
* Shorten commit messages to 50 characters with bulleted details
+
@gabebw
gabebw Nov 13, 2012

extra whitespace

@gabebw gabebw commented on an outdated diff Nov 13, 2012
CONTRIBUTING.md
> How can I contribute to this project?
* Pull requests are always welcome
+* Pull requests should be in JSON format only
+* Considering using [this regex](https://gist.github.com/4068038) for converting md to json
@gabebw
gabebw Nov 13, 2012

md to json -> Markdown to JSON

@gabebw gabebw commented on an outdated diff Nov 13, 2012
CONTRIBUTING.md
> How can I contribute to this project?
* Pull requests are always welcome
+* Pull requests should be in JSON format only
+* Considering using [this regex](https://gist.github.com/4068038) for converting md to json
+* PRs should be validated before submission using [lint](https://github.com/zaach/jsonlint).
@gabebw
gabebw Nov 13, 2012

What about using jsonlint as the link text instead of lint?

@gabebw gabebw commented on an outdated diff Nov 13, 2012
README.md
@@ -1,3 +1,9 @@
+NOTE:
+=====
+
+As of 11/13/2012, this is now a JSON-only data resource. For browsing the
@gabebw
gabebw Nov 13, 2012

"To browse the trails"

@gabebw gabebw and 1 other commented on an outdated diff Nov 13, 2012
README.md
@@ -69,6 +76,6 @@ Thank you, [contributors](/thoughtbot/trail-map/graphs/contributors)!
License
-------
-Trail Map is © 2012 thoughtbot, inc. It is free software and may be
+Trail Map is ©2012 thoughtbot, inc. It is free software and may be
@gabebw
gabebw Nov 13, 2012

Did you mean to remove this?

@adarsh
adarsh Nov 13, 2012

I did - it looked funny. What's the convention?

@gabebw gabebw commented on an outdated diff Nov 13, 2012
CONTRIBUTING.md
> How can I contribute to this project?
* Pull requests are always welcome
+* Pull requests should be in JSON format only
@gabebw
gabebw Nov 13, 2012

"Pull requests must be in JSON format"

@gabebw gabebw and 1 other commented on an outdated diff Nov 13, 2012
CONTRIBUTING.md
@@ -1,7 +1,7 @@
Contributing
============
-> How can I contribute to this project?
+> "How can I contribute to this project?" -you
@gabebw
gabebw Nov 13, 2012

I don't think you need the attribution, here or below.

I think that having quotes makes it a little too informal (might just be me) but I'd definitely remove the " -you "

@adarsh
adarsh Nov 13, 2012

Agreed. That's the caffeine talking.

Adarsh Pandit 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
577c258
@adarsh adarsh merged commit 577c258 into master Nov 13, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment