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

Commit f4cab48

Browse files
committed
docs(quickstart): setup links to previous QS point to setup.html
1 parent 5169370 commit f4cab48

18 files changed

+58
-61
lines changed

public/docs/_examples/cb-aot-compiler/e2e-spec.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
'use strict'; // necessary for es6 output in node
1+
'use strict'; // necessary for es6 output in node
22

33
import { browser, element, by } from 'protractor';
44

@@ -11,7 +11,7 @@ describe('AOT Compilation', function () {
1111

1212
it('should load page and click button', function (done) {
1313
let headingSelector = element.all(by.css('h1')).get(0);
14-
expect(headingSelector.getText()).toEqual('My First Angular App');
14+
expect(headingSelector.getText()).toEqual('Hello Angular!');
1515

1616
expect(element.all(by.xpath('//div[text()="Magneta"]')).get(0).isPresent()).toBe(true);
1717
expect(element.all(by.xpath('//div[text()="Bombasto"]')).get(0).isPresent()).toBe(true);

public/docs/_examples/cb-aot-compiler/ts/app/app.component.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- #docregion -->
22
<button (click)="toggleHeading()">Toggle Heading</button>
3-
<h1 *ngIf="showHeading">My First Angular App</h1>
3+
<h1 *ngIf="showHeading">Hello Angular!</h1>
44

55
<h3>List of Heroes</h3>
66
<div *ngFor="let hero of heroes">{{hero}}</div>

public/docs/_examples/quickstart/ts/index.html

+3-1
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@
1010
body {color:#369;font-family: Arial,Helvetica,sans-serif;}
1111
</style>
1212

13-
<!-- Polyfill for older browsers -->
13+
<!-- #docregion polyfills -->
14+
<!-- Polyfill for older browsers -->
1415
<script src="node_modules/core-js/client/shim.min.js"></script>
16+
<!-- #enddocregion polyfills -->
1517

1618
<script src="node_modules/zone.js/dist/zone.js"></script>
1719
<script src="node_modules/reflect-metadata/Reflect.js"></script>

public/docs/ts/latest/cookbook/a1-a2-quick-reference.jade

+1-1
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ table(width="100%")
137137
in `main.ts`
138138
and the application's root component (`AppComponent`) in `app.module.ts`.
139139

140-
For more information see [Quick Start](../quickstart.html).
140+
For more information see the [Setup](../guide/setup.html) page.
141141
tr(style=top)
142142
td
143143
:marked

public/docs/ts/latest/cookbook/aot-compiler.jade

+1-2
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,7 @@ a#compile
9191
## Compile with AoT
9292

9393
### Prepare for offline compilation
94-
95-
Take the <a href='/docs/ts/latest/quickstart.html'>QuickStart</a> as a starting point.
94+
Take the <a href='../guide/setup.html'>Setup</a> as a starting point.
9695
A few minor changes to the lone `app.component` lead to these two class and html files:
9796

9897
+makeTabs(

public/docs/ts/latest/glossary.jade

+2-5
Original file line numberDiff line numberDiff line change
@@ -105,10 +105,6 @@ block includes
105105
:marked
106106
The Angular [scoped packages](#scoped-package) each have a barrel named `index`.
107107

108-
That's why we can write this:
109-
110-
+makeExcerpt('quickstart/ts/app/app.component.ts', 'import', '')
111-
112108
.alert.is-important
113109
:marked
114110
Note that you can often achieve this using [Angular modules](#angular-module) instead.
@@ -129,7 +125,8 @@ block includes
129125
.l-sub-section
130126
block bootstrap-defn-top
131127
:marked
132-
You launch an Angular application by "bootstrapping" it using the application root Angular module (`AppModule`). Bootstrapping identifies an application's top level "root" [component](#component), which is the first component that is loaded for the application. For more information, see [QuickStart](!{docsLatest}/quickstart.html).
128+
You launch an Angular application by "bootstrapping" it using the application root Angular module (`AppModule`). Bootstrapping identifies an application's top level "root" [component](#component), which is the first component that is loaded for the application.
129+
For more information, see the [Setup](!{docsLatest}/guide/setup.html).
133130
:marked
134131
You can bootstrap multiple apps in the same `index.html`, each with its own top level root.
135132

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@
153153
},
154154

155155
"setup-systemjs-anatomy": {
156-
"title": "Setup anatomy",
156+
"title": "Setup Anatomy",
157157
"intro": "Inside the local development environment for SystemJS"
158158
},
159159

public/docs/ts/latest/guide/attribute-directives.jade

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ a#directive-overview
2828
1. Structural directives&mdash;change the DOM layout by adding and removing DOM elements.
2929
1. Attribute directives&mdash;change the appearance or behavior of an element.
3030

31-
*Components* are the most common of the three directives. Read more about creating them
32-
in step three of [QuickStart](../quickstart.html#root-component).
31+
*Components* are the most common of the three directives.
32+
You saw a component for the first time in the [QuickStart](../quickstart.html#root-component) example.
3333

3434
*Structural Directives* change the structure of the view. Two examples are [NgFor](template-syntax.html#ngFor) and [NgIf](template-syntax.html#ngIf)
3535
in the [Template Syntax](template-syntax.html) page.
@@ -64,9 +64,9 @@ a#write-directive
6464

6565
:marked
6666
### Write the directive code
67-
Create a new project folder (`attribute-directives`) and follow the steps in [QuickStart](../quickstart.html).
67+
Follow the [Setup](setup.html) instructions for creating a new project
68+
and name the project folder <ngio-ex path="attribute-directives"></ngio-ex>.
6869

69-
include ../_quickstart_repo
7070
:marked
7171
Create the following source file in the indicated folder with the following code:
7272
+makeExample('app/highlight.directive.1.ts')

public/docs/ts/latest/guide/change-log.jade

+7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ block includes
77
The Angular documentation is a living document with continuous improvements.
88
This log calls attention to recent significant changes.
99

10+
## QuickStart Rewrite (2016-11-08)
11+
The QuickStart is completely rewritten so that it actually is quick.
12+
It references a minimal "Hello Angular" app running in Plunker.
13+
The new [Setup](setup.html) page tells you how to install a local development environment
14+
by downloading (or cloning) the QuickStart github repository.
15+
You are no longer asked to copy-and-paste code into setup files that were not explained anyway.
16+
1017
## Sync with Angular v.2.1.1 (2016-10-21)
1118
Docs and code samples updated and tested with Angular v.2.1.0
1219

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

+5-8
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,9 @@ figure.image-display
3434
is to bind the property name through interpolation.
3535
With interpolation, you put the property name in the view template, enclosed in double curly braces: `{{myHero}}`.
3636

37-
To build an illustrative example, start by creating a new project folder called <ngio-ex path="displaying-data"></ngio-ex>
38-
and following the steps in [QuickStart](../quickstart.html).
3937

40-
block quickstart-repo
41-
include ../_quickstart_repo
38+
Follow the [Setup](setup.html) instructions for creating a new project
39+
and name the project folder <ngio-ex path="displaying-data"></ngio-ex>.
4240

4341
:marked
4442
Then modify the <ngio-ex path="app.component.ts"></ngio-ex> file by
@@ -78,9 +76,8 @@ block quickstart-repo
7876
Notice that you don't call **new** to create an instance of the `AppComponent` class.
7977
Angular is creating an instance for you. How?
8078

81-
The CSS `selector` in the `@Component` !{_decorator} specifies an element named `my-app`.
82-
Remember back in [QuickStart](../quickstart.html) that you added the `<my-app>`
83-
element to the body of your `index.html` file:
79+
The CSS `selector` in the `@Component` !{_decorator} specifies an element named `<my-app>`.
80+
That element is a placeholder in the body of your `index.html` file:
8481

8582
+makeExcerpt('index.html', 'body')
8683

@@ -276,4 +273,4 @@ block final-code
276273
displaying-data/ts/app/app.module.ts,
277274
displaying-data/ts/app/main.ts`,
278275
'final,,,',
279-
'app/app.component.ts, app/hero.ts, app.module.ts, main.ts')
276+
'app/app.component.ts, app/hero.ts, app.module.ts, main.ts')

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

+2-3
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,8 @@ figure.image-display
8585

8686
:marked
8787
## Setup
88-
Create a new project folder (`angular-forms`) and follow the steps in the [QuickStart](../quickstart.html).
89-
90-
include ../_quickstart_repo
88+
Follow the [Setup](setup.html) instructions for creating a new project
89+
and name the project folder <ngio-ex path="angular-forms"></ngio-ex>.
9190
:marked
9291
## Create the Hero Model Class
9392

public/docs/ts/latest/guide/npm-packages.jade

+2-3
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@ include ../_util-fns
1818

1919
:marked
2020
We recommend a comprehensive starter-set of packages as specified in the `dependencies` and `devDependencies`
21-
sections of the QuickStart
22-
<a href="https://docs.npmjs.com/files/package.json" target="_blank">package.json</a> file:
23-
+makeJson('quickstart/ts/package.1.json',{ paths: 'dependencies, devDependencies'}, 'package.json (dependencies)')(format=".")
21+
sections of the <a href="https://docs.npmjs.com/files/package.json" target="_blank">package.json</a> file
22+
installed as described during [Setup](setup.html).
2423
:marked
2524
You can use other packages but we recommend *this particular set* to start with because (a) they work well together and
2625
(b) they include everything you'll need to build and run the sample applications in this series.

public/docs/ts/latest/guide/template-syntax.jade

+3-2
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,11 @@ block includes
4242
.l-main-section
4343
:marked
4444
## HTML
45-
HTML is the language of the Angular template. Our [QuickStart](../quickstart.html) application has a template that is pure HTML:
45+
HTML is the language of the Angular template.
46+
The [QuickStart](../quickstart.html) application has a template that is pure HTML:
4647

4748
code-example(language="html" escape="html").
48-
<h1>My First Angular App</h1>
49+
<h1>Hello Angular!</h1>
4950

5051
:marked
5152
Almost all HTML syntax is valid template syntax. The `<script>` element is a notable exception; it is forbidden, eliminating the risk of script injection attacks. (In practice, `<script>` is simply ignored.)

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

+5-7
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,7 @@ table(width="100%")
169169
A bare minimum of discussion plus the downloadable source code must suffice for now.
170170

171171
There are two fast paths to getting started.
172-
1. Start a new project following the instructions in the
173-
[QuickStart github repository](https://github.com/angular/quickstart/blob/master/README.md).
172+
1. Start a new project following the instructions in [Setup](setup.html).
174173

175174
1. Start a new project with the
176175
[Angular CLI](https://github.com/angular/angular-cli/blob/master/README.md).
@@ -180,13 +179,12 @@ table(width="100%")
180179
Their artifacts and procedures differ slightly but their essentials are the same
181180
and there are no differences in the test code.
182181

183-
In this chapter, the application and its tests are based on the QuickStart repo.
182+
In this chapter, the application and its tests are based on the documentation setup.
184183

185184
.alert.is-helpful
186185
:marked
187-
If your application was based on the QuickStart repository,
186+
If your application was based on the [Setup](setup.html) instructions,
188187
you can skip the rest of this section and get on with your first test.
189-
The QuickStart repo provides all necessary setup.
190188

191189
#setup-files
192190
:marked
@@ -225,7 +223,7 @@ table(width="100%")
225223
[SystemJS](https://github.com/systemjs/systemjs/blob/master/README.md)
226224
loads the application and test files.
227225
This script tells SystemJS where to find those files and how to load them.
228-
It's the same version of `systemjs.config.js` used by QuickStart-based applications.
226+
It's the same version of `systemjs.config.js` used by Setup-based applications.
229227
tr
230228
td(style="vertical-align: top") <code>systemjs.config.extras.js</code>
231229
td
@@ -282,7 +280,7 @@ code-example(format="." language="bash").
282280
Both processes watch pertinent files, write messages to the console, and re-run when they detect changes.
283281
.l-sub-section
284282
:marked
285-
The QuickStart development path defined the `test` command in the `scripts` section of npm's `package.json`.
283+
The documentation setup defines the `test` command in the `scripts` section of npm's `package.json`.
286284
The Angular CLI has different commands to do the same thing. Adjust accordingly.
287285
:marked
288286
After a few moments, karma opens a browser and starts writing to the console.

public/docs/ts/latest/guide/typescript-configuration.jade

+8-7
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ a(id="tsconfig")
2323
For details about `tsconfig.json`, see the official
2424
[TypeScript wiki](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html).
2525
:marked
26-
We created the following `tsconfig.json` for [QuickStart](../quickstart.html):
27-
+makeJson('quickstart/ts/tsconfig.1.json', null, 'tsconfig.json')(format=".")
26+
We created the following `tsconfig.json` during [Setup](setup.html):
27+
+makeJson('quickstart/ts/tsconfig.json', null, 'tsconfig.json')(format=".")
2828
:marked
2929
This file contains options and flags that are essential for Angular applications.
3030

@@ -36,24 +36,25 @@ a(id="tsconfig")
3636
But your choice now can make a difference in larger projects, so it merits discussion.
3737

3838
When the `noImplicitAny` flag is `false` (the default), and if
39-
the compiler cannot infer the variable type based on how it's used, the compiler silently defaults the type to `any`. That's what is meant by *implicit `any`*.
40-
41-
In the QuickStart exercise, the `noImplicitAny` flag is initialized to `false`
42-
to make learning TypeScript development easier.
39+
the compiler cannot infer the variable type based on how it's used,
40+
the compiler silently defaults the type to `any`. That's what is meant by *implicit `any`*.
4341

42+
The documentation setup sets the `noImplicitAny` flag to `true`.
4443
When the `noImplicitAny` flag is `true` and the TypeScript compiler cannot infer
4544
the type, it still generates the JavaScript files, but it also **reports an error**.
4645
Many seasoned developers prefer this stricter setting because type checking catches more
4746
unintentional errors at compile time.
4847

4948
You can set a variable's type to `any` even when the `noImplicitAny` flag is `true`.
5049

51-
If you set the `noImplicitAny` flag to `true`, you may get *implicit index errors* as well.
50+
When the `noImplicitAny` flag is `true, you may get *implicit index errors* as well.
5251
Most developers feel that *this particular error* is more annoying than helpful.
5352
You can suppress them with the following additional flag:
5453
code-example(format=".").
5554
"suppressImplicitAnyIndexErrors":true
5655

56+
:marked
57+
The documentation setup sets this flag to `true` as well.
5758

5859
a(id="typings")
5960
.l-main-section

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

+8-6
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ figure.image-display
433433

434434
:marked
435435
Now introduce Angular 2 to the project. Inspired by instructions in
436-
[the QuickStart](../quickstart.html), you can selectively copy in material from the
436+
[the Setup](setup.html), you can selectively copy in material from the
437437
<a href="https://github.com/angular/quickstart" target="_blank">QuickStart github repository</a>.
438438

439439
Next, create an `app.module.ts` file and add the following `NgModule` class:
@@ -897,7 +897,7 @@ code-example(format="").
897897
:marked
898898
We should also configure the TypeScript compiler so that it can understand our
899899
project. We'll add a `tsconfig.json` file to the project directory, just like we do
900-
in the [Quickstart](../quickstart.html). It instructs the TypeScript compiler how
900+
in the documentation [setup](setup.html). It instructs the TypeScript compiler how
901901
to interpret our source files.
902902

903903
+makeJson('upgrade-phonecat-1-typescript/ts/tsconfig.ng1.json', null, 'tsconfig.json')
@@ -1025,8 +1025,9 @@ code-example(format="").
10251025
.alert.is-important The project also contains some animations, which we are not yet upgrading in this version of the guide. This will change in a later release.
10261026

10271027
:marked
1028-
Let's install Angular 2 into the project, along with the SystemJS module loader. Take a look into the
1029-
[Quickstart](../quickstart.html) guide and get the following configurations from there:
1028+
Let's install Angular 2 into the project, along with the SystemJS module loader.
1029+
Take a look at the results of the [Setup](setup.html) instructions
1030+
and get the following configurations from there:
10301031

10311032
* Add Angular 2 and the other new dependencies to `package.json`
10321033
* The SystemJS configuration file `systemjs.config.js` to the project root directory.
@@ -1064,8 +1065,9 @@ code-example(format="").
10641065
+makeExample('upgrade-phonecat-2-hybrid/ts/index.html', 'ng2', 'index.html')
10651066

10661067
:marked
1067-
In the `systemjs.config.js` file we got from the Quickstart we also need to make a couple
1068-
of adjustments because of our project structure. We want to point the browser to the project
1068+
We also need to make a couple of adjustments
1069+
to the `systemjs.config.js` file installed during [setup](setup.html).
1070+
We want to point the browser to the project
10691071
root when loading things through SystemJS, instead of using the `<base>` URL:
10701072

10711073
+makeExample('upgrade-phonecat-2-hybrid/ts/systemjs.config.1.js', 'paths', 'systemjs.config.js')

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

+2-5
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,9 @@ include ../_util-fns
55

66
Every story starts somewhere. Our story starts where the [QuickStart](../quickstart.html) ends.
77

8-
Run the <live-example></live-example> for this part.
9-
10-
Create a folder called `angular-tour-of-heroes` and follow the [QuickStart](../quickstart.html) steps
11-
which provide the prerequisites, the folder structure, and the core files for our Tour of Heroes.
8+
Follow the [Setup](setup.html) instructions for creating a new project
9+
and name the project folder <ngio-ex path="angular-forms"></ngio-ex>.
1210

13-
include ../_quickstart_repo
1411
:marked
1512
We should have the following structure:
1613

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

+1-3
Original file line numberDiff line numberDiff line change
@@ -860,9 +860,7 @@ block css-files
860860
We can also create styles at the *application level* outside of any component.
861861

862862
Our designers provided some basic styles to apply to elements across the entire app.
863-
These correspond to the full set of master styles that we
864-
introduced earlier (see
865-
[QuickStart, "Add some style"](../quickstart.html#!#add-some-style)).
863+
These correspond to the full set of master styles that we installed earlier during [setup](../setup.html).
866864
Here is an excerpt:
867865

868866
+makeExcerpt('styles.css (excerpt)', 'toh')

0 commit comments

Comments
 (0)