265 Commits

Author SHA1 Message Date
Pete Bacon Darwin
48636f3e85 build(aio): compute stability and deprecate @stable tag ()
Closes 

PR Close 
2018-03-13 19:55:00 -07:00
Pete Bacon Darwin
cd58c0a6d9 build(aio): remove unwanted overview headings ()
PR Close 
2018-03-12 11:23:47 -07:00
Pete Bacon Darwin
38fef1588d build(aio): move "see also" block to export-base template ()
This makes it easier for all the API docs to display "see also" links
in a consitent manner.

PR Close 
2018-03-12 11:23:46 -07:00
Alex Eagle
1e6cc42a01 test: migrate remaining public-api tests to Bazel ()
We now create npm packages to cover all the public api assertions in tools/public_api_guard.
We no longer depend on ts-api-guardian from npm - it is now stale since the repository was archived.
There is no longer a gulp task to enforce or accept the public API, this is in CircleCI as part of running all bazel test targets.

PR Close 
2018-03-09 09:11:40 -08:00
Pete Bacon Darwin
b3d1761825 build(aio): compute and display short descriptions in methods ()
Previously only export docs were displaying a short description.
Now methods in classes and interfaces also compute and render
the short description.

Closes 

PR Close 
2018-03-06 11:05:21 -08:00
Pete Bacon Darwin
8ea4c57174 fix(aio): reposition and shrink the API badges ()
Closes 

PR Close 
2018-03-05 21:25:09 -08:00
Pete Bacon Darwin
58932c7f38 build(aio): indicate whether properties are read-only in API pages ()
PR Close 
2018-03-05 10:15:37 -08:00
Pete Bacon Darwin
5bb9f64218 fixup! feat(aio): allow template to position embedded ToC ()
PR Close 
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
405d97431f fixup! feat(aio): allow template to position embedded ToC ()
PR Close 
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
41064fcb36 fix(aio): reposition and simplify github links ()
Closes 

PR Close 
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
b80fd6be58 build(aio): render whether API classes and members are abstract ()
Closes 

PR Close 
2018-03-05 10:13:43 -08:00
Pete Bacon Darwin
b64139650c build(aio): class API template once again extends export-base ()
PR Close 
2018-03-05 10:12:55 -08:00
Pete Bacon Darwin
1d2bdcb4d0 build(aio): render param descriptions for function exports ()
Closes 

PR Close 
2018-03-05 10:12:55 -08:00
Pete Bacon Darwin
0e311e3918 build(aio): improve accuracy of code auto-linking ()
The new version of `dgeni-packages/typescript` no longer strips
out "namespaces" from types, which was part of the problem of
not autolinking correctly to `HttpEventType.Response`.

Another part of the problem was that we did not include `.`
characters when matching potential code blocks for auto-linking,
which precluded properties of enums from being linked.

Finally, members we not being given a `path` property, which is
needed to effectively autolink to them. This is now set in
the `simplifyMemberAnchors` processor.

Closes 

PR Close 
2018-03-01 08:11:19 -08:00
Pete Bacon Darwin
997b30a093 build(aio): move link disambiguation from getLinkInfo to getDocFromAlias ()
The disambiguation needs to be done earlier so that the auto-link-code
post-processor can benefit from it.

PR Close 
2018-03-01 08:11:19 -08:00
Pete Bacon Darwin
94707fe795 build(aio): initialise exampleMap correctly ()
The `exampleMap` needs to hold an hash object for each
of the `collectExamples.exampleFolders` paths.

Previously these hash objects were only created if there
was actually an example file the hash's respective
example folder.  This could cause crashes during
`yarn docs-watch` (and so also `yarn sync-and-serve`)
if no examples were read in for a particular run of
the doc-gen.

