Updating the fetchdata tutorial to use DartPad, which involved modifying three examples.

Updating the tutorial to use DartPad, which involved modifying three examples.

BUG=
R=kathyw@google.com

Committed: 40e20a7a4186863ae4f36cc1981c21ffe92e261c

[shaza, 2015-07-28 21:06:21]

I also did some housekeeping in the graffle files, deleting some graphics that
are no longer needed and renaming files to reflect the actual exported image
name.

Staged: https://fetchdata-dot-dart-lang.appspot.com/docs/tutorials/fetchdata/

[kathyw, 2015-07-28 23:47:13]

Not done yet! A few comments so far:

In jsonstring.png, the highlighting for horoscope ("Cancer") is off.

In getstringfunction.png, the right side of the rectangle should be under the
colored boxes.

https://codereview.appspot.com/259010043/diff/1/src/site/docs/tutorials/fetch...
File src/site/docs/tutorials/fetchdata/index.markdown (right):

https://codereview.appspot.com/259010043/diff/1/src/site/docs/tutorials/fetch...
src/site/docs/tutorials/fetchdata/index.markdown:359: {% prettify dart %}
I think the previous code might be a clearer demonstration of how to use
JSON.encode() with various types. (The data itself isn't important; only the
calls to encode() are!)

[shaza, 2015-07-29 17:37:50]

PTAL:
https://fetchdata-dot-dart-lang.appspot.com/docs/tutorials/fetchdata/

https://codereview.appspot.com/259010043/diff/1/src/site/docs/tutorials/fetch...
File src/site/docs/tutorials/fetchdata/index.markdown (right):

https://codereview.appspot.com/259010043/diff/1/src/site/docs/tutorials/fetch...
src/site/docs/tutorials/fetchdata/index.markdown:359: {% prettify dart %}
On 2015/07/28 23:47:14, kathyw wrote:
> I think the previous code might be a clearer demonstration of how to use
> JSON.encode() with various types. (The data itself isn't important; only the
> calls to encode() are!)

Done.

[kathyw, 2015-07-29 18:19:18]

Looking good! No substantive changes required now.

It looks like you haven't done the image updates yet, and I've come up with
another one for you. Yay me.

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
File src/site/docs/tutorials/fetchdata/index.markdown (right):

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:440: 
Do you really need this blank line?

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:463: {% comment %} xxx {%
endcomment %}
Could you clarify this comment?

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:528: CORS is server-specific.
I think "server-specific" -> "server specific", since there's no noun there.

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:545: The example below reads a
data file from dartlang.org
This paragraph needs a little rewriting, since it's no longer all about reading
a file from the same origin.

Maybe we could have an implementation note that, before DartPad, this example
had a JSON file co-located with it. We couldn't do that with DartPad, since it
allows only 3 files (Dart, HTML, CSS), but we did happen to control a website
where we could set the CORS headers to allow read-only access, blah blah blah.

But say it better. :)

Maybe we should also show the code you'd use if you were reading it locally,
which is the usual case.

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:771: "bromance", "freeware",
"oxbridge", "palimony", "netiquette",
I like these updates. :)

But it looks like the portmanteaux-code.png needs to be updated to not show
"Brangelina".

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:797: [Asynchronous Programming:
Futures](/docs/tutorials/futures/),
Actually, that's the tutorial before the previous tutorial.

[shaza, 2015-07-29 21:57:08]

PTAL:
https://fetchdata-dot-dart-lang.appspot.com/docs/tutorials/fetchdata/

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
File src/site/docs/tutorials/fetchdata/index.markdown (right):

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:440: 
On 2015/07/29 18:19:18, kathyw wrote:
> Do you really need this blank line?

Nope!

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:463: {% comment %} xxx {%
endcomment %}
On 2015/07/29 18:19:18, kathyw wrote:
> Could you clarify this comment?

Nope, it just needs to be deleted.  :)

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:528: CORS is server-specific.
On 2015/07/29 18:19:18, kathyw wrote:
> I think "server-specific" -> "server specific", since there's no noun there.

Done.

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:545: The example below reads a
data file from dartlang.org
On 2015/07/29 18:19:18, kathyw wrote:
> This paragraph needs a little rewriting, since it's no longer all about
reading
> a file from the same origin.
> 
> Maybe we could have an implementation note that, before DartPad, this example
> had a JSON file co-located with it. We couldn't do that with DartPad, since it
> allows only 3 files (Dart, HTML, CSS), but we did happen to control a website
> where we could set the CORS headers to allow read-only access, blah blah blah.
> 
> But say it better. :)
> 
> Maybe we should also show the code you'd use if you were reading it locally,
> which is the usual case.

