Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(78)

Issue 11066080: Initial version of Dart web components article (Closed)

Created:
8 years, 2 months ago by Siggi Cherem (dart-lang)
Modified:
8 years, 2 months ago
CC:
reviews_dartlang.org
Base URL:
git@github.com:sigmundch/dartlang.org.git@master
Visibility:
Public.

Description

Initial version of Dart web components article. Committed: https://github.com/dart-lang/dartlang.org/commit/05d7d4b

Patch Set 1 #

Patch Set 2 : moved generated code elsewhere #

Total comments: 33

Patch Set 3 : roudn1 of comments #

Total comments: 30

Patch Set 4 : #

Patch Set 5 : #

Total comments: 14

Patch Set 6 : john's comments #

Total comments: 58

Patch Set 7 : #

Patch Set 8 : remove css changes for now #

Unified diffs Side-by-side diffs Delta from patch set Stats (+602 lines, -0 lines) Patch
A src/site/_plugins/code_sample.rb View 1 2 3 4 5 6 1 chunk +48 lines, -0 lines 0 comments Download
A src/site/articles/dart-web-components/index.markdown View 1 2 3 4 5 6 1 chunk +554 lines, -0 lines 0 comments Download

Messages

Total messages: 11 (0 generated)
Kathy Walrath
Here's a start, Siggi. A lot of my focus was on removing extra words and ...
8 years, 2 months ago (2012-10-09 23:16:57 UTC) #1
Siggi Cherem (dart-lang)
Thanks Kathy! this is really useful. I uploaded a new version addressing what you mentioned ...
8 years, 2 months ago (2012-10-09 23:51:08 UTC) #2
Jennifer Messerly
This is a great write up! I really enjoy how this builds up the story ...
8 years, 2 months ago (2012-10-10 01:18:28 UTC) #3
Siggi Cherem (dart-lang)
thanks! addressed most of your comments except for the references to API docs - I'll ...
8 years, 2 months ago (2012-10-10 01:50:41 UTC) #4
Siggi Cherem (dart-lang)
just added links to api docs...
8 years, 2 months ago (2012-10-10 02:10:20 UTC) #5
Jennifer Messerly
https://chromiumcodereview.appspot.com/11066080/diff/10004/src/site/_plugins/code_sample.rb File src/site/_plugins/code_sample.rb (right): https://chromiumcodereview.appspot.com/11066080/diff/10004/src/site/_plugins/code_sample.rb#newcode1 src/site/_plugins/code_sample.rb:1: copyright header? (p.s. sorry I forgot to review this ...
8 years, 2 months ago (2012-10-10 02:37:20 UTC) #6
Siggi Cherem (dart-lang)
Thanks! Thanks for the tips on the ruby code. I've never written ruby before, so ...
8 years, 2 months ago (2012-10-10 17:20:55 UTC) #7
Jennifer Messerly
lgtm https://chromiumcodereview.appspot.com/11066080/diff/10004/src/site/_plugins/code_sample.rb File src/site/_plugins/code_sample.rb (right): https://chromiumcodereview.appspot.com/11066080/diff/10004/src/site/_plugins/code_sample.rb#newcode18 src/site/_plugins/code_sample.rb:18: ("\n\n<table sytle='border:0px'><thead>" + On 2012/10/10 17:20:55, sigmund wrote: ...
8 years, 2 months ago (2012-10-10 17:48:03 UTC) #8
Kathy Walrath
Here's another go at it. Some overall comments: - Printing doesn't seem to work any ...
8 years, 2 months ago (2012-10-11 01:01:21 UTC) #9
Siggi Cherem (dart-lang)
On 2012/10/11 01:01:21, Kathy Walrath wrote: > Here's another go at it. Some overall comments: ...
8 years, 2 months ago (2012-10-11 01:53:17 UTC) #10
Siggi Cherem (dart-lang)
8 years, 2 months ago (2012-10-11 18:26:14 UTC) #11
Thanks once more Kathy, you are awesome :)

I made all the changes, and uploaded a new version here.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/_plugins/...
File src/site/_plugins/code_sample.rb (right):

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/_plugins/...
src/site/_plugins/code_sample.rb:24: "</td><td><strong>Sample
running</strong></td></tr>" +
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> Sample running -> Running sample
> 
> (or something else. what's important: make the first words of the two captions
> different. people scan, and they often don't notice anything but the first
> word.)

Interesting - thanks!

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
File src/site/articles/dart-web-components/index.markdown (right):

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:13: Updated: October 2012_
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> Delete the "Updated" line

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:43: Dart web components
provide a templating, data binding, and encapsulation, to
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> a templating -> templates

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:47: Many UI frameworks
exist for writing web apps in JavaScript -- for example
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> -- -> &mdash;
> (no spaces around it)

ah, thanks :)

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:50: frameworks directly
into the browser platform.  A result has been added features
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> I told you to do this, but it's too easy to read wrong. :( How about:
> 
> A result ... ->
> As a result, browsers have added features like ..., and other experimental and
> cool ideas have been proposed, such as ... (MDV).

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:58: In this article, we'll
walk through some examples that illustrate how to write
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> In this article, we'll walk -> This article walks

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:59: and use Dart web
components. Soon we'll be creating a document with a detailed
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> I initially thought that "Soon" meant "In this document", in part because I
> wasn't sure who "we" meant.) How about:
> 
> We plan to publish additional documents soon, including a detailed
specification
> and instructions for using Dart web component tools.

