docs(change-log): copy edits (#3351)
This commit is contained in:
parent
c0bb26d5a0
commit
f11a261895
|
@ -16,12 +16,12 @@ block includes
|
||||||
Revised samples are more clear and cover all topics discussed.
|
Revised samples are more clear and cover all topics discussed.
|
||||||
|
|
||||||
## NEW: Samples re-structured with `src/` folder (2017-02-02)
|
## 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.
|
All documentation samples have been realigned with the default folder structure of the Angular CLI.
|
||||||
That's a step along the road to basing our sample in 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.
|
It helps clearly separate app code from setup and configuration files.
|
||||||
|
|
||||||
We've updated all samples with an `src/` folder at the project root.
|
All samples now have a `src/` folder at the project root.
|
||||||
The former `app/` folder moves under `src/`.
|
The former `app/` folder moves under `src/`.
|
||||||
Read about moving your existing project to this structure in
|
Read about moving your existing project to this structure in
|
||||||
<a href="https://github.com/angular/quickstart#updating-to-a-newer-version-of-the-quickstart-repo" target="_blank" target="Migrating samples/quickstart app to the src folder">
|
<a href="https://github.com/angular/quickstart#updating-to-a-newer-version-of-the-quickstart-repo" target="_blank" target="Migrating samples/quickstart app to the src folder">
|
||||||
|
@ -47,24 +47,24 @@ block includes
|
||||||
It includes important advice on optimizing for production.
|
It includes important advice on optimizing for production.
|
||||||
|
|
||||||
## Hierarchical Dependency Injection: refreshed (2017-01-13)
|
## Hierarchical Dependency Injection: refreshed (2017-01-13)
|
||||||
[Hierarchical Dependency Injection](hierarchical-dependency-injection.html) guide significantly revised.
|
[Hierarchical Dependency Injection](hierarchical-dependency-injection.html) guide is significantly revised.
|
||||||
Closes issue #3086
|
Closes issue #3086.
|
||||||
Revised samples are more clear and cover all topics discussed.
|
Revised samples are clearer and cover all topics discussed.
|
||||||
|
|
||||||
## Miscellaneous (2017-01-05)
|
## Miscellaneous (2017-01-05)
|
||||||
* [Setup](setup.html) guide:
|
* [Setup](setup.html) guide:
|
||||||
added (optional) instructions on how to remove _non-essential_ files.
|
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.
|
* No longer consolidate RxJS operator imports in `rxjs-extensions` file; each file should import what it needs.
|
||||||
* All samples prepend template/style URLS URLs w/ `./` ... and so should you.
|
* All samples prepend template/style URLs with `./` as a best practice.
|
||||||
* [Style Guide](style-guide.html): copy edits and revised rules.
|
* [Style Guide](style-guide.html): copy edits and revised rules.
|
||||||
|
|
||||||
## Router: more detail (2016-12-21)
|
## Router: more detail (2016-12-21)
|
||||||
Added more information to the [Router](router.html) guide
|
Added more information to the [Router](router.html) guide
|
||||||
including sections named outlets, wildcard routes, and preload strategies.
|
including sections named outlets, wildcard routes, and preload strategies.
|
||||||
|
|
||||||
## Http: how to set default request headers (and other request options) (2016-12-14)
|
## 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
|
Added section on how to set default request headers (and other request options) to
|
||||||
[Http](server-communication.html#override-default-request-options) guide.
|
[HTTP](server-communication.html#override-default-request-options) guide.
|
||||||
|
|
||||||
## Testing: added component test plunkers (2016-12-02)
|
## 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: <live-example name="setup" plnkr="quickstart-specs">one</live-example> for the QuickStart seed's `AppComponent` and <live-example name="testing" plnkr="banner-specs">another</live-example> 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: <live-example name="setup" plnkr="quickstart-specs">one</live-example> for the QuickStart seed's `AppComponent` and <live-example name="testing" plnkr="banner-specs">another</live-example> for the Testing guide's `BannerComponent`.
|
||||||
|
@ -76,9 +76,9 @@ block includes
|
||||||
The sample demonstrates these features too.
|
The sample demonstrates these features too.
|
||||||
|
|
||||||
## Testing: karma file updates (2016-11-30)
|
## Testing: karma file updates (2016-11-30)
|
||||||
* karma.config + karma-test-shim can handle multiple spec source paths;
|
* `karma.config` + `karma-test-shim` can handle multiple spec source paths;
|
||||||
see quickstart issue: [angular/quickstart#294](https://github.com/angular/quickstart/issues/294)
|
see quickstart issue: [angular/quickstart#294](https://github.com/angular/quickstart/issues/294).
|
||||||
* Displays Jasmine Runner output in the karma-launched browser
|
* Displays Jasmine Runner output in the karma-launched browser.
|
||||||
|
|
||||||
## QuickStart Rewrite (2016-11-18)
|
## QuickStart Rewrite (2016-11-18)
|
||||||
The QuickStart is completely rewritten so that it actually is quick.
|
The QuickStart is completely rewritten so that it actually is quick.
|
||||||
|
@ -88,7 +88,7 @@ block includes
|
||||||
You are no longer asked to copy-and-paste code into setup files that were not explained anyway.
|
You are no longer asked to copy-and-paste code into setup files that were not explained anyway.
|
||||||
|
|
||||||
## Sync with Angular v.2.2.0 (2016-11-14)
|
## Sync with Angular v.2.2.0 (2016-11-14)
|
||||||
Docs and code samples updated and tested with Angular v.2.2.0
|
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)
|
## UPDATE: NgUpgrade Guide for the AOT friendly _upgrade/static_ module (2016-11-14)
|
||||||
The updated [NgUpgrade Guide](upgrade.html) guide covers the
|
The updated [NgUpgrade Guide](upgrade.html) guide covers the
|
||||||
|
@ -98,20 +98,20 @@ block includes
|
||||||
The documentation for the version prior to v.2.2.0 has been removed.
|
The documentation for the version prior to v.2.2.0 has been removed.
|
||||||
|
|
||||||
## ES6 described in "TypeScript to JavaScript" (2016-11-14)
|
## ES6 described in "TypeScript to JavaScript" (2016-11-14)
|
||||||
The updated "[TypeScript to JavaScript](../cookbook/ts-to-js.html)" cookbook
|
The updated [TypeScript to JavaScript](../cookbook/ts-to-js.html) cookbook
|
||||||
now explains how to write apps in ES6/7
|
now explains how to write apps in ES6/7
|
||||||
by translating the common idioms in the TypeScript documentation examples
|
by translating the common idioms in the TypeScript documentation examples
|
||||||
(and elsewhere on the web) to ES6/7 and ES5.
|
(and elsewhere on the web) to ES6/7 and ES5.
|
||||||
|
|
||||||
## Sync with Angular v.2.1.1 (2016-10-21)
|
## Sync with Angular v.2.1.1 (2016-10-21)
|
||||||
Docs and code samples updated and tested with Angular v.2.1.0
|
Docs and code samples updated and tested with Angular v.2.1.1.
|
||||||
|
|
||||||
## npm _@types_ packages replace _typings_ (2016-10-20)
|
## npm _@types_ packages replace _typings_ (2016-10-20)
|
||||||
Documentation samples now get TypeScript type information for 3rd party libraries
|
Documentation samples now get TypeScript type information for 3rd party libraries
|
||||||
from npm `@types` packages rather than with the _typings_ tooling.
|
from npm `@types` packages rather than with the _typings_ tooling.
|
||||||
The `typings.json` file is gone.
|
The `typings.json` file is gone.
|
||||||
|
|
||||||
The "[AngularJS Upgrade](upgrade.html)" guide reflects this change.
|
The [AngularJS Upgrade](upgrade.html) guide reflects this change.
|
||||||
The `package.json` installs `@types/angular` and several `@types/angular-...`
|
The `package.json` installs `@types/angular` and several `@types/angular-...`
|
||||||
packages in support of upgrade; these are not needed for pure Angular development.
|
packages in support of upgrade; these are not needed for pure Angular development.
|
||||||
|
|
||||||
|
@ -132,7 +132,7 @@ block includes
|
||||||
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)
|
## Sync with Angular v.2.1.0 (2016-10-12)
|
||||||
Docs and code samples updated and tested with Angular v.2.1.0
|
Docs and code samples updated and tested with Angular v.2.1.0.
|
||||||
|
|
||||||
## NEW "Ahead of time (AOT) Compilation" cookbook (2016-10-11)
|
## NEW "Ahead of time (AOT) Compilation" cookbook (2016-10-11)
|
||||||
The NEW [Ahead of time (AOT) Compilation](../cookbook/aot-compiler.html) cookbook
|
The NEW [Ahead of time (AOT) Compilation](../cookbook/aot-compiler.html) cookbook
|
||||||
|
@ -141,7 +141,7 @@ block includes
|
||||||
followed by the more advanced considerations of compiling and bundling the Tour of Heroes.
|
followed by the more advanced considerations of compiling and bundling the Tour of Heroes.
|
||||||
|
|
||||||
## Sync with Angular v.2.0.2 (2016-10-6)
|
## Sync with Angular v.2.0.2 (2016-10-6)
|
||||||
Docs and code samples updated and tested with Angular v.2.0.2
|
Docs and code samples updated and tested with Angular v.2.0.2.
|
||||||
|
|
||||||
## "Routing and Navigation" guide with the _Router Module_ (2016-10-5)
|
## "Routing and Navigation" guide with the _Router Module_ (2016-10-5)
|
||||||
The [Routing and Navigation](router.html) guide now locates route configuration
|
The [Routing and Navigation](router.html) guide now locates route configuration
|
||||||
|
@ -168,16 +168,16 @@ block includes
|
||||||
|
|
||||||
## "Style Guide" with _NgModules_ (2016-09-27)
|
## "Style Guide" with _NgModules_ (2016-09-27)
|
||||||
|
|
||||||
[StyleGuide](style-guide.html) explains our recommended conventions for Angular modules (NgModule).
|
[StyleGuide](style-guide.html) explains recommended conventions for Angular modules (NgModule).
|
||||||
Barrels now are far less useful and have been removed from the style guide;
|
Barrels now are far less useful and have been removed from the style guide;
|
||||||
they remain valuable but are not a matter of Angular style.
|
they remain valuable but are not a matter of Angular style.
|
||||||
We also relaxed the rule that discouraged use of the `@Component.host` property.
|
Also relaxed the rule that discouraged use of the `@Component.host` property.
|
||||||
|
|
||||||
## _moduleId: module.id_ everywhere (2016-09-25)
|
## _moduleId: module.id_ everywhere (2016-09-25)
|
||||||
|
|
||||||
Sample components that get their templates or styles with `templateUrl` or `styleUrls`
|
Sample components that get their templates or styles with `templateUrl` or `styleUrls`
|
||||||
have been converted to _module-relative_ URLs.
|
have been converted to _module-relative_ URLs.
|
||||||
We added the `moduleId: module.id` property-and-value to their `@Component` metadata.
|
Added the `moduleId: module.id` property-and-value to their `@Component` metadata.
|
||||||
|
|
||||||
This change is a requirement for compilation with AOT compiler when the app loads
|
This change is a requirement for compilation with AOT compiler when the app loads
|
||||||
modules with SystemJS as the samples currently do.
|
modules with SystemJS as the samples currently do.
|
||||||
|
|
Loading…
Reference in New Issue