335 Commits

Author SHA1 Message Date
Zhicheng WANG
d5057aec3b Merge remote-tracking branch 'en/master' into aio 2019-06-03 10:09:20 +08:00
George Kalpakas
d80ae6ba0d build(docs-infra): ensure hidden cli commands are excluded from sitemap.xml (#30395)
Previously, the processor that excludes certain cli commands
(`filterHiddenCommand`) was being run after the `createSitemap`
processor, resulting in those commands to be present in `sitemap.xml`,
while the actual pages where missing. This also resulted in 404s, when
search engine crawlers tried to index the missing URLs.

This commit fixes it by ensuring that the `filterHiddenCommand`
processor is run before the `createSitemap` processor.

PR Close #30395
2019-05-10 11:56:39 -07:00
Alex Rickabaugh
b0578061ce refactor(ivy): use ɵɵ instead of Δ for now (#29850)
The `Δ` caused issue with other infrastructure, and we are temporarily
changing it to `ɵɵ`.

This commit also patches ts_api_guardian_test and AIO to understand `ɵɵ`.

PR Close #29850
2019-04-11 16:27:56 -07:00
Ben Lesh
138ca5a246 refactor(ivy): prefix all generated instructions (#29692)
- Updates all instructions to be prefixed with the Greek delta symbol

PR Close #29692
2019-04-10 12:11:40 -07:00
George Kalpakas
8bbf481d60 refactor(docs-infra): rename properties (blacklisted --> ignored) (#29754)
PR Close #29754
2019-04-08 09:46:34 -07:00
George Kalpakas
c5bba8d9f2 build(docs-infra): do not include announcements.json in sitemap (#29754)
The `announcements.json` file should not be included in the sitemap and
including it causes an error in Google Search Console (because the
generated URL does not exist).

(This is a follow-up to fbef94a8e.)

PR Close #29754
2019-04-08 09:46:33 -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
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
Brandon
12c9bd257d docs: add new getting started guide (#27684)
PR Close #27684
2019-03-29 10:47:37 -07:00
Adam Plumer
6b6fdffc12 fixup! docs: update Universal guide (#28296)
PR Close #28296
2019-03-11 10:52:18 -07:00
Adam Plumer
a29ce57732 docs: migrate examples from @angular/http to @angular/common/http (#28296)
PR Close #28296
2019-03-11 10:52:17 -07:00
Zhicheng WANG
b035e68480 Merge remote-tracking branch 'en/master' into aio
# Conflicts:
#	.travis.yml
#	aio/content/guide/aot-compiler.md
#	aio/content/guide/architecture.md
#	aio/content/guide/build.md
#	aio/content/guide/dependency-injection-in-action.md
#	aio/content/guide/deployment.md
#	aio/content/guide/elements.md
#	aio/content/guide/file-structure.md
#	aio/content/guide/glossary.md
#	aio/content/guide/hierarchical-dependency-injection.md
#	aio/content/guide/lifecycle-hooks.md
#	aio/content/guide/ngmodule-faq.md
#	aio/content/guide/pipes.md
#	aio/content/guide/router.md
#	aio/content/guide/rx-library.md
#	aio/content/guide/service-worker-communications.md
#	aio/content/guide/service-worker-config.md
#	aio/content/guide/singleton-services.md
#	aio/content/guide/template-syntax.md
#	aio/content/guide/testing.md
#	aio/content/guide/typescript-configuration.md
#	aio/content/guide/universal.md
#	aio/content/marketing/docs.md
#	aio/content/marketing/features.html
#	aio/content/tutorial/toh-pt0.md
#	aio/content/tutorial/toh-pt6.md
#	aio/package.json
#	aio/src/app/layout/footer/footer.component.html
#	aio/tools/transforms/templates/api/lib/memberHelpers.html
#	aio/yarn.lock
#	integration/cli-hello-world-ivy-minimal/src/polyfills.ts
#	modules/benchmarks/e2e_test/largetable_perf.ts
#	modules/benchmarks/e2e_test/largetable_spec.ts
#	packages/animations/src/animation_metadata.ts
#	packages/common/http/src/headers.ts
#	packages/common/http/src/interceptor.ts
#	packages/common/src/directives/ng_for_of.ts
#	packages/common/src/directives/ng_if.ts
#	packages/common/src/directives/ng_style.ts
#	packages/common/src/directives/ng_switch.ts
#	packages/core/src/change_detection/change_detection_util.ts
#	packages/core/src/di/injectable.ts
#	packages/core/src/interface/lifecycle_hooks.ts
#	packages/core/src/linker/template_ref.ts
#	packages/core/src/metadata/di.ts
#	packages/core/src/metadata/directives.ts
#	packages/core/src/metadata/ng_module.ts
#	packages/core/src/render/api.ts
#	packages/forms/src/form_providers.ts
#	packages/forms/src/model.ts
#	packages/router/src/config.ts
#	packages/router/src/directives/router_link.ts
2019-02-17 00:00:16 +08:00
Zhicheng WANG
5aa7fbfe64 fix: 不再处理 span 和 a 2019-02-15 07:12:40 +08:00
Alan Agius
d940b5541f fix(docs-infra): boolean options default value is incorrect when it's undefined (#27024)
In the CLI when it's undefined it can mean `false`, or sometimes it will be overwritten by a runtime value.

PR Close #27024
2019-01-28 20:43:15 -08:00
WilliamKoza
e2c98fbe11 fix(docs-infra): change the key used to find out the cli section (#28293)
PR Close #28293
2019-01-24 15:41:44 -08:00
Zhicheng WANG
a58c6a846d fix: 增补翻译 2019-01-17 20:06:15 +08:00
Zhicheng WANG
da1d1aefef fix: 翻译默认 PR 文字 2019-01-17 20:06:15 +08:00
Zhicheng WANG
322397781b fix: force change repo to angular-cn 2019-01-17 20:06:15 +08:00
WilliamKoza
4c0104c846 fix(docs-infra): Add crossed through styling (#28111)
PR Close #28111
2019-01-14 10:45:46 -08:00
WilliamKoza
72f2428cd8 fix(docs-infra): change style of deprecated markers (#28111)
PR Close #28111
2019-01-14 10:45:46 -08:00
WilliamKoza
d577b8df75 fix(docs-infra): render deprecated markers for CLI command options (#28111)
fixes #27563
fixes #27423

PR Close #28111
2019-01-14 10:45:46 -08:00
Pete Bacon Darwin
cd51775390 build(docs-infra): render @see information in members (#28069)
Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.

PR Close #28069
2019-01-11 14:35:23 -08:00
Zhicheng WANG
dd5e3f9ff9 fix: change edit branch to aio 2019-01-06 20:32:17 +08:00
Zhicheng WANG
8957bbf209 fix: 翻译 CLI 模板 2019-01-04 14:39:52 +08:00
Zhicheng WANG
22e745af57 fix: 翻译 API 模板 2019-01-04 14:35:16 +08:00
Zhicheng WANG
9a86efc8ea fix: 翻译 API 模板 2019-01-04 14:33:26 +08:00
Zhicheng WANG
b86481285a fix: 翻译 API 模板 2019-01-04 14:06:54 +08:00
Zhicheng WANG
4c9e1a6a3d fix: 为 Hn 添加 id,以便和英文锚点保持一致 2019-01-04 10:59:10 +08:00
Zhicheng WANG
178778222f fix: 防止不同元素的对照文本混淆 2019-01-03 22:17:27 +08:00
Zhicheng WANG
1d65a38dcf Revert "fix: move mark code to post-process-html step"
This reverts commit 0cb8d723
2019-01-01 19:16:14 +08:00
Zhicheng WANG
0cb8d723ac fix: move mark code to post-process-html step 2019-01-01 16:16:02 +08:00
Zhicheng WANG
b018382e7d refactor: use standalone library instead of translator.js 2019-01-01 16:16:02 +08:00
Zhicheng WANG
8744f17f5d Merge remote-tracking branch 'en/master' into aio
# Conflicts:
#	aio/content/cli/index.md
#	aio/content/file-not-found.md
#	aio/content/guide/architecture-modules.md
#	aio/content/guide/architecture-services.md
#	aio/content/guide/build.md
#	aio/content/guide/deployment.md
#	aio/content/guide/elements.md
#	aio/content/guide/feature-modules.md
#	aio/content/guide/file-structure.md
#	aio/content/guide/forms-overview.md
#	aio/content/guide/glossary.md
#	aio/content/guide/i18n.md
#	aio/content/guide/npm-packages.md
#	aio/content/guide/releases.md
#	aio/content/guide/router.md
#	aio/content/guide/service-worker-config.md
#	aio/content/guide/service-worker-intro.md
#	aio/content/guide/testing.md
#	aio/content/guide/upgrade-performance.md
#	aio/content/navigation.json
#	aio/content/tutorial/toh-pt0.md
#	aio/content/tutorial/toh-pt5.md
#	aio/content/tutorial/toh-pt6.md
#	aio/package.json
#	aio/src/app/custom-elements/api/api-list.component.ts
#	aio/src/app/documents/document.service.ts
#	aio/src/app/layout/top-menu/top-menu.component.ts
#	aio/src/index.html
#	aio/src/styles/2-modules/_api-pages.scss
#	aio/tools/transforms/templates/api/base.template.html
#	aio/tools/transforms/templates/api/lib/memberHelpers.html
#	aio/tools/transforms/templates/cli/cli-container.template.html
#	aio/tools/transforms/templates/lib/githubLinks.html
#	aio/yarn.lock
#	packages/animations/src/animation_metadata.ts
#	packages/common/http/src/backend.ts
#	packages/common/http/src/client.ts
#	packages/common/http/src/headers.ts
#	packages/common/http/src/interceptor.ts
#	packages/common/http/src/module.ts
#	packages/common/http/src/params.ts
#	packages/common/http/src/request.ts
#	packages/common/http/src/response.ts
#	packages/common/src/common_module.ts
#	packages/common/src/directives/ng_class.ts
#	packages/common/src/directives/ng_style.ts
#	packages/common/src/directives/ng_switch.ts
#	packages/common/src/i18n/format_date.ts
#	packages/common/src/pipes/number_pipe.ts
#	packages/core/src/change_detection/change_detection_util.ts
#	packages/core/src/change_detection/pipe_transform.ts
#	packages/core/src/di/injectable.ts
#	packages/core/src/linker/element_ref.ts
#	packages/core/src/linker/template_ref.ts
#	packages/core/src/metadata/di.ts
#	packages/core/src/metadata/directives.ts
#	packages/core/src/metadata/lifecycle_hooks.ts
#	packages/core/src/metadata/ng_module.ts
#	packages/core/src/render/api.ts
#	packages/forms/src/directives/form_interface.ts
#	packages/forms/src/directives/ng_form.ts
#	packages/forms/src/directives/ng_model.ts
#	packages/forms/src/directives/reactive_directives/form_control_name.ts
#	packages/forms/src/directives/select_control_value_accessor.ts
#	packages/forms/src/directives/validators.ts
#	packages/forms/src/form_builder.ts
#	packages/forms/src/form_providers.ts
#	packages/forms/src/model.ts
#	packages/forms/src/validators.ts
#	packages/platform-browser/src/browser.ts
#	packages/platform-browser/src/security/dom_sanitization_service.ts
#	packages/router/src/config.ts
#	packages/router/src/events.ts
#	packages/router/src/router.ts
#	packages/router/src/router_module.ts
#	packages/router/src/shared.ts
2018-12-29 16:04:37 +08:00
Zhicheng WANG
577a18e2ac fix: 链接错误(#347) 2018-12-20 09:54:34 +08:00
Zhicheng WANG
c37a1e55f6 fix: 链接错误 (#347) 2018-12-20 09:28:52 +08:00
Pete Bacon Darwin
18b6d580c5 fix(docs-infra): update overload rendering (#24976)
Based on the review here:
https://github.com/angular/angular/pull/24976#issuecomment-415535125

PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
03417df54e build(docs-infra): display long overload parameter types as object (#24976)
In some overloads, the parameter type can be a large anonymous
object type.
This change displays such types as `object`. It is then up to the
documentation author to put more information about the type in the
method usage notes.

PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
61cd5f7c0f build(docs-infra): fix individual API overload templates (#24976)
* Make individual overloads collapsible
* Show only the first overload expanded, rest collapsed
* Text changes to 'collapse all' once 'show all' is clicked
* Fix chevron/carrot rotation animation when overloads / overload item is expanded or collapsed

PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
68dfa04f8a build(docs-infra): add method overload index (#24976)
PR Close #24976
2018-11-01 14:17:10 -07:00
Stefanie Fluin
6902977665 build(docs-infra): improve API overload templates (#24976)
PR Close #24976
2018-11-01 14:17:10 -07:00
Zhicheng Wang
1cf66d57f2 fix: point to angular-cn repo 2018-10-30 10:26:25 +08:00
Pete Bacon Darwin
d72d50d83e build(docs-infra): move CLI API desciption higher up (#26568)
Closes #26556

PR Close #26568
2018-10-29 13:01:08 -04:00
Pete Bacon Darwin
07509da78d build(docs-infra): ensure that CLI code blocks are not auto-linked (#26675)
Some of the text in CLI API docs were being auto-linked to API
pages. This was not correct, and in fact these blocks should not
have any auto links to Angular API at all.

Closes #26570

PR Close #26675
2018-10-26 18:09:20 -04:00
Pete Bacon Darwin
9ff8155cd9 build(docs-infra): mark code blocks to disable auto-linking (#26675)
You can now mark `<code>` blocks with a `no-auto-link` css class
to tell the code auto-linker to ignore this code block.

PR Close #26675
2018-10-26 18:09:20 -04:00
Pete Bacon Darwin
7c730fe5b3 build(docs-infra): include inherited members in search index (#26676)
Closes #23800

PR Close #26676
2018-10-26 13:16:33 -04:00
Pete Bacon Darwin
f233131974 build(docs-infra): refactor generateKeywords processor (#26676)
PR Close #26676
2018-10-26 13:16:32 -04:00
Zhicheng Wang
ea64d68962 docs: 汉化 CLI 模板 2018-10-22 19:55:49 +08:00
Zhicheng Wang
deeeaa9647 docs: 修正坏链 2018-10-22 18:47:41 +08:00