Commit Graph

2476 Commits

Author SHA1 Message Date
Judy Bogart 0c47dc0466 docs: add universal terms to glossary (#28492)
PR Close #28492
2019-04-04 14:26:36 -07:00
Pete Bacon Darwin 433b7b02a4 test(docs-infra): fix eslint warnings (#29673)
```
warning  An "it" that uses an async method should handle failure (use "done.fail")  jasmine/no-promise-without-done-fail
```

PR Close #29673
2019-04-04 10:52:36 -07:00
Pete Bacon Darwin a4f3f3f81d build(docs-infra): support doc aliases via `@alias` dgeni tag (#29673)
Now, one can add an `@alias` tag to API docs, which tells dgeni that this
API element (usually a `const`) is really just an alias for some API element
defined elsewhere.

Dgeni will then look up this API element and copy over the properties from
the alias to the current doc.

For example, we would like to privately export an Enum from `@angular/core`
but then publicly export this from `@angular/common`:

**packages/core/private_exports.ts**

```ts
/**
 * Description of this document.
 */
export enum ɵSomeEnum { ... }
```

**packages/common/public_api.ts**

```ts
import {ɵSomeEnum} from '@angular/core';

 /**
 * @alias core/ɵSomeEnum
 */
export const SomeEnum = ɵSomeEnum;
```

In the generated docs there will be a page for `common/SomeEnum`, which
will be rendered as an enum, rather than a const, showing the description
extracted from the `core/ɵSomeEnum`.

---

The implementation of this feature required some refactoring of the other
processing:

1. Previously `ɵ` prefixed exports were not even considered.
2. Due to 1. some processors needed to have guards added to ignore such
   private exports (`addMetadataAliases` and `checkContentRules`).
3. The processing of package pages had to be reworked (and split) so that
   it picked up the aliased export docs after their alias proeprties had
   been copied.

See FW-1207, FW-632, #29249

PR Close #29673
2019-04-04 10:52:36 -07:00
Pete Bacon Darwin 6233cd55f7 style(docs-infra): fix typo (#29673)
PR Close #29673
2019-04-04 10:52:36 -07:00
musou1500 eaa49bdc04 docs: fix typo in getting-started/routing (#29676)
PR Close #29676
2019-04-04 10:51:44 -07:00
zverbeta afd2417ecd docs: add ibm carbon ui library (#29706)
PR Close #29706
2019-04-04 10:50:05 -07:00
Dave c7ff728723 docs: add angular.de to the workshops page (#28856)
undo unrelated whitespace change

PR Close #28856
2019-04-03 15:39:20 -07:00
Maxime Lafarie d96f62fdc4 docs: add ngx-smart-modal to doc resources (#29661)
PR Close #29661
2019-04-03 15:36:29 -07:00
Stephen Fluin b9fead7f83 docs: update announcements for home page (#29671)
Updated dates, add tracking to links

PR Close #29671
2019-04-03 15:36:03 -07:00
George Kalpakas 648adb1894 build(docs-infra): upgrade cli command docs sources to b00300ebd (#29679)
Updating [angular#master](https://github.com/angular/angular/tree/master) from [cli-builds#master](https://github.com/angular/cli-builds/tree/master).
Relevant changes in [commit range](f63f8c60f...b00300ebd):

**Modified**
- help/build.json
- help/generate.json

PR Close #29679
2019-04-03 15:31:15 -07:00
Vani ddb935fac7 docs: update examples region to match the description in the guide (#29259)
PR Close #29259
2019-04-02 16:09:19 -07:00
Kara 630aaa6bfb docs: add Deborah Kurata to Trusted Collaborators (#29605)
This commit adds Deborah to the Trusted Collaborators list, so she will appear in the Collaborators list on angular.io.
PR Close #29605
2019-04-02 15:53:48 -07:00
Alex Eagle 03d914a6c2 build: hide @angular/http for Angular v8 (#29550)
Currently our plan is to skip the publish, docgen, and update steps for this package.
During RC, we'll determine if the breaking change is too difficult for users, in which case we might restore the package for another major.

PR Close #29550
2019-04-02 10:55:31 -07:00
Emilie Huet cbd5d28f71 docs: add info regarding injecting custom pipes (#28291)
Indicate that a pipe also needs to be included in the providers array

PR Close #28291
2019-04-02 10:38:36 -07:00
Pete Bacon Darwin 9f54d76ef5 refactor(upgrade): use Bazel packages to avoid symlinks in the source (#29466)
Previously we had to share code between upgrade/dynamic and upgrade/static
by symlinking the `src` folder, which allowed both packages to access
the upgrade/common files.

These symlinks are always problematic on Windows, where we had to run
a script to re-link them, and restore them.

This change uses Bazel packages to share the `upgrade/common` code,
which avoids the need for symlinking the `src` folder.

Also, the Windows specific scripts that fixup the symlinks have also
been removed as there is no more need for them.

PR Close #29466
2019-04-02 10:38:01 -07:00
George Kalpakas 0e201ea9d8 fix(docs-infra): fix scroll position restoration error in `ScrollService` (#29658)
Based on Google Analytics error report, the following error happens
occasionally (15% or total errors for 2019-03):

```
Cannot read property '0' of null TypeError: at t.scrollToPosition@main.js
```

This was a result of calling [ViewportScroller#scrollToPosition()][1]
with `null`, which in turn happens when calling
[ScrollService#scrollToPosition()][2] while `this.scrollPosition` is
`null`. This can be a result of a `popstate` event without an associated
history state.

This commit fixes the error by checking whether `this.scrollPosition` is
`null`, before using it with `scrollToPosition()`.

(It also refactors away the unneeded internal `popStateFired` property.)

[1]: https://github.com/angular/angular/blob/deca6a60d/packages/common/src/viewport_scroller.ts#L101-L105
[2]: https://github.com/angular/angular/blob/deca6a60d/aio/src/app/shared/scroll.service.ts#L158-L161

PR Close #29658
2019-04-02 10:26:49 -07:00
George Kalpakas 53be333439 perf(docs-infra): avoid unnecessary JSON parsing in `ScrollService` (#29658)
PR Close #29658
2019-04-02 10:26:49 -07:00
George Kalpakas 19081dc9a3 refactor(docs-infra): minor clean-up of `ScrollService` (#29658)
PR Close #29658
2019-04-02 10:26:49 -07:00
cexbrayat 9e4c0bd815 docs: fix typos in getting-started (#29665)
PR #27684 introduced a new getting-started guide and a few typos slipped through the review.

PR Close #29665
2019-04-02 10:25:59 -07:00
George Kalpakas deca6a60dd test(docs-infra): avoid click-related CI flake in e2e test (#29641)
One of the tests introduced in #29601 is susceptible to a kind of
WebDriver flake related to trying to click elements hidden behind fixed
positioned elements.
This commit works around the issue by clicking the elements directly
using JavaScript (instead of `WebElement#click()`).

PR Close #29641
2019-04-01 16:18:03 -07:00
Filipe Silva 8bfaaf164a docs: add Web Worker guide (#29633)
Followup to https://github.com/angular/angular-cli/pull/13700

PR Close #29633
2019-04-01 15:31:47 -07:00
Tim Deschryver abf69dec5b docs: fix typos in getting started (#29640)
PR Close #29640
2019-04-01 15:06:10 -07:00
Judy Bogart d7e5535d00 docs: add custom-element ref to library overview (#28476)
PR Close #28476
2019-04-01 12:04:06 -07:00
Martin Ockovsky 9cd90532c1 docs: add missing window key shortcut to language service guide (#29613)
PR Close #29613
2019-04-01 11:28:12 -07:00
Jorge Cano ff2a55f14f docs: update Jorge Cano GDE bio (#29622)
PR Close #29622
2019-04-01 11:26:40 -07:00
George Kalpakas 0abd5f5f03 test(docs-infra): add e2e test for the contributors page (#29601)
Previously, if the shape of data in `contributors.json` was incorrect,
there would be a runtime error (when trying to parse the data), which
would result in a blank page. The likelihood for this happening is
higher after #29553, where the shape of data changed.

This commit adds some basic e2e tests that verify the page works as
expected and there are contributors listed.

PR Close #29601
2019-04-01 11:24:42 -07:00
George Kalpakas cd6581e4f0 docs: use smaller image for Jason Bedard (since it was already available) (#29601)
PR Close #29601
2019-04-01 11:24:42 -07:00
Filipe Silva 8a13f6b278 docs: remove ngcc steps from Ivy opt-in (#29506)
PR Close #29506
2019-04-01 11:01:14 -07:00
Filipe Silva ee7c5ed620 docs: add Ivy lazy load opt-in (#29506)
PR Close #29506
2019-04-01 11:01:14 -07:00
George Kalpakas b2c03b8cd4 build(docs-infra): remove unused `PhantomJS` dependency (#29611)
PhantomJS is [not being developed any more][1] and with modern
alternatives (such as Chrome headless) there is no reason to keep it as
a dependency.

[1]: https://github.com/ariya/phantomjs/issues/15344

PR Close #29611
2019-04-01 10:57:30 -07:00
George Kalpakas fd4c939394 build(docs-infra): upgrade cli command docs sources to f63f8c60f (#29618)
Updating [angular#master](https://github.com/angular/angular/tree/master) from [cli-builds#master](https://github.com/angular/cli-builds/tree/master).
Relevant changes in [commit range](35df0b528...f63f8c60f):

**Modified**
- help/build.json

Closes #29607

PR Close #29618
2019-04-01 10:55:22 -07:00
Amit Chaurasia 6759aa68dc docs: added complete path to the spec file (#29621)
PR Close #29621
2019-04-01 10:54:30 -07:00
Roland Rytz ab4be7bf80 docs: fix typo in description of angular.io/index.html (#29630)
change "compeling" to "compelling" in description meta tag

PR Close #29630
2019-04-01 10:54:08 -07:00
George Kalpakas 2b6e107b1e build(docs-infra): add check to ensure all contributor pictures exist (#29553)
PR Close #29553
2019-03-29 11:01:45 -07:00
George Kalpakas 6a55ba28b2 docs: add Sam Julien to GDE group as well (#29553)
PR Close #29553
2019-03-29 11:01:45 -07:00
George Kalpakas 33524d9d9c feat(docs-infra): support contributors belonging to multiple groups (#29553)
PR Close #29553
2019-03-29 11:01:45 -07:00
George Kalpakas b99a070f88 refactor(docs-infra): change unused classes to interfaces (#29553)
PR Close #29553
2019-03-29 11:01:45 -07:00
George Kalpakas 799a5a4915 docs: change the order of groups in contributors page (#29553)
Put "Collaborators" before "GDE", since they are semantically closer to
the core team.

PR Close #29553
2019-03-29 11:01:45 -07:00
George Kalpakas 4b2407a4db docs: change heading of contributors page to avoid confusion (Collaborators --> Contributors) (#29553)
Now that "Collaborators" is a separate group in the contributors page,
having "Angular Collaborators" as the heading of the page (which also
contains the "Angular" and "GDE" groups) is confusing.
Changing the title to "Angular Contributors" to avoid confusion.

PR Close #29553
2019-03-29 11:01:45 -07:00
George Kalpakas ed19464be0 docs: change contributor group name (Collaborator --> Collaborators) (#29553)
The name of the group also serves as the group tab's title in the docs
app and having "Collaborator" (singular) as a title for a list of people
didn't read well.
Changing th group name (and thus tab title) to "Collaborators" (plural).

PR Close #29553
2019-03-29 11:01:45 -07:00
Brandon 12c9bd257d docs: add new getting started guide (#27684)
PR Close #27684
2019-03-29 10:47:37 -07:00
Vani 22b89ea58a docs: move text that mention what is expected to fail up higher into the section (#27329)
PR Close #27329
2019-03-29 10:30:28 -07:00
Kapunahele Wong e8921365b7 docs: remove coremodule references (#28434)
PR Close #28434
2019-03-29 10:29:51 -07:00
Jun 009acd2a6c docs(service-worker): add info about no network request for performance strategy (#29288)
PR Close #29288
2019-03-29 10:28:46 -07:00
javatutorials2016 71daa11357 docs: add note about ngModel usage in structural directives guide (#29522)
When I tried one of the examples provided in the documention, encountered the " Can't bind to 'ngModel' since it isn't a known property of 'select' ” error. So to resolve it I imported the FormsModule in ngModule. If it is mentioned in the documentation, it would be handy for the beginners to try and learn. Thanks for considering.

Duplicate of pull Request# 29206, As I encountered few issues after multiple authors corrected, So I am creating the new pull request

PR Close #29522
2019-03-29 10:26:15 -07:00
George Kalpakas a81fd5f750 build(docs-infra): upgrade cli command docs sources to 35df0b528 (#29583)
Updating [angular#master](https://github.com/angular/angular/tree/master) from [cli-builds#master](https://github.com/angular/cli-builds/tree/master).
Relevant changes in [commit range](42e87428d...35df0b528):

**Modified**
- help/add.json
- help/generate.json
- help/new.json

PR Close #29583
2019-03-29 10:25:30 -07:00
Judy Bogart 57f7996b6d docs: add asset config details (#28214)
PR Close #28214
2019-03-28 15:31:24 -07:00
Judy Bogart 27ba4ac982 docs: reorg deployment guide with serve-from-disk info from CLI story (#28217)
PR Close #28217
2019-03-28 15:30:50 -07:00
Judy Bogart 6c76dfc568 docs: copy-edit ivy opt-in page (#29507)
PR Close #29507
2019-03-28 15:29:49 -07:00
JoostK d46a7c8468 docs: add Joost Koehoorn to Angular collaborators (#29554)
PR Close #29554
2019-03-28 10:12:01 -07:00