Done.

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:771: "bromance", "freeware",
"oxbridge", "palimony", "netiquette",
On 2015/07/29 18:19:18, kathyw wrote:
> I like these updates. :)
> 
> But it looks like the portmanteaux-code.png needs to be updated to not show
> "Brangelina".

Done.

https://codereview.appspot.com/259010043/diff/10001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:797: [Asynchronous Programming:
Futures](/docs/tutorials/futures/),
On 2015/07/29 18:19:18, kathyw wrote:
> Actually, that's the tutorial before the previous tutorial.

Done.

[kathyw, 2015-07-29 22:19:50]

It all looks good, except I'd like to delete some of the verbiage in the
implementation note.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
File src/site/docs/tutorials/fetchdata/index.markdown (right):

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:549: **Implementation note:**
This could be tighter. Suggestions below...

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:550: Prior to the release of
Prior ... apps, the Portmanteaux example loaded a local
->
The original portmanteaux example loaded a co-located

file. The following code...loaded:
->
file:

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:553: the Portmanteaux example
loaded a local copy of the JSON file.
Portmanteaux -> portmanteaux

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:558: try {
delete the try-catch, leaving just the `var path` line.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:566: DartPad supports, _at
most_, a single Dart file, a single (optional) HTML file,
How about:

When we moved the example into [**DartPad**](...),
we couldn't co-locate the JSON file
because DartPad supports at most 3 files:
one Dart file, one HTML file, and one CSS file.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:568: So, we moved
`portmanteaux.json` to dartlang.org and
So, we moved
->
The workaround was to move

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:569: configured the CORS
headers to allow read-only access.
configured the CORS headers...
->
configure dartlang.org's CORS headers
to allow read-only access from everywhere.

[shaza, 2015-07-29 22:35:19]

PTAL:
https://fetchdata-dot-dart-lang.appspot.com/docs/tutorials/fetchdata/

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
File src/site/docs/tutorials/fetchdata/index.markdown (right):

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:549: **Implementation note:**
On 2015/07/29 22:19:50, kathyw wrote:
> This could be tighter. Suggestions below...

Acknowledged.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:550: Prior to the release of
On 2015/07/29 22:19:50, kathyw wrote:
> Prior ... apps, the Portmanteaux example loaded a local
> ->
> The original portmanteaux example loaded a co-located
> 
> file. The following code...loaded:
> ->
> file:

Done.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:553: the Portmanteaux example
loaded a local copy of the JSON file.
On 2015/07/29 22:19:50, kathyw wrote:
> Portmanteaux -> portmanteaux

Done.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:558: try {
On 2015/07/29 22:19:50, kathyw wrote:
> delete the try-catch, leaving just the `var path` line.

Done.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:566: DartPad supports, _at
most_, a single Dart file, a single (optional) HTML file,
On 2015/07/29 22:19:50, kathyw wrote:
> How about:
> 
> When we moved the example into [**DartPad**](...),
> we couldn't co-locate the JSON file
> because DartPad supports at most 3 files:
> one Dart file, one HTML file, and one CSS file.

Done.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:568: So, we moved
`portmanteaux.json` to dartlang.org and
On 2015/07/29 22:19:50, kathyw wrote:
> So, we moved
> ->
> The workaround was to move

Done.

https://codereview.appspot.com/259010043/diff/20001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:569: configured the CORS
headers to allow read-only access.
On 2015/07/29 22:19:50, kathyw wrote:
> configured the CORS headers...
> ->
> configure dartlang.org's CORS headers
> to allow read-only access from everywhere.

Done.

[kathyw, 2015-07-29 22:59:48]

https://codereview.appspot.com/259010043/diff/30001/src/site/docs/tutorials/f...
File src/site/docs/tutorials/fetchdata/index.markdown (right):

https://codereview.appspot.com/259010043/diff/30001/src/site/docs/tutorials/f...
src/site/docs/tutorials/fetchdata/index.markdown:558: supports at most 3 files:
one dart file, one HTML file,
dart -> Dart

Otherwise, lgtm!

[shaza, 2015-07-29 23:07:26]

Committed patchset #5 (id:40001) manually as
40e20a7a4186863ae4f36cc1981c21ffe92e261c (presubmit successful).