done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:61: component tools.
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> It could be helpful to stick a table of contents here. E.g., see:
> 
> http://www.dartlang.org/articles/js-dart-interop/
> 
> There doesn't appear to be an autogeneration for TOCs, but the IDs are
> automatically generated from heading text. Or you can specify your own ID
after
> a title, like this:
> 
> #### Contents {#toc}
> 
> Even if you don't show a TOC, it's helpful to have one during development so
you
> can see your structure clearly. E.g., creating one for your article made me
want
> to change the section headings/order a bit and change the "Upcoming features"
> from ### to ##. If you do everything I suggest, you'll have something like
this:
> 
>   MDV templates in Dart
>     One-way data binding
>     Two-way data binding
>     Conditionals
>     Loops
>     Event listeners
>     Summary of templates
>   Web components in Dart
>     Declaring a component
>     Instantiating a component
>     Passing data to a component
>     Importing a component
>   Upcoming features
>   Tools for using Dart web components
>   More information

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:66: succinct declarative
syntax. Dart web components closely follow the MDV syntax,
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> delete "declarative"? (it's repetitive due to the earlier "declare")
> 
> alternatively, change "declare" to "specify"

Done. Did the latter because I wanted to emphasize that the way you specify them
is in a declarative language.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:71: * **Events listeners**:
Easily attach code that reacts to UI events
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> Events listeners sounds weird to me.
> ->
> Event listeners
> ?
> 
> Also, the event listener section is after the Loops section, so move this item
> down to the end of the list.
> 
> (The reason: It's good to match order unless you have a good reason not to. It
> helps the reader know what to expect, and not waste time thinking. :)

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:75: We made some changes to
make sure that using Dart with MDV feels natural, but
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> make sure -> ensure 
> OR be sure
> 
> (to avoid repetition of "made")

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:79: ### One-way data
bindings
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> bindings -> binding
> 
> (Match the item in the list)

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:146: ### Two-way data
bindings
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> bindings -> binding

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:148: Two-way data bindings
lets us define that we want a DOM element's value
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> bindings -> binding

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:177: the text box, the
string and it's length will be updated in other parts of the
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> it's -> its
> 
> (if you think of 'his' and 'hers', then 'its' for possessive should be easier
to
> remember)

thanks :) - this is one where if I think about it I can see it, but I easily
read through it without noticing it :(

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:180: ### Data-binding
expressions
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> If you look at the TOC, this isn't like the other sections. Change it to a
note?
> I don't know how to do this in markdown, but I think you can just use HTML:
> 
> <aside>
>   <div class="alert alert-info">
>     <strong>A note about expressions:</strong>
>     ...words go here...
>   </div>
> </aside>
> 

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:188: between
`{{'{{'}}expressions}}`, however you can always hide complex expressions
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> between -> within
> 
> expressions}} -> expression}}
> globally
> (because there can be only one, correct?)

correct - thank you :)

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:226: Template loops allow
us to iterate over iterable Dart collections. The following
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> You should mention the `iterate` attribute in this description. Something
like:
> 
> To create a loop that operates on each item in a Dart collection, use the
> `iterate` attribute in a `<template>` tag.

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:281: ### Listen to UI
events
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> -> ### Event listeners

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:308: ### Templating summary
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> Templating summary -> Summary of templates
> 
> (Having the "Summary" first is a visual cue. Plus you've used "template", not
> "templating" before, so it's good to keep that consistent.)

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:312: model-view-viewmodel
architecture. One-way data bindings, two-way data bindings,
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> bindings -> binding
> (twice in this line; to match what we used before)

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:313: and data-action
listeners, help reduce the need for manually creating controller
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> , help -> help

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:422: ### Working at scale
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> -> ### Importing a component
> 
> (to match the task orientation of previous headings in this section, plus give
a
> bit more info)

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:452: ### Upcoming features
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> ### -> ##
> 
> (since these features are for templates as well as components)

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:457: * Support for
sub-components. Using a special `<content>` tag, a component
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> GLOBAL: sub-component -> subcomponent
> 
> (it's in the dictionary - I looked)

wow - cool. Thanks :)

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:487: ## Developing and
using Dart web components
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> -> ## Tools for developing and using Dart web components
> OR
> ## Tools for Dart web components
> 
> (having "Tools" first is very helpful)

nice - done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:504: ## Exploring more
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> ## Exploring more -> ## More information
> OR
> ## Resources
> 
> (I wasn't sure what to expect from "Exploring more", plus it just sounded like
> it was missing a word or two after "more")

:), fixed

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/articles/...
src/site/articles/dart-web-components/index.markdown:512: [issue tracker][bugs],
and play with other examples in our repo, like our port
On 2012/10/11 01:01:21, Kathy Walrath wrote:
> like -> such as
> 
> (in general, "like" is easy to misread. It has too many meanings.)

Done.

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/css/style...
File src/site/css/style.css (left):

https://chromiumcodereview.appspot.com/11066080/diff/13008/src/site/css/style...
src/site/css/style.css:13: >>>>>>> master
this is what looked like a merge conflict initially :(

Powered by Google App Engine
This is Rietveld 408576698