Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit 8ac346b

Browse files
committed
docs(quickstart): incorporates Igor 11/16 feedback
1 parent d22d2ae commit 8ac346b

File tree

8 files changed

+62
-67
lines changed

8 files changed

+62
-67
lines changed

public/docs/_examples/quickstart/ts/app/app.module.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ import { Component, NgModule } from '@angular/core';
33
import { BrowserModule } from '@angular/platform-browser';
44

55
@Component({
6-
template: `<h1>Hello Angular</h1>`,
6+
template: `<h1>Hello {{title}}</h1>`,
77
selector: 'my-app'
88
})
9-
class AppComponent { }
9+
class AppComponent { title = 'Angular'; }
1010

1111
@NgModule({
1212
imports: [ BrowserModule ],

public/docs/_examples/setup/ts/app/app.component.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
import { Component } from '@angular/core';
33

44
@Component({
5-
selector: 'my-app',
6-
template: `<h1>Hello Angular</h1>`
5+
template: `<h1>Hello {{title}}</h1>`,
6+
selector: 'my-app'
77
})
8-
export class AppComponent { }
8+
export class AppComponent { title = 'Angular'; }

public/docs/ts/latest/guide/_data.json

+6-8
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,6 @@
1515
"basics": true
1616
},
1717

18-
"setup": {
19-
"title": "Setup for local development",
20-
"navTitle": "Setup",
21-
"intro": "Setup a local development environment",
22-
"nextable": true,
23-
"basics": true
24-
},
25-
2618
"architecture": {
2719
"title": "Architecture Overview",
2820
"navTitle": "Architecture",
@@ -152,6 +144,12 @@
152144
"intro": "Developing for content security in Angular applications"
153145
},
154146

147+
"setup": {
148+
"title": "Setup for local development",
149+
"navTitle": "Setup",
150+
"intro": "Install the Angular QuickStart seed for faster, more efficient development on your machine"
151+
},
152+
155153
"setup-systemjs-anatomy": {
156154
"title": "Setup Anatomy",
157155
"intro": "Inside the local development environment for SystemJS"

public/docs/ts/latest/guide/displaying-data.jade

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ figure.image-display
3636

3737

3838
Follow the [setup](setup.html) instructions for creating a new project
39-
named <ngio-ex path= <ngio-ex path="displaying-data"></ngio-ex>.
39+
named <ngio-ex path="displaying-data"></ngio-ex>.
4040

4141
:marked
4242
Then modify the <ngio-ex path="app.component.ts"></ngio-ex> file by

public/docs/ts/latest/guide/learning-angular.jade

+5-8
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,11 @@ figure
1111
Those new to Angular may wish to follow this popular learning path.
1212
<br clear="all">
1313
:marked
14-
1. Try the [QuickStart](../quickstart.html)'s live coding example, "Hello, Angular".
15-
16-
1. [Setup](setup.html) your local enviroment for efficient application development
17-
both online and offline.
18-
19-
1. Take the *Tour of Heroes* [tutorial](../tutorial), which picks up where QuickStart leaves off,
20-
and builds a simple data-driven app. The app demonstrates the essential characteristics of a professional application:
21-
a sensible project structure, data binding, master/detail, services, dependency injection, navigation, and remote data access.
14+
1. Take the [*Tour of Heroes* tutorial](../tutorial "Tour of Heroes").
15+
16+
The *Tour of Heroes* takes you step-by-step from the [QuickStart](../quickstart.html)
17+
to a full-featured example that demonstrates the essential characteristics of a professional application:
18+
a sensible project structure, data binding, master/detail, services, dependency injection, navigation, and remote data access.
2219

2320
1. Read the [Architecture](architecture.html) overview for the big picture.
2421

public/docs/ts/latest/guide/setup-systemjs-anatomy.jade

+1-18
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ table(width="100%")
4545
tr
4646
td
4747
code.
48-
.dockerignore<br>
4948
.editorconfig<br>
5049
.git/...<br>
5150
.gitignore<br>
@@ -60,14 +59,6 @@ table(width="100%")
6059
:marked
6160
The history of changes to the _QuickStart_ repository.
6261
Delete or ignore.
63-
tr
64-
td <code>Dockerfile</code>
65-
td
66-
:marked
67-
A Docker configuration file.
68-
Delete or ignore unless you know and use
69-
<a href="https://www.docker.com/" target="_blank" title="Docker software containerization">docker</a>
70-
to build and ship your application.
7162
tr
7263
td <code>favicon.ico</code>
7364
td
@@ -127,9 +118,7 @@ table(width="100%")
127118
td <code>styles.css</code>
128119
td
129120
:marked
130-
The <a href="https://github.com/angular/angular.io/blob/master/public/docs/_examples/_boilerplate/styles.css"
131-
target="_blank" title="CSS styles for Angular documentation samples">master CSS styles</a>
132-
shared by all documentation samples.
121+
Global styles for the application. Initialized with an `<h1>` style for the QuickStart demo.
133122

134123
tr
135124
td <code>systemjs<br>.config.js</code>
@@ -162,9 +151,3 @@ table(width="100%")
162151

163152
This file defines linting rules favored by the
164153
[Angular style guide](style-guide.html) and by the authors of the documentation.
165-
tr
166-
td <code>wallaby.js</code>
167-
td
168-
:marked
169-
Configuration for the <a href="https://wallabyjs.com/" target="_blank" title="Wallaby integrated testing tool">wallaby</a>
170-
unit test runner extension, available for many code editors.

public/docs/ts/latest/guide/setup.jade

+40-25
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,54 @@ block includes
1010

1111
As much fun as this is
1212
* you can't ship your app in plunker
13-
* development in the browser is slow
14-
* you aren't always online
13+
* you aren't always online when writing code
14+
* transpiling TypeScript in the browser is slow
1515
* the type support, refactoring, and code completion only work in your local IDE
1616

1717
# Setup a local development environment
1818

19-
Fortunately, setting up a local development environment is quick and easy:
20-
1. `git clone` the [**QuickStart** repository](https://github.com/angular/quickstart "Clone the github QuickStart repo")
21-
into an empty project file (e.g., `my-project`)
19+
Fortunately, setting up a new project in your local development environment is quick and easy
20+
with the [**QuickStart seed**](https://github.com/angular/quickstart "Install the github QuickStart repo"),
21+
a repository on github.
22+
23+
Make sure you have [node and npm installed](#install-node "What if you don't have node?").
24+
Then ...
25+
1. [clone](#clone) or [download](#download) the **QuickStart seed repository**.
2226
1. [install the `npm` packages](#install-node "What if you don't have node?")
23-
1. run it
27+
1. run `npm start` to launch the sample application
28+
29+
a#clone
30+
:marked
31+
### Clone
32+
33+
Perform the _clone-to-launch_ steps with these terminal commands.
2434

2535
code-example(language="sh" class="code-shell").
2636
git clone https://github.com/angular/quickstart.git my-project
2737
cd my-project
2838
npm install
2939
npm start
3040

41+
a#download
3142
:marked
32-
### No git? Download the zip!
33-
34-
If you don't have `git`, you can download and unzip the repository contents.
43+
### Download
44+
<a href="https://github.com/angular/quickstart/archive/master.zip" title="Download the QuickStart seed repository">Download the QuickStart seed</a>
45+
and unzip it into your project folder. Then perform the remaining steps with these terminal commands.
3546

36-
1. open [`https://github.com/angular/quickstart`](https://github.com/angular/quickstart) in a browser
37-
1. click the <span style="color: green;">green <b>"Clone or download"</b></span> button,
38-
then the <span style="color: blue;">blue <b>"Download zip"</b></span> button
39-
1. move the downloaded zip file to the `my-project` folder and unzip it
40-
1. [install the `npm` packages](#install-node "What if you don't have node?")
41-
1. run it
47+
code-example(language="sh" class="code-shell").
48+
cd my-project
49+
npm install
50+
npm start
4251

43-
## What's different about the setup?
52+
.l-main-section
53+
:marked
54+
## What's different about the QuickStart Seed?
4455

45-
The setup (zip or clone) delivers the same application as the [QuickStart](../quickstart.html "Angular QuickStart"),
46-
a fact you can confirm with the <live-example></live-example>.
56+
The QuickStart seed contains the same application as the <live-example><i>live code</i> QuickStart</live-example>.
57+
But there are _many more files_ in the project folder on your machine,
58+
most of which you can [learn about later](setup-systemjs-anatomy.html "Setup Anatomy").
4759

48-
But there are _many more files_ in the project folder on your machine.
49-
Ignore all but three of them for now and
50-
[learn about the others later](setup-systemjs-anatomy.html "Setup Anatomy").
51-
52-
Focus on these three TypeScript (`.ts`) files in the **`/app`** folder.
60+
Focus on the following three TypeScript (`.ts`) files in the **`/app`** folder.
5361

5462
.filetree
5563
.file app
@@ -99,10 +107,16 @@ table(width="100%")
99107
That's the only choice when running in the live-coding browser environment.
100108
You'll learn about other compiling and deployment options later in the documentation.
101109

102-
#install-node
103110
.l-main-section
104111
:marked
105-
## Prerequisites: _node_ and _npm_
112+
## Next Step
113+
114+
If you're new to Angular, try the recommended [learning path](learning-path.html).
115+
116+
a#install-node
117+
.l-main-section
118+
:marked
119+
## Appendix: _node_ and _npm_
106120

107121
Node.js and npm are essential to modern web development with Angular and other platforms.
108122
Node powers client development and build tools.
@@ -118,3 +132,4 @@ table(width="100%")
118132
We recommend [nvm](https://github.com/creationix/nvm) for managing multiple versions of node and npm.
119133
You may need [nvm](https://github.com/creationix/nvm) if you already have projects running on your machine that
120134
use other versions of node and npm.
135+

public/docs/ts/latest/tutorial/toh-pt1.jade

+4-2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ include ../_util-fns
33
:marked
44
Every story starts somewhere. Our story starts where the [QuickStart](../quickstart.html) ends.
55

6+
## Setup to develop locally
7+
68
Follow the [setup](../guide/setup.html) instructions for creating a new project
79
named <ngio-ex path="angular-tour-of-heroes"></ngio-ex>
810
after which the file structure should look like this:
@@ -41,13 +43,13 @@ code-example(language="sh" class="code-shell").
4143
## Show our Hero
4244
We want to display Hero data in our app
4345

44-
Let's add two properties to our `AppComponent`, a `title` property for the application name and a `hero` property
46+
Update the `AppComponent` so it has two properties: &nbsp; a `title` property for the application name and a `hero` property
4547
for a hero named "Windstorm".
4648

4749
+makeExample('toh-1/ts-snippets/app.component.snippets.pt1.ts', 'app-component-1', 'app.component.ts (AppComponent class)')(format=".")
4850

4951
:marked
50-
Now we update the template in the `@Component` decoration with data bindings to these new properties.
52+
Now update the template in the `@Component` decoration with data bindings to these new properties.
5153

5254
+makeExample('toh-1/ts-snippets/app.component.snippets.pt1.ts', 'show-hero')
5355

0 commit comments

Comments
 (0)