Skip to content
This repository was archived by the owner on Mar 20, 2024. It is now read-only.

Commit 692d751

Browse files
chalinfilipesilva
chalin
authored and
filipesilva
committed
docs: quickstart reboot for Dart (#2867)
* cache/quickstart sync before making Dart edits * quickstart updates for Dart * cache/guide/index sync before making Dart edits * guide/index updates for Dart * learning-angular for Dart * guide/setup for Dart * refresh cache/tutorial/index
1 parent 7a651ed commit 692d751

File tree

22 files changed

+556
-762
lines changed

22 files changed

+556
-762
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,4 @@ public/docs/*/latest/guide/cheatsheet.json
3232
protractor-results.txt
3333
link-checker-results.txt
3434
*a2docs.css
35+
/dist

‎public/_includes/_util-fns.jade‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@
3939
- var _liveLink = 'live link';
4040
- var _ngRepoURL = 'https://github.com/angular/angular';
4141
- var _ngDocRepoURL = 'https://github.com/angular/angular.io';
42-
- var _qsRepo = 'https://github.com/angular/quickstart/blob/master/README.md'
42+
- var _qsRepo = 'https://github.com/angular/quickstart';
43+
- var _qsRepoZip = _qsRepo + '/archive/master.zip';
44+
45+
- var _npm = 'npm';
4346

4447
//- NgModule related
4548
- var _AppModuleVsAppComp = 'AppModule'

‎public/docs/_examples/quickstart/dart/lib/app_component.dart‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
1-
// #docregion , import
1+
// #docregion
22
import 'package:angular2/core.dart';
3-
// #enddocregion import
43

5-
// #docregion metadata
64
@Component(
75
selector: 'my-app',
8-
template: '<h1>Hello Angular</h1>')
9-
// #enddocregion metadata
10-
// #docregion class
11-
class AppComponent {}
6+
template: '<h1>Hello {{name}}</h1>')
7+
class AppComponent {
8+
var name = 'Angular';
9+
}

‎public/docs/_examples/quickstart/dart/web/index.html‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
<!DOCTYPE html>
33
<html>
44
<head>
5-
<title>Getting Started</title>
5+
<title>Hello Angular</title>
6+
<meta charset="UTF-8">
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
68
<link rel="stylesheet" href="styles.css">
79

810
<!-- #docregion loaddart -->
@@ -11,6 +13,8 @@
1113
<!-- #enddocregion loaddart -->
1214
</head>
1315
<body>
14-
<my-app>Loading...</my-app>
16+
<!-- #docregion my-app-->
17+
<my-app>Loading AppComponent content here ...</my-app>
18+
<!-- #enddocregion my-app-->
1519
</body>
1620
</html>

‎public/docs/dart/latest/_data.json‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,19 @@
77
"banner": "AngularDart is <b>2.0</b>. View the <a href='https://github.com/dart-lang/angular2/blob/master/CHANGELOG.md' target='_blank'>change log</a> to see enhancements, fixes, and breaking changes."
88
},
99

10+
"cli-quickstart": {
11+
"icon": "query-builder",
12+
"title": "CLI Quickstart",
13+
"subtitle": "TypeScript",
14+
"description": "Use the CLI tool to quickly build Angular applications",
15+
"hide": true
16+
},
17+
1018
"quickstart": {
1119
"icon": "query-builder",
1220
"title": "Quickstart",
1321
"subtitle": "Dart",
14-
"description": "Get up and running with Angular",
15-
"banner": "This QuickStart guide demonstrates how to build and run a simple Angular application."
22+
"banner": "A quick look at Angular basics"
1623
},
1724

1825
"tutorial": {

‎public/docs/dart/latest/_util-fns.jade‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ include ../../../_includes/_util-fns
2222
- var _ngRepoURL = 'https://github.com/dart-lang/angular2';
2323
//- Don't override this value quite yet:
2424
//- var _ngDocRepoURL = 'https://github.com/dart-lang/site-webdev';
25-
- var _qsRepo = 'https://github.com/angular-examples/quickstart/archive/master.zip'
25+
- var _qsRepo = 'https://github.com/angular-examples/quickstart'
26+
- var _qsRepoZip = _qsRepo + '/archive/master.zip';
27+
28+
- var _npm = 'pub';
2629

2730
//- NgModule related
2831
- var _AppModuleVsAppComp = 'AppComponent'

‎public/docs/dart/latest/guide/_data.json‎

Lines changed: 55 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,29 @@
22
"index": {
33
"title": "Documentation Overview",
44
"navTitle": "Overview",
5-
"description": "How to read and use this documentation",
5+
"intro": "How to read and use this documentation",
66
"nextable": true,
77
"basics": true
88
},
99

10+
"setup": {
11+
"title": "Setup for local development",
12+
"navTitle": "Setup",
13+
"intro": "Install the Angular QuickStart seed for faster, more efficient development on your machine",
14+
"nextable": true,
15+
"hideNextPage": true,
16+
"basics": true
17+
},
18+
19+
"learning-angular": {
20+
"title": "Learning Angular",
21+
"navTitle": "Learning Angular",
22+
"intro": "A suggested path through the documentation for Angular newcomers",
23+
"nextable": true,
24+
"hideNextPage": true,
25+
"basics": true
26+
},
27+
1028
"architecture": {
1129
"title": "Architecture Overview",
1230
"navTitle": "Architecture",
@@ -17,7 +35,7 @@
1735

1836
"displaying-data": {
1937
"title": "Displaying Data",
20-
"intro": "Interpolation and other forms of property binding help us show app data in the UI.",
38+
"intro": "Property binding helps show app data in the UI.",
2139
"nextable": true,
2240
"basics": true
2341
},
@@ -63,16 +81,29 @@
6381
"basics": true
6482
},
6583

84+
"glossary": {
85+
"title": "Glossary",
86+
"intro": "Brief definitions of the most important words in the Angular vocabulary",
87+
"basics": true
88+
},
89+
90+
"change-log": {
91+
"hide": true,
92+
"title": "Change Log",
93+
"intro": "An annotated history of recent documentation improvements.",
94+
"basics": true
95+
},
96+
6697
"ngmodule": {
98+
"hide": true,
6799
"title": "Angular Modules (NgModule)",
68-
"intro": "Define application modules with @NgModule",
69-
"hide": true
100+
"intro": "Define application modules with @NgModule"
70101
},
71102

72103
"animations": {
104+
"hide": true,
73105
"title": "Animations",
74-
"intro": "A guide to Angular's animation system.",
75-
"hide": true
106+
"intro": "A guide to Angular's animation system."
76107
},
77108

78109
"attribute-directives": {
@@ -90,12 +121,6 @@
90121
"intro": "Learn how to apply CSS styles to components."
91122
},
92123

93-
"glossary": {
94-
"title": "Glossary",
95-
"intro": "Brief definitions of the most important words in the Angular vocabulary",
96-
"basics": true
97-
},
98-
99124
"hierarchical-dependency-injection": {
100125
"title": "Hierarchical Dependency Injectors",
101126
"navTitle": "Hierarchical Injectors",
@@ -104,7 +129,7 @@
104129

105130
"server-communication": {
106131
"title": "HTTP Client",
107-
"intro": "Talk to a remote server with an HTTP Client."
132+
"intro": "Use an HTTP Client to talk to a remote server."
108133
},
109134

110135
"lifecycle-hooks": {
@@ -113,9 +138,9 @@
113138
},
114139

115140
"npm-packages": {
141+
"hide": true,
116142
"title": "Npm Packages",
117-
"intro": "Details of the recommended npm packages and the different kinds of package dependencies",
118-
"hide": true
143+
"intro": "Recommended npm packages, and how to specify package dependencies"
119144
},
120145

121146
"pipes": {
@@ -125,40 +150,46 @@
125150

126151
"router": {
127152
"title": "Routing & Navigation",
128-
"intro": "Discover the basics of screen navigation with the Angular Component Router."
153+
"intro": "Discover the basics of screen navigation with the Angular Router."
129154
},
130155

131156
"security": {
132157
"title": "Security",
133158
"intro": "Developing for content security in Angular applications"
134159
},
135160

161+
"setup-systemjs-anatomy": {
162+
"hide": true,
163+
"title": "Setup Anatomy",
164+
"intro": "Inside the local development environment for SystemJS"
165+
},
166+
136167
"structural-directives": {
137168
"title": "Structural Directives",
138169
"intro": "Angular has a powerful template engine that lets us easily manipulate the DOM structure of our elements."
139170
},
140171

141172
"testing": {
173+
"hide": true,
142174
"title": "Testing",
143-
"intro": "Techniques and practices for testing an Angular app",
144-
"hide": true
175+
"intro": "Techniques and practices for testing an Angular app"
145176
},
146177

147178
"typescript-configuration": {
179+
"hide": true,
148180
"title": "TypeScript Configuration",
149-
"intro": "TypeScript configuration for Angular developers",
150-
"hide": true
181+
"intro": "TypeScript configuration for Angular developers"
151182
},
152183

153184
"upgrade": {
185+
"hide": true,
154186
"title": "Upgrading from 1.x",
155-
"intro": "Angular 1 applications can be incrementally upgraded to Angular 2.",
156-
"hide": true
187+
"intro": "Incrementally upgrade an Angular 1 application to Angular 2."
157188
},
158189

159190
"webpack": {
191+
"hide": true,
160192
"title": "Webpack: an introduction",
161-
"intro": "Create your Angular applications with a Webpack based tooling",
162-
"hide": true
193+
"intro": "Create Angular applications with a Webpack based tooling"
163194
}
164195
}

‎public/docs/dart/latest/guide/index.jade‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ extends ../../../ts/_cache/guide/index.jade
22

33
block includes
44
include ../_util-fns
5+
- var _angular_io = 'website';

‎public/docs/dart/latest/guide/learning-angular.jade‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
extends ../../../ts/_cache/guide/learning-angular.jade
2+
3+
block includes
4+
include ../_util-fns

‎public/docs/dart/latest/guide/setup.jade‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
extends ../../../ts/_cache/guide/setup.jade
2+
3+
block includes
4+
include ../_util-fns
5+
- var _prereq = 'the Dart SDK';
6+
- var _playground = 'repository';
7+
- var _Install = 'Get';
8+
//- npm/pub commands
9+
- var _install = 'get';
10+
- var _start = 'serve';
11+
12+
block qs-seed
13+
:marked
14+
The <live-example name="quickstart">QuickStart project</live-example> can
15+
conveniently be used to seed new projects. It contains the following core files:
16+
17+
block core-files
18+
+makeTabs(`
19+
quickstart/ts/app/app.component.ts,
20+
quickstart/ts/app/main.ts,
21+
quickstart/ts/index.html,
22+
quickstart/dart/pubspec.yaml,
23+
quickstart/ts/styles.css`,
24+
',,,,quickstart',
25+
`app/app.component.ts,
26+
app/main.ts,
27+
index.html,
28+
pubspec.yaml,
29+
styles.css (excerpt)`)
30+
31+
:marked
32+
These files are organized as follows:
33+
34+
.filetree
35+
.file angular_quickstart
36+
.children
37+
.file lib
38+
.children
39+
.file app_component.dart
40+
.file pubspec.yaml
41+
.file web
42+
.children
43+
.file index.html
44+
.file main.dart
45+
.file styles.css
46+
47+
block install-tooling
48+
:marked
49+
Install the **[Dart SDK](https://www.dartlang.org/downloads/)**,
50+
if not already on your machine, and any tools you like to use with Dart.
51+
The Dart SDK includes tools such as **[pub][pub]**, the Dart package manager.
52+
If you don't have a favorite Dart editor already, try
53+
[WebStorm][WS], which comes with a Dart plugin.
54+
You can also download [Dart plugins for other IDEs and editors][DT].
55+
56+
[WS]: https://confluence.jetbrains.com/display/WI/Getting+started+with+Dart
57+
[DT]: https://www.dartlang.org/tools/
58+
[pub]: https://www.dartlang.org/tools/pub/

0 commit comments

Comments
 (0)