updated getting started with a more clearly defined workflow and steps

CartoDB / torque

Temporal mapping for CARTO

http://cartodb.github.com/torque/

BSD 4-Clause "Original" or "Old" License

397 stars 129 forks source link

updated getting started with a more clearly defined workflow and steps #252

Closed csobier closed 8 years ago

csobier commented 8 years ago

For Docs issue#644

@fdansv & @rochoa , I know you edited the Torque Getting Started section before it was published, as you didn't think the overview details and workflow needed to be defined for the Developer audience. However, the first comment in regards to the live Torque.js content was that the Getting Started was missing the required library information. I think it's valuable to include these details back into the overview section (as it is not available anywhere else in the docs). See the propose changes.

csobier commented 8 years ago

I thought we decided not to show any version specific links, as they are subject to change? That is why i used the more generic link. However, I just changed back to the version specific link, as instructed.

fdansv commented 8 years ago

I've no issues with the introduction, but lines 72 to 90 should be removed because:

Libraries in js are not "installed". The guide already says you should add torque in the html document
There is no need for the user to know about alternative connectors if this is a getting started guide. (L74-79)
L76-87: this is redundant information, it's been already noted that the torque library should be used.
L88-90: specifications don't need to be "included", and the user doesn't even need to follow them as they are an implementation detail. Users of the library don't need to know about specs.

The rest is OK

csobier commented 8 years ago

Okay @fdansv , sounds good. But since this the only resource for Torque.js content, I've reworded some steps and kept the links for more advanced resource information.

Let me know if this is Okay?

csobier commented 8 years ago

@fdansv , I think I updated the tilejson example link correctly for you, please confirm. What do you want to do about the Nürburgring track map not showing any features? Shall I remove it for now?

csobier commented 8 years ago

ping @fdansv ! Can we discuss so that we can agree merge these changes?

fdansv commented 8 years ago

I'm sorry but it's not that those steps are optional, they're incorrect. I'm happy to merge improvements to the guide that's already in master, but not adding bits of the previously rejected guide that either don't add any useful information to it, make it more confusing to use the library, or are just wrong.

csobier commented 8 years ago

Okay, so what do you suggest (specifically) to be removed from this branch and what other resources are you referring to? See latest commits, I took my best guess.

fdansv commented 8 years ago

I specifically suggest to keep getting_started.md as it is in the master branch.

csobier commented 8 years ago

As per @fdansv , rejected. No additional information is required. Closing issue.