From f054c8360ba091c8577c19f1cd09f96ef781b70d Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Sun, 16 Jul 2017 11:32:22 +0100 Subject: [PATCH] docs(aio): fix up broken links --- aio/content/guide/bootstrapping.md | 19 +++++--------- aio/content/guide/change-log.md | 38 ++++++++++++++-------------- aio/content/guide/lifecycle-hooks.md | 3 +-- aio/content/guide/npm-packages.md | 1 - aio/content/tutorial/toh-pt6.md | 6 +---- 5 files changed, 27 insertions(+), 40 deletions(-) diff --git a/aio/content/guide/bootstrapping.md b/aio/content/guide/bootstrapping.md index edcf5a2770..134281e245 100644 --- a/aio/content/guide/bootstrapping.md +++ b/aio/content/guide/bootstrapping.md @@ -1,8 +1,8 @@ # Bootstrapping An NgModule class describes how the application parts fit together. -Every application has at least one NgModule, the _root_ module -that you [bootstrap](guide/appmodule#main) to launch the application. +Every application has at least one NgModule, the _root_ module +that you [bootstrap](#main) to launch the application. You can call it anything you want. The conventional name is `AppModule`. The [setup](guide/setup) instructions produce a new project with the following minimal `AppModule`. @@ -25,7 +25,7 @@ The `@NgModule` decorator identifies `AppModule` as an `NgModule` class. * **_bootstrap_** — the _root_ component that Angular creates and inserts into the `index.html` host web page. The [NgModules](guide/ngmodule) guide dives deeply into the details of NgModules. -All you need to know at the moment is a few basics about these three properties. +All you need to know at the moment is a few basics about these three properties. {@a imports} @@ -34,7 +34,7 @@ All you need to know at the moment is a few basics about these three properties. ### The _imports_ array NgModules are a way to consolidate features that belong together into discrete units. -Many features of Angular itself are organized as NgModules. +Many features of Angular itself are organized as NgModules. HTTP services are in the `HttpModule`. The router is in the `RouterModule`. Eventually you may create a feature module. @@ -70,7 +70,7 @@ You add `import` statements to almost every application file. They have nothing to do with Angular and Angular knows nothing about them. The _module's_ `imports` array appears _exclusively_ in the `@NgModule` metadata object. -It tells Angular about specific _other_ NgModules—all of them classes decorated +It tells Angular about specific _other_ NgModules—all of them classes decorated with `@NgModule`—that the application needs to function properly. @@ -110,7 +110,7 @@ Do not put any other kind of class in `declarations`; _not_ `NgModule` classes, ### The _bootstrap_ array -You launch the application by [_bootstrapping_](guide/bootstrapping#main) the root `AppModule`. +You launch the application by [_bootstrapping_](#main) the root `AppModule`. Among other things, the _bootstrapping_ process creates the component(s) listed in the `bootstrap` array and inserts each one into the browser DOM. @@ -127,13 +127,6 @@ Which brings us to the _bootstrapping_ process itself. {@a main} - - - - - - - ## Bootstrap in _main.ts_ There are many ways to bootstrap an application. diff --git a/aio/content/guide/change-log.md b/aio/content/guide/change-log.md index 260abc67c8..4b68f71b22 100644 --- a/aio/content/guide/change-log.md +++ b/aio/content/guide/change-log.md @@ -27,12 +27,12 @@ Revised samples are more clear and cover all topics discussed. ## NEW: Samples re-structured with `src/` folder (2017-02-02) All documentation samples have been realigned with the default folder structure of the Angular CLI. That's a step along the road to basing the sample in the Angular CLI. -But it's also good in its own right. +But it's also good in its own right. It helps clearly separate app code from setup and configuration files. All samples now have a `src/` folder at the project root. -The former `app/` folder moves under `src/`. -Read about moving your existing project to this structure in +The former `app/` folder moves under `src/`. +Read about moving your existing project to this structure in the QuickStart repo update instructions. @@ -48,8 +48,8 @@ Notably: The new [**Reactive Forms**](guide/reactive-forms) guide explains how and why to build a "reactive form". "Reactive Forms" are the code-based counterpart to the declarative "Template Driven" forms approach introduced in the [Forms](guide/forms) guide. -Check it out before you decide how to add forms to your app. -Remember also that you can use both techniques in the same app, +Check it out before you decide how to add forms to your app. +Remember also that you can use both techniques in the same app, choosing the approach that best fits each scenario. ## NEW: Deployment guide (2017-01-30) @@ -65,25 +65,25 @@ Revised samples are clearer and cover all topics discussed. ## Miscellaneous (2017-01-05) -* [Setup](guide/setup) guide: -added (optional) instructions on how to remove _non-essential_ files. +* [Setup](guide/setup) guide: +added (optional) instructions on how to remove _non-essential_ files. * No longer consolidate RxJS operator imports in `rxjs-extensions` file; each file should import what it needs. * All samples prepend template/style URLs with `./` as a best practice. * [Style Guide](guide/styleguide): copy edits and revised rules. ## Router: more detail (2016-12-21) -Added more information to the [Router](guide/router) guide +Added more information to the [Router](guide/router) guide including sections named outlets, wildcard routes, and preload strategies. ## HTTP: how to set default request headers (and other request options) (2016-12-14) -Added section on how to set default request headers (and other request options) to -[HTTP](guide/http#override-default-request-options) guide. +Added section on how to set default request headers (and other request options) to +HTTP guide. ## Testing: added component test plunkers (2016-12-02) -Added two plunkers that each test _one simple component_ so you can write a component test plunker of your own: one for the QuickStart seed's `AppComponent` and another for the Testing guide's `BannerComponent`. +Added two plunkers that each test _one simple component_ so you can write a component test plunker of your own: one for the QuickStart seed's `AppComponent` and another for the Testing guide's `BannerComponent`. Linked to these plunkers in [Testing](guide/testing#live-examples) and [Setup anatomy](guide/setup-systemjs-anatomy) guides. ## Internationalization: pluralization and _select_ (2016-11-30) @@ -112,15 +112,15 @@ Docs and code samples updated and tested with Angular v.2.2.0. ## UPDATE: NgUpgrade Guide for the AOT friendly _upgrade/static_ module (2016-11-14) -The updated [NgUpgrade Guide](guide/upgrade) guide covers the -new AOT friendly `upgrade/static` module +The updated [NgUpgrade Guide](guide/upgrade) guide covers the +new AOT friendly `upgrade/static` module released in v.2.2.0, which is the recommended facility for migrating from AngularJS to Angular. The documentation for the version prior to v.2.2.0 has been removed. ## ES6 described in "TypeScript to JavaScript" (2016-11-14) -The updated [TypeScript to JavaScript](guide/ts-to-js) guide +The updated [TypeScript to JavaScript](guide/ts-to-js) guide now explains how to write apps in ES6/7 by translating the common idioms in the TypeScript documentation examples (and elsewhere on the web) to ES6/7 and ES5. @@ -156,7 +156,7 @@ in the `in-memory-web-api` repo. The router can lazily _preload_ modules _after_ the app starts and _before_ the user navigates to them for improved perceived performance. -New `:enter` and `:leave` aliases make animation more natural. +New `:enter` and `:leave` aliases make animation more natural. ## Sync with Angular v.2.1.0 (2016-10-12) @@ -176,11 +176,11 @@ Docs and code samples updated and tested with Angular v.2.0.2. ## "Routing and Navigation" guide with the _Router Module_ (2016-10-5) The [Routing and Navigation](guide/router) guide now locates route configuration -in a _Routing Module_. +in a _Routing Module_. The _Routing Module_ replaces the previous _routing object_ involving the `ModuleWithProviders`. All guided samples with routing use the _Routing Module_ and prose content has been updated, -most conspicuously in the +most conspicuously in the [NgModule](guide/ngmodule) guide and [NgModule FAQ](guide/ngmodule-faq) guide. ## New "Internationalization" guide (2016-09-30) @@ -194,7 +194,7 @@ Many samples use the `angular-in-memory-web-api` to simulate a remote server. This library is also useful to you during early development before you have a server to talk to. The package name was changed from "angular2-in-memory-web-api" which is still frozen-in-time on npm. -The new "angular-in-memory-web-api" has new features. +The new "angular-in-memory-web-api" has new features. Read about them on github. ## "Style Guide" with _NgModules_ (2016-09-27) @@ -215,5 +215,5 @@ modules with SystemJS as the samples currently do. ## "Lifecycle Hooks" guide simplified (2016-09-24) -The [Lifecycle Hooks](guide/lifecycle-hooks) guide is shorter, simpler, and +The [Lifecycle Hooks](guide/lifecycle-hooks) guide is shorter, simpler, and draws more attention to the order in which Angular calls the hooks. diff --git a/aio/content/guide/lifecycle-hooks.md b/aio/content/guide/lifecycle-hooks.md index fe64000ead..a8a0e0e7d2 100644 --- a/aio/content/guide/lifecycle-hooks.md +++ b/aio/content/guide/lifecycle-hooks.md @@ -397,8 +397,7 @@ created under test or before you decide to display it. Constructors should do no more than set the initial local variables to simple values. An `ngOnInit()` is a good place for a component to fetch its initial data. The -[Tour of Heroes Tutorial](tutorial/toh-pt4#oninit) and [HTTP Client](guide/http#oninit) -guides show how. +[Tour of Heroes Tutorial](tutorial/toh-pt4#oninit) guide shows how. Remember also that a directive's data-bound input properties are not set until _after construction_. diff --git a/aio/content/guide/npm-packages.md b/aio/content/guide/npm-packages.md index 874b29e318..530f841288 100644 --- a/aio/content/guide/npm-packages.md +++ b/aio/content/guide/npm-packages.md @@ -163,7 +163,6 @@ without waiting for Angular updates. ***angular-in-memory-web-api***: An Angular-supported library that simulates a remote server's web api without requiring an actual server or real HTTP calls. Good for demos, samples, and early stage development (before you even have a server). -Read about it in the [HTTP Client](guide/http#in-mem-web-api) page. ***bootstrap***: [Bootstrap](http://getbootstrap.com/) is a popular HTML and CSS framework for designing responsive web apps. Some of the samples improve their appearance with *bootstrap*. diff --git a/aio/content/tutorial/toh-pt6.md b/aio/content/tutorial/toh-pt6.md index 8ef749d32f..8f8a746ead 100644 --- a/aio/content/tutorial/toh-pt6.md +++ b/aio/content/tutorial/toh-pt6.md @@ -83,11 +83,7 @@ Added hero "Zero" to confirm that the data service can handle a hero with `id==0 Don't worry about the details of this backend substitution; you can skip it when you have a real web API server. - Read more about the in-memory web API in the - [Appendix: Tour of Heroes in-memory web api](guide/http#in-mem-web-api) - section of the [HTTP Client](guide/http#in-mem-web-api) page. - - +div> ## Heroes and HTTP