Quick Start Guide #1007
Quick Start Guide #1007
Conversation
| run the following command: | ||
|
|
||
| ```sh | ||
| ember build |
There was a problem hiding this comment.
should we introduce --env production ? or too soon?
There was a problem hiding this comment.
The next paragraph does say that it packages everything into an optimized bundle, so it should really include that (or the friendlier -prod)
|
hi I haven't read this yet but |
|
Looks great here! |
| Serving on http://localhost:4200/ | ||
| ``` | ||
|
|
||
| (To stop the server at any time, type Ctrl-C in your terminal.) |
There was a problem hiding this comment.
Should this be included in the text block?
There was a problem hiding this comment.
I think this is just part of Tom's narration.
There was a problem hiding this comment.
@trek is correct, but @maclover7 does raise the good point that we don't tell newbs how to kill the server once they've started it.
|
Awesome! This is a great idea. What do you think about integrating this with the tutorial, so that a new Ember dev following along with the Guides starting at the beginning can use this page to create their app, and then the tutorial continues to build it out where the quickstart leaves off? Right now, the structure of the Getting Started and Tutorial sections looks like:
Maybe we could change it to something like:
If this or some variation makes sense, can you change this PR to be against the Thanks!! |
| ## Define a Route | ||
|
|
||
| Ember makes URLs the heart of your application, so you never build apps | ||
| that feel broken to your users. Before doing anything in Ember, first think |
There was a problem hiding this comment.
URLs the heart... never build apps that feel broken to your users.
For someone who hasn't internalized the zen of Ember they won't understand what this really means, or what makes apps broken wrt URLs.
|
|
||
| Ember makes URLs the heart of your application, so you never build apps | ||
| that feel broken to your users. Before doing anything in Ember, first think | ||
| about your application's URLs. |
There was a problem hiding this comment.
first think about your application's URLs.
This isn't actionable advice because you haven't helped the reader understand how to think about URLs. If you can't explain it right here, then you should instead try to get them excited about how either this guide will eventually teach it to them, or if you can't teach it to them in this guide, you should try to get them excited about how using Ember will teach it to them. Example: "Working with Ember will help you learn how to think about designing beautiful URL architectures for your apps."
|
I'm so glad you're doing this -- TBH this will help me get started personally! Is it worth having some sort of hints about where to go from here once you get to the end of the quick start guide? |
|
@dherman I'd personally like to see this transition into the rest of the tutorial. |
|
I had another idea - what about making this the first page of the Guides? We could shorten up the front matter that's there currently, and get people coding an Ember app right off the bat. |
|
I like the idea of using this quick start to also get people started toward the rest of our more "in-depth" tutorial |
Love this idea. |
| ```app/templates/people.hbs{-1,-2,-3,-4,-5,-6,-7,+8} | ||
| <h2>List of Scientists</h2> | ||
|
|
||
| <ul> |
There was a problem hiding this comment.
should this be a diff view? it shows both the old code and the new component even though we said "Replace" above
There was a problem hiding this comment.
@praxxis When rendered, it shows the previous code as "removed" (note the wonky diff syntax in the file name).
There was a problem hiding this comment.
@tomdale Re the wonky diff syntax, I'm not sure we're continuing to support that with the new redesign. It's not something we've had a need for up until now, but I've been seeing a few places here (and in the tutorial) where it might be handy.
@locks do you remember if we're adding in styling for diffs? We'd been contemplating killing that I thought ...
There was a problem hiding this comment.
With the proposed switch to highlight.js, does highlight.js support diff styling?
There was a problem hiding this comment.
@michaelrkn Per this: highlightjs/highlight.js#480 it'll either handle styling a .diff or a .js file but not both
|
Especially on quick start guide we should avoid using |
Why? |
|
@homu r+ |
|
|
Quick Start Guide After a few discussions with @wycats, we realized that the fact that there's no "try Ember in 5 minutes" resource was extremely harmful to adoption. This guide is my attempt to rectify that. It significantly expands on (and replaces) the old "Your First Ember App" section. Most other libraries and frameworks have something like this. You can compare it, for example, to [Angular 2's quickstart](https://angular.io/docs/js/latest/quickstart.html). One nice thing that Ember CLI does for us is eliminate almost all of the work happening in Angular's quickstart, so our quickstart can actually begin covering the conceptual model rather than just have the user type boilerplate code. I'd love to hear feedback, particularly from beginners. And I want to make sure this integrates well with the tutorial work @michaelrkn has been doing.
|
|
After a few discussions with @wycats, we realized that the fact that there's no "try Ember in 5 minutes" resource was extremely harmful to adoption. This guide is my attempt to rectify that. It significantly expands on (and replaces) the old "Your First Ember App" section.
Most other libraries and frameworks have something like this. You can compare it, for example, to Angular 2's quickstart. One nice thing that Ember CLI does for us is eliminate almost all of the work happening in Angular's quickstart, so our quickstart can actually begin covering the conceptual model rather than just have the user type boilerplate code.
I'd love to hear feedback, particularly from beginners. And I want to make sure this integrates well with the tutorial work @michaelrkn has been doing.