PR Close 
2018-03-01 08:10:15 -08:00
Pete Bacon Darwin
7d65356ae3 build(aio): add @usageNotes tag def for API docs ()
PR Close 
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
11f30fc351 style(aio): add newline between test blocks ()
PR Close 
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
b107131f8a build(aio): split the description property in API docs ()
* The first paragraph is now split off into the `shortDescription` property.
* Usage of `howToUse` and `whatItDoes` have been updated.
* The "Overview" heading for class is removed as it is self-evident
* The original horizontal rule styling below the main heading is removed as not part of the new design

Closes 

PR Close 
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
b924ce3a62 build(aio): add processor to migrate legacy tags @whatItDoes and @howToUse ()
See https://github.com/angular/angular/issues/22135#issuecomment-367632372

PR Close 
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
e75f0cee18 build(aio): deprecate @howToUse and @whatItDoes tags ()
See https://github.com/angular/angular/issues/22135#issuecomment-367632372

PR Close 
2018-02-28 10:43:27 -08:00
Pete Bacon Darwin
83b32a0a0a build(aio): render heading anchors on the right
This approach simplifies the styling needed considerably.
Previously, we had to make room on the left for heading that
are in visual containers. Also we had to apply a `float:right`
when on narrow screens as the gutter not available then.
This float didn't render nicely if the heading text was longer
than could be rendered on a single line.

Closes 
2018-02-27 18:32:32 -08:00
George Kalpakas
142117f6bb fix(aio): do not show Properties/Methods sections if only internal members ()
PR Close 
2018-02-27 15:17:22 -08:00
George Kalpakas
d100f1b187 build(aio): fix API docs breadcrumbs ()
This also prevents some extra `<a>` elements inserted by the browser's
trying to fix the HTML structure, which also fixes the `.header-link`
added in ToC.

Fixes 
Closes 

PR Close 
2018-02-27 07:08:07 -08:00
Pete Bacon Darwin
4bd3e5f92f build(aio): do not render "constructor()" heading in API docs ()
Closes 

PR Close 
2018-02-27 07:07:16 -08:00
Pete Bacon Darwin
c10c831b8e build(aio): render subclasses + see-also block in the main flow ()
Closes 

PR Close 
2018-02-26 17:50:42 -08:00
Ward Bell
a7e1f236ff docs: testing guide for CLI ()
- updates tests
- heavy prose revisions
- uses HttpClient (with angular-in-memory-web-api)
- test HeroService using `HttpClientTestingModule`
- scrub away most By.CSS
- fake async observable with `asyncData()`
- extensive Twain work
- different take on retryWhen
- remove app barrels (& systemjs.extras) which troubled plunker/systemjs
- add dummy export const to hero.ts (plunkr/systemjs fails w/o it)
- shrink and re-organize TOC
- add marble testing package and tests
- demonstrate the "no beforeEach()" test coding style
- add section on Http service testing
- prepare for stackblitz
- confirm works in plunker except excluded marble test
- add tests for avoidFile class feature of CodeExampleComponent

PR Close 
2018-02-26 13:40:23 -08:00
Pete Bacon Darwin
1f599818bd build(aio): fix rendering of callable and constructable interface members ()
Closes 

PR Close 
2018-02-26 13:35:15 -08:00
Pete Bacon Darwin
5a32d7e36f build(aio): render default value for optional parameters ()
Closes 

PR Close 
2018-02-26 13:34:38 -08:00
Pete Bacon Darwin
1ea41d48d3 build(aio): render whether parameters are optional ()
Closes 

PR Close 
2018-02-26 13:34:38 -08:00
Pete Bacon Darwin
25a43041d2 build(aio): group API members by type in overview ()
Now the overview groups the members in the following order:

* static properties
* static methods
* constructor
* instance properties
* instance members

Closes 

PR Close 
2018-02-26 13:34:04 -08:00
George Kalpakas
978f97cc59 test(aio): increase docs-test timeouts to prevent flakes on Travis ()
PR Close 
2018-02-16 14:46:23 -08:00
Pete Bacon Darwin
fbef94a8ee feat(aio): enable data driven homepage announcements ()
PR Close 
2018-02-09 13:10:11 -08:00
Pete Bacon Darwin
7007f51c35 feat(aio): first pass API docs redesign ()
Includes:

* display ToC for API docs
* update dgeni-packages to 0.24.1
* add floating sidebar in API docs
* add breadcrumbs and structured data for Google crawler
* improved rendering of method overloads
* properties rendered in a table
* params rendered with docs
* removal of outdated "infobox" from all API docs

PR Close 
2018-02-09 13:05:16 -08:00
Jesus Rodriguez
cd25939be9 build(aio): update examples to CLI to 1.6.5 ()
PR Close 
2018-02-07 16:09:26 -08:00
Pete Bacon Darwin
71ea931df5 build(aio): blacklist unwanted URLs from the generated sitemap.xml ()
Closes 

PR Close 
2018-02-07 12:02:01 -08:00
Pete Bacon Darwin
9a0700f5bd build(aio): add API static members to search index ()
Previously searching for `compose` did not include `Validators`
in the search results because we were not including all the
`static` members of API docs in the index.

PR Close 
2018-02-05 13:00:47 -08:00
Pete Bacon Darwin
bf29936af9 build(aio): test Firebase hosting redirection configuration ()
PR Close 
2018-02-02 07:52:30 -08:00
Ward Bell
7a20691f13 docs: add http guide sample and adjust text ()
PR Close 
2018-01-31 10:24:43 -08:00
Pete Bacon Darwin
c83c4168ca build(aio): upgrade to dgeni-packages 0.24.0 ()
This has two benefits:

* it prepares the way for the API docs update, which need parameter docs
* it doesn't incorrectly report dangling links for non-latin anchors

Closes 

PR Close 
2018-01-31 10:20:37 -08:00
Pete Bacon Darwin
d6d8fe829a build(aio): upgrade CLI version to cope with new Angular 6.0.0-beta.1 release ()
Before version 1.6 of Angular CLI there was a check that prevented use of Angular
compiler CLI with major version 6.

PR Close 
2018-01-25 13:38:12 -08:00
Miško Hevery
bf5f50d9ee Revert "build(aio): add tests for Firebase redirection ()"
This reverts commit 01cef016ee81816bc3229863396924ae0dca3bdf.
2018-01-24 15:50:00 -08:00
George Kalpakas
d0e086a5fe fix(aio): remove remaining plnkr references ()
PR Close 
2018-01-23 21:30:27 -08:00
George Kalpakas
15c2a93f14 build(aio): check for obsolete plnkr.json and missing main files ()
Also, remove `plnkr.json` for `service-worker-getting-started` guide,
since it is not used and ServiceWorker cannot work correctly in
plnkr/stackblitz anyway (e.g. no build step to re-compute hashes).
A zipper might be useful and can be added in a subsequent PR, but it is
currently broken (e.g. no dependency on `@angular/service-worker`).

PR Close 
2018-01-23 21:30:27 -08:00
Ward Bell
8522546a8a build(aio): upgrade sample package.json files to jasmine@~2.8.0 ()
- Update tooling to support revised testing guide (PR ).
- Require jasmine upgrade for examples that use marble testing.
- Copy `cli/package.json` to `testing/` and add `jasmine-marbles`.
- Resolve merge conflicts created by `NgModules` guides.

PR Close 
2018-01-23 21:30:27 -08:00
Jesus Rodriguez
1a75934cc0 build(aio): migrate plunker to stackblitz ()
PR Close 
2018-01-23 21:30:27 -08:00
Pete Bacon Darwin
01cef016ee build(aio): add tests for Firebase redirection ()
PR Close 
2018-01-23 13:33:36 -08:00
Pete Bacon Darwin
a64af40c0b build(aio): generate sitemap from the generated pages ()
Closes 

PR Close 
2018-01-22 12:55:15 -08:00
George Kalpakas
8e8924ac7c ci: use sudo: false on Travis ()
Related to .

PR Close 
2018-01-19 13:23:47 -08:00
George Kalpakas
b2e902deb4 fix(aio): fix code highlight in API docs templates ()
Fixes 

PR Close 
2018-01-19 13:23:41 -08:00