c08a3830df
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/aot-compiler.md
# aio/content/guide/architecture.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/browser-support.md
# aio/content/guide/change-log.md
# aio/content/guide/component-styles.md
# aio/content/guide/deployment.md
# aio/content/guide/forms.md
# aio/content/guide/glossary.md
# aio/content/guide/http.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/ngmodule.md
# aio/content/guide/pipes.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/router.md
# aio/content/guide/security.md
# aio/content/guide/set-document-title.md
# aio/content/guide/setup-systemjs-anatomy.md
# aio/content/guide/setup.md
# aio/content/guide/testing.md
# aio/content/guide/typescript-configuration.md
# aio/content/guide/upgrade.md
# aio/content/marketing/docs.md
# aio/content/marketing/features.html
# aio/content/marketing/resources.json
# aio/content/navigation.json
# aio/src/app/layout/doc-viewer/doc-viewer.component.ts
2018-02-28 13:13:29 +08:00
1531b0610d
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/aot-compiler.md
# aio/content/guide/attribute-directives.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/browser-support.md
# aio/content/guide/component-interaction.md
# aio/content/guide/component-styles.md
# aio/content/guide/dependency-injection-in-action.md
# aio/content/guide/dependency-injection.md
# aio/content/guide/deployment.md
# aio/content/guide/displaying-data.md
# aio/content/guide/form-validation.md
# aio/content/guide/forms.md
# aio/content/guide/glossary.md
# aio/content/guide/http.md
# aio/content/guide/i18n.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/ngmodule.md
# aio/content/guide/npm-packages.md
# aio/content/guide/pipes.md
# aio/content/guide/quickstart.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/structural-directives.md
# aio/content/guide/template-syntax.md
# aio/content/guide/testing.md
# aio/content/marketing/index.html
# aio/content/navigation.json
# aio/content/tutorial/index.md
# aio/content/tutorial/toh-pt1.md
# aio/content/tutorial/toh-pt2.md
# aio/content/tutorial/toh-pt3.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
# aio/content/tutorial/toh-pt6.md
# aio/src/app/embedded/api/api-list.component.ts
# aio/src/app/layout/doc-viewer/doc-viewer.component.ts
# aio/src/app/layout/footer/footer.component.html
# aio/src/app/layout/toc/toc.component.html
# aio/src/app/search/search.service.ts
# aio/src/styles/1-layouts/_marketing-layout.scss
# aio/yarn.lock
2018-02-28 08:08:59 +08:00
142117f6bb
fix(aio): do not show Properties/Methods sections if only internal members ( #22471 )
...
PR Close #22471
2018-02-27 15:17:22 -08:00
d100f1b187
build(aio): fix API docs breadcrumbs ( #22446 )
...
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 #22387
Closes #22437
PR Close #22446
2018-02-27 07:08:07 -08:00
4bd3e5f92f
build(aio): do not render "constructor()" heading in API docs ( #22380 )
...
Closes #22363
PR Close #22380
2018-02-27 07:07:16 -08:00
c10c831b8e
build(aio): render subclasses + see-also block in the main flow ( #22445 )
...
Closes #22386
PR Close #22445
2018-02-26 17:50:42 -08:00
1f599818bd
build(aio): fix rendering of callable and constructable interface members ( #22428 )
...
Closes #22136
PR Close #22428
2018-02-26 13:35:15 -08:00
5a32d7e36f
build(aio): render default value for optional parameters ( #22435 )
...
Closes #22134
PR Close #22435
2018-02-26 13:34:38 -08:00
1ea41d48d3
build(aio): render whether parameters are optional ( #22435 )
...
Closes #22134
PR Close #22435
2018-02-26 13:34:38 -08:00
25a43041d2
build(aio): group API members by type in overview ( #22438 )
...
Now the overview groups the members in the following order:
* static properties
* static methods
* constructor
* instance properties
* instance members
Closes #22132
PR Close #22438
2018-02-26 13:34:04 -08:00
978f97cc59
test(aio): increase `docs-test` timeouts to prevent flakes on Travis ( #22261 )
...
PR Close #22261
2018-02-16 14:46:23 -08:00
fbef94a8ee
feat(aio): enable data driven homepage announcements ( #22043 )
...
PR Close #22043
2018-02-09 13:10:11 -08:00
7007f51c35
feat(aio): first pass API docs redesign ( #21874 )
...
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 #21874
2018-02-09 13:05:16 -08:00
71ea931df5
build(aio): blacklist unwanted URLs from the generated sitemap.xml ( #22061 )
...
Closes #22017
PR Close #22061
2018-02-07 12:02:01 -08:00
9a0700f5bd
build(aio): add API static members to search index ( #21988 )
...
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 #21988
2018-02-05 13:00:47 -08:00
c83c4168ca
build(aio): upgrade to dgeni-packages 0.24.0 ( #21802 )
...
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 #21306
PR Close #21802
2018-01-31 10:20:37 -08:00
1a75934cc0
build(aio): migrate plunker to stackblitz ( #20165 )
...
PR Close #20165
2018-01-23 21:30:27 -08:00
a64af40c0b
build(aio): generate sitemap from the generated pages ( #21689 )
...
Closes #21684
PR Close #21689
2018-01-22 12:55:15 -08:00
b2e902deb4
fix(aio): fix code highlight in API docs templates ( #21630 )
...
Fixes #21108
PR Close #21630
2018-01-19 13:23:41 -08:00
d6ba9f9fb4
build(aio): move file cleaning to later in the doc gen ( #21540 )
...
Previously the generated files were cleaned out before
doc-gen began (via a yarn pre-script). This can cause a
race condition in the CLI server, which prevents the new
generated files from being picked up.
Now we delay the cleaning until the last minute to ensure
that they ar still picked up by the webpack server.
PR Close #21540
2018-01-16 07:10:30 -08:00
6cd4b1b41c
build(aio): add `@nodoc` alias to the `@internal` tag ( #21024 )
...
The `@internal` tag prevents code items from appearing in the docs and the
typings files. You can now use `@nodoc` if you only want it to be excluded
from the docs and not the typings files.
Closes #20990
PR Close #21024
2018-01-05 14:59:59 -05:00
a693c5614c
ci: add router/testing to public API guard
2017-12-19 10:45:33 -08:00
e2b76bb386
build(aio): filter out ambiguous directives from auto code linking ( #20512 )
...
Closes #20466
PR Close #20512
2017-11-21 22:28:16 -06:00
ae0275e2dd
build(aio): do not store duplicate metadata aliases ( #20512 )
...
Having duplicates was causing the code auto-linking
to ignore `ngForm` directives.
PR Close #20512
2017-11-21 22:28:16 -06:00
ecce90718b
build(aio): better parsing of selectors as aliases for directives/components ( #20512 )
...
PR Close #20512
2017-11-21 22:28:16 -06:00
7c44637fbf
build(aio): tighten up code autolinking ( #20468 )
...
Do not match code "words" that are part of a hyphenated
string of characters: e.g. `platform-browser-dynamic` should
not auto-link `browser`.
Do not match code "words" that correspond to pipe names
but are not preceded by a pipe `|` character. E.g. `package.json` should
not auto link `json` to the `JsonPipe`.
Closes #20187
PR Close #20468
2017-11-16 16:20:03 -06:00
7e38f4fd1f
fix(aio): fix window title on Home page ( #20440 )
...
Using `display: none` on the `<h1>` causes `innerText` to not work as expected
and include the icon ligature (`link`) in the title. This caused the window
title on the angular.io Home page to appear as "Angular - link".
This commit fixes it by not generating anchors at all for headings with the
`no-anchor` class.
Fixes #20427
PR Close #20440
2017-11-15 18:25:58 -06:00
3997d97806
revert: feat(elements): implement `@angular/elements` #19469 ( #20152 )
...
This PR was merged without API docs and general rollout plan.
We can't release this as is in 5.1 without a plan for documentation, cli integration, etc.
2017-11-03 15:54:54 -07:00
ebfa204af0
feat(elements): set up the `elements` package
2017-11-02 16:09:09 -07:00
068348e9b1
build(aio): do not fail the initial doc-gen when running docs-watch
...
Checks that cause the doc-gen to fail were already disabled in `docs-watch`
for the doc-gen that runs when a file is changed.
Now these checks are also disabled for the initial doc-gen run.
closes #20038
2017-11-02 15:03:59 -07:00
1beab0da6a
build(aio): do not fail on bad examples when running `docs-watch`
2017-11-02 15:00:22 -07:00
3a03ff6b2d
build(aio): allow render-examples to complete even if examples are broken
...
By setting `renderExamples.ignoreBrokenExamples = true` the doc-gen will
not fail if there is something wrong with an example. Instead it will
just log a warning.
2017-11-02 15:00:22 -07:00
0355142737
build(aio): fail doc-gen if a code-example is badly formatted.
...
This will catch the problem that was missed in
https://github.com/angular/angular/pull/19845#issuecomment-338626662
2017-11-02 14:58:38 -07:00
9ab1f4a9c9
style(aio): fix docs linting issues ( #19702 )
...
These issues appeared after upgrade of eslint jasmine plugin
PR Close #19702
2017-11-01 15:24:46 -07:00
4abacb58f1
fix(aio): add service worker entrypoint to aio build ( #19875 )
...
Fixes #19838
PR Close #19875
2017-10-23 19:31:42 -04:00
dbe6cdad7e
build(aio): improve accessor rendering ( #19637 )
...
Includes an update to `dgeni-packages@0.22.0` which provides more info
about accessors if required.
PR Close #19637
2017-10-11 11:51:42 -07:00
8b571309ed
build(aio): append information about links in and out of docs ( #19583 )
...
Closes #19560
PR Close #19583
2017-10-10 17:06:51 -07:00
963a4d0dc8
build(aio): sort API list alphabetically ( #19566 )
...
Closes #19559
PR Close #19566
2017-10-09 14:42:52 -07:00
9783c92935
build(aio): fix various API rendering issues
...
Upgrading to dgeni-packages 0.21.4 gives us
access to more properties on the API docs, which
allows us to fix the following issues:
Closes #19450
Closes #19452
Closes #19456
2017-10-03 08:15:02 -07:00
d7fd581c37
Merge branch 'master' into aio
...
# Conflicts:
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/browser-support.md
# aio/content/guide/form-validation.md
# aio/content/guide/i18n.md
# aio/content/guide/pipes.md
# aio/content/guide/router.md
# aio/content/guide/set-document-title.md
# aio/content/guide/structural-directives.md
# aio/content/guide/template-syntax.md
# aio/content/guide/testing.md
# aio/content/marketing/resources.json
# aio/content/tutorial/toh-pt1.md
# aio/content/tutorial/toh-pt2.md
# aio/content/tutorial/toh-pt3.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
2017-10-01 13:22:33 +08:00
ffceae0a01
refactor(aio): remove unnecessary `--` from yarn commands
2017-09-25 14:37:13 -07:00
adb0b761f1
build(aio): add metadata aliases for directives, components and pipes ( #19317 )
...
This change will enable people to link to the API docs via their selectors
or names, as used in a template.
Since the selectors can be quite complex we are not able to get 100%
accuracy.
Closes #16787
2017-09-25 12:00:05 -07:00
97e02c2fa0
build(aio): render class/interface "descendants" in API docs ( #19343 )
...
For classes, the tree of subclasses is rendered, recursively.
For interfaces, the descendants are separated into child interfaces, which
extend the interface, and classes, which implement the interface.
Closes #19306
2017-09-25 11:59:44 -07:00
4ae546be1f
build(aio): ensure decorators with shared interface types are found ( #19361 )
...
Closes #19358
2017-09-25 11:59:21 -07:00
4c73b52d5c
docs(aio): tidy up tooling documentation ( #18151 )
...
PR Close #18151
2017-09-21 10:00:37 -07:00
4530654501
docs(aio): high-level documentation of the `transforms` folder ( #18151 )
...
PR Close #18151
2017-09-21 10:00:36 -07:00
381e680758
build(aio): improve error message for ignored example files ( #19265 )
...
Addresses https://github.com/angular/angular/pull/18707#issuecomment-330396771
PR Close #19265
2017-09-20 12:36:14 -07:00
988b9f8378
build(aio): remove commented out code ( #19265 )
...
PR Close #19265
2017-09-20 12:36:14 -07:00
9ab9437319
build(aio): auto-link more code items
...
We now parse all code blocks, after they have been rendered by dgeni
and insert links to API docs that match "words" in the code.
2017-09-12 13:58:43 -04:00
a2b50ec8c9
build(aio): do not render annotations block for directives
2017-09-12 13:56:21 -04:00
Zhicheng Wang
George Kalpakas
Pete Bacon Darwin
Jesus Rodriguez
Jason Aden
Igor Minar
Alex Rickabaugh