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

Commit 290a5f2

Browse files
committed
docs(tutorial): fix headlines
1 parent 719e66b commit 290a5f2

15 files changed

+43
-47
lines changed

docs/content/tutorial/step_00.ngdoc

+2-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
<ul doc-tutorial-nav="0"></ul>
77

8-
98
In this step of the tutorial, you will become familiar with the most important source code files of
109
the AngularJS Phonecat App. You will also learn how to start the development servers bundled with
1110
[angular-seed][angular-seed], and run the application in the browser.
@@ -167,7 +166,7 @@ For the purposes of this tutorial, we modified the angular-seed with the followi
167166
* Added a dependency on [Bootstrap](http://getbootstrap.com) in the `bower.json` file.
168167

169168

170-
# Experiments
169+
## Experiments
171170

172171
<div></div>
173172

@@ -178,7 +177,7 @@ For the purposes of this tutorial, we modified the angular-seed with the followi
178177
```
179178

180179

181-
# Summary
180+
## Summary
182181

183182
Now let's go to {@link step_01 step 1} and add some content to the web app.
184183

docs/content/tutorial/step_01.ngdoc

+2-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
<ul doc-tutorial-nav="1"></ul>
77

8-
98
In order to illustrate how AngularJS enhances standard HTML, you will create a purely *static* HTML
109
page and then examine how we can turn this HTML code into a template that AngularJS will use to
1110
dynamically display the same result with any set of data.
@@ -37,7 +36,7 @@ In this step you will add some basic information about two cell phones to an HTM
3736
```
3837

3938

40-
# Experiments
39+
## Experiments
4140

4241
<div></div>
4342

@@ -48,7 +47,7 @@ In this step you will add some basic information about two cell phones to an HTM
4847
```
4948

5049

51-
# Summary
50+
## Summary
5251

5352
This addition to your app uses static HTML to display the list. Now, let's go to
5453
{@link step_02 step 2} to learn how to use AngularJS to dynamically generate the same list.

docs/content/tutorial/step_02.ngdoc

+5-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
<ul doc-tutorial-nav="2"></ul>
77

8-
98
Now, it's time to make the web page dynamic — with AngularJS. We will also add a test that verifies
109
the code for the controller we are going to add.
1110

@@ -148,9 +147,9 @@ To learn more about AngularJS scopes, see the {@link ng.$rootScope.Scope Angular
148147
</div>
149148

150149

151-
# Testing
150+
## Testing
152151

153-
## Testing Controllers
152+
### Testing Controllers
154153

155154
The "AngularJS way" of separating the controller from the view makes it easy to test code as it is being
156155
developed. In the section "Model and Controller" we have registered our controller via a constructor
@@ -206,7 +205,7 @@ describe('PhoneListController', function() {
206205
</div>
207206

208207

209-
## Writing and Running Tests
208+
### Writing and Running Tests
210209

211210
Many AngularJS developers prefer the syntax of
212211
[Jasmine's Behavior-Driven Development (BDD) framework][jasmine-home], when writing tests. Although
@@ -253,7 +252,7 @@ To run the tests, and then watch the files for changes execute: `npm test`
253252
</div>
254253

255254

256-
# Experiments
255+
## Experiments
257256

258257
<div></div>
259258

@@ -308,7 +307,7 @@ To run the tests, and then watch the files for changes execute: `npm test`
308307
`toBe(4)`.
309308

310309

311-
# Summary
310+
## Summary
312311

313312
We now have a dynamic application which separates models, views, and controllers, and we are testing
314313
as we go. Let's go to {@link step_03 step 3} to learn how to improve our application's architecture,

docs/content/tutorial/step_03.ngdoc

+4-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55

66
<ul doc-tutorial-nav="3"></ul>
77

8-
98
In the previous step, we saw how a controller and a template worked together to convert a static
109
HTML page into a dynamic view. This is a very common pattern in Single-Page Applications in general
1110
(and AngularJS applications in particular):
@@ -197,7 +196,7 @@ Voilà! The resulting output should look the same, but let's see what we have ga
197196
</div>
198197

199198

200-
# Testing
199+
## Testing
201200

202201
Although we have combined our controller with a template into a component, we still can (and should)
203202
unit test the controller separately, since this is where our application logic and data reside.
@@ -240,12 +239,12 @@ verifies that the phones array property on it contains three records. Note that
240239
the controller instance itself, not on a `scope`.
241240

242241

243-
## Running Tests
242+
### Running Tests
244243

245244
Same as before, execute `npm test` to run the tests and then watch the files for changes.
246245

247246

248-
# Experiments
247+
## Experiments
249248

250249
<div></div>
251250

@@ -267,7 +266,7 @@ Same as before, execute `npm test` to run the tests and then watch the files for
267266
throughout the application, is a big win.
268267

269268

270-
# Summary
269+
## Summary
271270

272271
You have learned how to organize your application and presentation logic into isolated, reusable
273272
components. Let's go to {@link step_04 step 4} to learn how to organize our code in directories and

docs/content/tutorial/step_04.ngdoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ After all the refactorings that took place, this is how our application looks fr
265265
```
266266

267267

268-
# Testing
268+
## Testing
269269

270270
Since this was just a refactoring step (no actual code addition/deletions), we shouldn't need to
271271
change much (if anything) as far as our specs are concerned.
@@ -301,7 +301,7 @@ pass.
301301
</div>
302302

303303

304-
# Summary
304+
## Summary
305305

306306
Even if we didn't add any new and exciting functionality to our application, we have made a great
307307
step towards a well-architected and maintainable application. Time to spice things up. Let's go to

docs/content/tutorial/step_05.ngdoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ following:
7878
by the `filter` filter. The process is completely transparent to the developer.
7979

8080

81-
# Testing
81+
## Testing
8282

8383
In previous steps, we learned how to write and run unit tests. Unit tests are perfect for testing
8484
controllers and other parts of our application written in JavaScript, but they can't easily
@@ -124,7 +124,7 @@ easy it is to write E2E tests in AngularJS. Although this example is for a simpl
124124
that easy to set up any functional, readable, E2E test.
125125

126126

127-
## Running E2E Tests with Protractor
127+
### Running E2E Tests with Protractor
128128

129129
Even though the syntax of this test looks very much like our controller unit test written with
130130
Jasmine, the E2E test uses APIs of [Protractor][protractor]. Read about the Protractor APIs in the
@@ -142,7 +142,7 @@ To rerun the test suite, execute `npm run protractor` again.
142142
</div>
143143

144144

145-
# Experiments
145+
## Experiments
146146

147147
<div></div>
148148

@@ -155,7 +155,7 @@ To rerun the test suite, execute `npm run protractor` again.
155155
Component isolation at work!
156156

157157

158-
# Summary
158+
## Summary
159159

160160
We have now added full-text search and included a test to verify that it works! Now let's go on to
161161
{@link step_06 step 6} to learn how to add sorting capabilities to the PhoneCat application.

docs/content/tutorial/step_06.ngdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ will be reordered. That is the data-binding doing its job in the opposite direct
124124
the model.
125125

126126

127-
# Testing
127+
## Testing
128128

129129
The changes we made should be verified with both a unit test and an E2E test. Let's look at the unit
130130
test first.
@@ -217,7 +217,7 @@ The E2E test verifies that the ordering mechanism of the select box is working c
217217
You can now rerun `npm run protractor` to see the tests run.
218218

219219

220-
# Experiments
220+
## Experiments
221221

222222
<div></div>
223223

@@ -232,7 +232,7 @@ You can now rerun `npm run protractor` to see the tests run.
232232
`<option value="-age">Oldest</option>`
233233

234234

235-
# Summary
235+
## Summary
236236

237237
Now that you have added list sorting and tested the application, go to {@link step_07 step 7} to
238238
learn about AngularJS services and how AngularJS uses dependency injection.

docs/content/tutorial/step_07.ngdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ let's add the annotations to our `PhoneListController`:
180180
```
181181

182182

183-
# Testing
183+
## Testing
184184

185185
Because we started using dependency injection and our controller has dependencies, constructing the
186186
controller in our tests is a bit more complicated. We could use the `new` operator and provide the
@@ -283,7 +283,7 @@ Chrome 49.0: Executed 2 of 2 SUCCESS (0.133 secs / 0.097 secs)
283283
```
284284

285285

286-
# Experiments
286+
## Experiments
287287

288288
<div></div>
289289

@@ -299,7 +299,7 @@ Chrome 49.0: Executed 2 of 2 SUCCESS (0.133 secs / 0.097 secs)
299299
```
300300

301301

302-
# Summary
302+
## Summary
303303

304304
Now that you have learned how easy it is to use AngularJS services (thanks to AngularJS's dependency
305305
injection), go to {@link step_08 step 8}, where you will add some thumbnail images of phones and

docs/content/tutorial/step_08.ngdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ which it would have done if we had only specified an attribute binding in a regu
7070
HTTP request to an invalid location.
7171

7272

73-
# Testing
73+
## Testing
7474

7575
<br />
7676
**`e2e-tests/scenarios.js`**:
@@ -95,7 +95,7 @@ views, that we will implement in the upcoming steps.
9595
You can now rerun `npm run protractor` to see the tests run.
9696

9797

98-
# Experiments
98+
## Experiments
9999

100100
<div></div>
101101

@@ -108,7 +108,7 @@ You can now rerun `npm run protractor` to see the tests run.
108108
inject the valid address.
109109

110110

111-
# Summary
111+
## Summary
112112

113113
Now that you have added phone images and links, go to {@link step_09 step 9} to learn about AngularJS
114114
layout templates and how AngularJS makes it easy to create applications that have multiple views.

docs/content/tutorial/step_09.ngdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ The takeaway here is:
334334
</div>
335335

336336

337-
# Testing
337+
## Testing
338338

339339
Since some of our modules depend on {@link ngRoute ngRoute} now, it is necessary to update the Karma
340340
configuration file with angular-route. Other than that, the unit tests should (still) pass without
@@ -398,7 +398,7 @@ various URLs and verifying that the correct view was rendered.
398398
You can now rerun `npm run protractor` to see the tests run (and hopefully pass).
399399

400400

401-
# Experiments
401+
## Experiments
402402

403403
<div></div>
404404

@@ -415,7 +415,7 @@ You can now rerun `npm run protractor` to see the tests run (and hopefully pass)
415415
component isolation at work!
416416

417417

418-
# Summary
418+
## Summary
419419

420420
With the routing set up and the phone list view implemented, we are ready to go to
421421
{@link step_10 step 10} and implement a proper phone details view.

docs/content/tutorial/step_10.ngdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ including lists and bindings that comprise the phone details. Note how we use th
122122
<img class="diagram" src="img/tutorial/tutorial_10.png">
123123

124124

125-
# Testing
125+
## Testing
126126

127127
We wrote a new unit test that is similar to the one we wrote for the `phoneList` component's
128128
controller in {@link step_07#testing step 7}.
@@ -194,15 +194,15 @@ heading on the page is "Nexus S".
194194
You can run the tests with `npm run protractor`.
195195

196196

197-
# Experiments
197+
## Experiments
198198

199199
<div></div>
200200

201201
* Using [Protractor's API][protractor-docs], write a test that verifies that we display 4 thumbnail
202202
images on the 'Nexus S' details page.
203203

204204

205-
# Summary
205+
## Summary
206206

207207
Now that the phone details view is in place, proceed to {@link step_11 step 11} to learn how to
208208
write your own custom display filter.

docs/content/tutorial/step_11.ngdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Let's employ the filter in the phone details template:
104104
```
105105

106106

107-
# Testing
107+
## Testing
108108

109109
Filters, like any other code, should be tested. Luckily, these tests are very easy to write.
110110

@@ -146,7 +146,7 @@ Chrome 49.0: Executed 4 of 4 SUCCESS (0.091 secs / 0.075 secs)
146146
```
147147

148148

149-
# Experiments
149+
## Experiments
150150

151151
<div></div>
152152

@@ -167,7 +167,7 @@ Chrome 49.0: Executed 4 of 4 SUCCESS (0.091 secs / 0.075 secs)
167167
```
168168

169169

170-
# Summary
170+
## Summary
171171

172172
Now that we have learned how to write and test a custom filter, let's go to {@link step_12 step 12}
173173
to learn how we can use AngularJS to enhance the phone details page further.

docs/content/tutorial/step_12.ngdoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ thumbnail image.
7373
<img class="diagram" src="img/tutorial/tutorial_12.png">
7474

7575

76-
# Testing
76+
## Testing
7777

7878
To verify this new feature, we added two E2E tests. One verifies that `mainImageUrl` is set to the
7979
first phone image URL by default. The second test clicks on several thumbnail images and verifies
@@ -151,7 +151,7 @@ property to the controller. As previously, we will use a mocked response.
151151
Our unit tests should now be passing again.
152152

153153

154-
# Experiments
154+
## Experiments
155155

156156
<div></div>
157157

@@ -176,7 +176,7 @@ Our unit tests should now be passing again.
176176
Now, whenever you double-click on a thumbnail, an alert pops-up. Pretty annoying!
177177

178178

179-
# Summary
179+
## Summary
180180

181181
With the phone image swapper in place, we are ready for {@link step_13 step 13} to learn an even
182182
better way to fetch data.

docs/content/tutorial/step_13.ngdoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ Chrome 49.0: Executed 5 of 5 SUCCESS (0.123 secs / 0.104 secs)
310310
```
311311

312312

313-
# Summary
313+
## Summary
314314

315315
Now that we have seen how to build a custom service as a RESTful client, we are ready for
316316
{@link step_14 step 14} to learn how to enhance the user experience with animations.

0 commit comments

Comments
 (0)