Repository navigation
Glossary: add workspace and related cli terms - #24633
jbogarthyde wants to merge 2 commits into
Conversation
|
Added to CLI description, added terms "workspace", "project", "schematic". |
|
@Brocco Can you check these, and give me a definition of an Angular library? |
|
You can preview 55d5d41 at https://pr24633-55d5d41.ngbuilds.io/. |
There was a problem hiding this comment.
This is incorrect, the new command is what creates a workspace, not the add command.
|
You can preview c8518ba at https://pr24633-c8518ba.ngbuilds.io/. |
|
You can preview 0d20111 at https://pr24633-0d20111.ngbuilds.io/. |
|
You can preview c4a8eae at https://pr24633-c4a8eae.ngbuilds.io/. |
c4a8eae to
271f325
Compare
|
You can preview 271f325 at https://pr24633-271f325.ngbuilds.io/. |
|
You can preview 364feae at https://pr24633-364feae.ngbuilds.io/. |
There was a problem hiding this comment.
Idea 1: The Angular CLI is a command-line tool for managing Angular workspaces and projects. You can use it to create a workspace....
I'm trying to find a word/phrase that describes its mission...and then the things it can do are examples of that mission.
Idea 2: I played with "for managing the lifecycle of Angular workspaces and projects" which neatly covers creating, building, packaging, deploying but I'm not sure is appropriate for modifying Angular apps via add or generating new components.
Idea 3: "for performing common lifecycle and development tasks"
Idea 4: "for accelerating common lifecycle and development tasks"
1 and 2 use "managing" which sets people up to understand that when you use the CLI to create a workspace and project, you then commit to doing things in CLI-friendly ways (unless you choose to eject it). @Brocco Is this a key concept we should try to capture in the definition or can people pop in and out of using the CLI effectively and safely?
3 and 4 are more descriptive. 4 has a marketing slant, so I prefer 3 here and 4 on marketing pages.
There was a problem hiding this comment.
I think adding "build" to the dev tasks is important
There was a problem hiding this comment.
Pondering: "add files and code to create generic versions of various elements based on [schematics]"
Are they always generic versions?
Maybe: "run schematics to modify existing projects (such as adding files or packages)"
Maybe: "modify existing projects by running schematics (which can add packages and files, change code, and perform any scriptable modification)"
Probably the ( ) in either of those examples can be dropped because you have a link to the schematics def.
There was a problem hiding this comment.
This isn't quite right. We don't really teach the CLI there. When we merge CLI docs into aio, we can refer readers to an intro page about CLI. For now, maybe this:
"To begin using the CLI for a new project, see [Getting Started]. To learn more about the full capabilities of the CLI, see the Angular CLI documentation."
There was a problem hiding this comment.
Missing word? "using the configured provider of the service or value"
There was a problem hiding this comment.
uses schematics to generate and modify Angular projects and parts of projects.
There was a problem hiding this comment.
Maybe mention that Angular provides certain schematics that are used by the CLI. Library owners can also create schematics that can be used by the CLI to add their libraries to Angular projects. xref the appropriate CLI doc on ng add as well as that schematics site?
There was a problem hiding this comment.
npm is always lowercase on their site, I think
There was a problem hiding this comment.
Okay, I see why you added "In Angular" to some of these. It's shorthand for "An Angular workspace" to differentiate from workspaces in other contexts.
There was a problem hiding this comment.
I think workspace is a development time construct only. The source for Angular apps and libraries are always contained in a workspace. During development, you work on Angular apps and libraries in the context of a workspace.
I don't think people create a workspace on its own. I think that it happens automatically when they do ng new to create a project and they happen to be outside an existing workspace? I'm just thinking of how we position new in the getting started. We don't create workspace and then create project.
364feae to
da13317
Compare
|
You can preview da13317 at https://pr24633-da13317.ngbuilds.io/. |
|
You can preview 5c05ae6 at https://pr24633-5c05ae6.ngbuilds.io/. |
|
@mhevery I have added some CLI terms and updated some DI terms - can you please check them? thanks. |
There was a problem hiding this comment.
i am wondering of contains is better word than represents? I am on the fence.
There was a problem hiding this comment.
creates I believe the technical term is instantiates
There was a problem hiding this comment.
JavaScript ID => JavasCript import symbol maybe? (certainly not ID.)
There was a problem hiding this comment.
can we reword to make this clearer. Given injector instance will always return the same instance of dependency. (ie Multiple instances can return multiple dependencies.)
There was a problem hiding this comment.
i don't think the word generic is adding value. Should it be removed?
There was a problem hiding this comment.
Maybe we replace "generic" with what we mean by that. empty library? new library folder with default files? new empty library folder? new library with default contents? (playing here)
There was a problem hiding this comment.
Using "..to generate scaffolding for a new library"
There was a problem hiding this comment.
+1 for removing In Angular as idon't think it adds value.
There was a problem hiding this comment.
projects? I think it should be singular. I thought that you can only have one project per workspace.
ffbfbb3 to
fb57569
Compare
|
You can preview fb57569 at https://pr24633-fb57569.ngbuilds.io/. |
|
You can preview bf53b27 at https://pr24633-bf53b27.ngbuilds.io/. |
|
@mhevery @jenniferfell This is all green, I think it is ready to approve. |
bf53b27 to
04cefaf
Compare
|
You can preview 04cefaf at https://pr24633-04cefaf.ngbuilds.io/. |
docs: fix typos in 'Httpclient' docs (angular#19127) PR Close angular#19127 docs(router): add `paramsInheritanceStrategy` documentation (angular#22590) PR Close angular#22590 docs: add app.module to changed documents (angular#23876) PR Close angular#23876 docs: clarify faqs about services (angular#24079) PR Close angular#24079 docs(aio): added a link to Angular Zero online course (Traditional Chinese) (angular#24228) PR Close angular#24228 docs: describe rounding behaviour of 'DecimalPipe' (angular#24303) PR Close angular#24303 docs(common): fix in the documentation of PUT (angular#24528) PR Close angular#24528 docs: add workspace and related cli terms (angular#24633) PR Close angular#24633 docs(changelog): correct inaccuracies (angular#24713) PR Close angular#24713 test: integration test for TS 2.9.x (angular#24749) PR Close angular#24749 fix(ivy): pipes are pure by default (angular#24750) PR Close angular#24750 build(bazel): update to rule_nodejs 0.10.0 (angular#24759) PR Close angular#24759 build: upgrade jasmine (and related typings) to latest version (angular#19904) With these changes, the types are a little stricter now and also not compatible with Protractor's jasmine-like syntax. So, we have to also use `@types/jasminewd2` for e2e tests (but not for non-e2e tests). I also had to "augment" `@types/jasminewd2`, because the latest typings from [DefinitelyTyped][1] do not reflect the fact that the `jasminewd2` version (v2.1.0) currently used by Protractor supports passing a `done` callback to a spec. [1]: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/566e0394859fdc1dc893658ccec6b06372d56a91/types/jasminewd2/index.d.ts#L9-L15 Fixes angular#23952 Closes angular#24733 PR Close angular#19904 test: make `NgMatchers` type-aware (angular#19904) PR Close angular#19904 refactor: infer type for `it()` assertion functions (angular#19904) PR Close angular#19904 build: upgrade jasmine to 2.99.x and fix tests (angular#19904) PR Close angular#19904 refactor: re-organize and "modernize" cjs-jasmine scripts (angular#19904) PR Close angular#19904 test: run unit tests in random order (angular#19904) PR Close angular#19904 build: upgrade jasmine to 3.1.0 (angular#19904) PR Close angular#19904 build: upgrade karma and related dependencies (angular#19904) PR Close angular#19904 docs: refactored ng-container code (angular#22742) PR Close angular#22742 docs: update Angular Boot Camp description (angular#23653) PR Close angular#23653 feat(service-worker): add support for `?` in SW config globbing (angular#24105) The globbing is used in the following sections: - `assetGroups` > `resources` > `files`/`versionedFiles` - `assetGroups` > `resources` > `urls` - `dataGroups` > `urls` - `navigationUrls` Query params are ignored for `files`/`versionedFiles` and `navigationUrls`, but they are still taken into account for `assetGroups`/`dataGroups` `urls`. To avoid a breaking change, `?` is matched literally for these patterns. PR Close angular#24105 refactor(service-worker): avoid unnecessary operations and remove unused code (angular#24127) PR Close angular#24127 fix(service-worker): avoid network requests when looking up hashed resources in cache (angular#24127) PR Close angular#24127 feat(ivy): properly apply style="", [style], [style.foo] and [attr.style] bindings (angular#24602) PR Close angular#24602 fix(language-service): do not overwrite native `Reflect` (angular#24299) Fixes angular#21420 PR Close angular#24299 fix(common): use correct currency format for locale de-AT (angular#24658) Fixes angular#24609 PR Close angular#24658 fix(ivy): correctly resolve Array property access (angular#24664) PR Close angular#24664 build: make `internal-angular` karma reporter compatible with latest karma (angular#24803) Due to changes in karma@1.0.0, `internal-angular` karma reporter stopped showing browser logs (such as `console.log()` etc.). Related to d571a51. PR Close angular#24803 build: remove unnecessary `internal-angular` karma reporter (angular#24803) The reporter was added in 87d56ac, with the purpose of fixing source-map paths (which was apparently needed back then). Things have moved around a lot since then and the custom reporter doesn't seem to be necessary any more. By removing the reporter, we have one less thing to worry about while upgrading karma; plus we get improvements in built-in reporters for free. Output with the custom reporter: ``` at someMethod (packages/core/.../some-file.ts:13:37) ``` Output with the built-in reporter: ``` at someMethod (packages/core/.../some-file.ts:13.37 <- dist/all/@angular/core/.../some-file.js:1:337) ``` PR Close angular#24803 fix(core): mark NgModule as not the root if APP_ROOT is set to false (angular#24814) Tree shakable providers use the APP_ROOT token to determine where to attach themselves. APP_ROOT gets set on NgModule with BrowserModule irrespective of whether it is actually the root(Ex. in case of SSR app where the shell app is first bootstrapped without BrowserModule being the root module). This change allows a NgModule with BrowserModule to explicitly mark itself as not the root by setting APP_ROOT token to false. This allows tree shakable providers to be attached to the right rott module. PR Close angular#24814 fix(platform-browser): mark Meta and Title services as tree shakable providers (angular#24815) This lets services that use Meta and Title services to be tree shakable and provided in root. PR Close angular#24815 docs(aio): unified console.log single string style (angular#22737) PR Close angular#22737 docs: unified console.log single string style (angular#22737) PR Close angular#22737 fix(compiler-cli): Use typescript to resolve modules for metadata (angular#22856) The current module resolution simply attaches .ts to the import/export path, which does not work if the path is using Node / CommonJS behavior to resolve to an index.ts file. This patch uses typescript's module resolution logic, and will attempt to load the original typescript file if this resolution returns a .js or .d.ts file PR Close angular#22856 docs: clarify wording in architecture overview (angular#24481) Closes angular#23463 Closes angular#22158 PR Close angular#24481 docs: add tree-shakable providers (angular#24481) PR Close angular#24481 fix(ivy): support projecting into dynamic views (angular#24752) PR Close angular#24752 refactor(ivy): replace pNextOrParent with TNode props (angular#24752) PR Close angular#24752 docs: fix typo in Universal guide (angular#24812) PR Close angular#24812 fix(platform-browser): workaround wrong import path generated by ngc for DOCUMENT (angular#24830) docs: correct project definition (angular#24807) PR Close angular#24807 build: update to latest nodejs bazel rules (angular#24817) PR Close angular#24817 fix(common): do not round factional seconds (angular#24831) fixes angular#24384 PR Close angular#24831 docs: fix typos referencing inline component styles (angular#22557) PR Close angular#22557 fix(router): add ability to recover from malformed url (angular#23283) Fixes angular#21468 PR Close angular#23283 docs: fix incorrect forms selector references (angular#22631) PR Close angular#22631 docs(aio): unified string chaining (angular#22735) PR Close angular#22735 docs: unified string chaining (angular#22735) PR Close angular#22735 docs(forms): added missing backtick (angular#24451) Fixed trivial markdown problem with a missing backtick. PR Close angular#24451 docs(forms): update API reference for form validators (angular#24734) PR Close angular#24734 Merge remote-tracking branch 'upstream/master' into refactor-example-pipe docs: refactor pipe example to use the HttpClient docs: refactor pipe example to use the HttpClient docs: refactor pipe example to use the HttpClient
docs: fix typos in 'Httpclient' docs (#19127) PR Close #19127 docs(router): add `paramsInheritanceStrategy` documentation (#22590) PR Close #22590 docs: add app.module to changed documents (#23876) PR Close #23876 docs: clarify faqs about services (#24079) PR Close #24079 docs(aio): added a link to Angular Zero online course (Traditional Chinese) (#24228) PR Close #24228 docs: describe rounding behaviour of 'DecimalPipe' (#24303) PR Close #24303 docs(common): fix in the documentation of PUT (#24528) PR Close #24528 docs: add workspace and related cli terms (#24633) PR Close #24633 docs(changelog): correct inaccuracies (#24713) PR Close #24713 test: integration test for TS 2.9.x (#24749) PR Close #24749 fix(ivy): pipes are pure by default (#24750) PR Close #24750 build(bazel): update to rule_nodejs 0.10.0 (#24759) PR Close #24759 build: upgrade jasmine (and related typings) to latest version (#19904) With these changes, the types are a little stricter now and also not compatible with Protractor's jasmine-like syntax. So, we have to also use `@types/jasminewd2` for e2e tests (but not for non-e2e tests). I also had to "augment" `@types/jasminewd2`, because the latest typings from [DefinitelyTyped][1] do not reflect the fact that the `jasminewd2` version (v2.1.0) currently used by Protractor supports passing a `done` callback to a spec. [1]: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/566e0394859fdc1dc893658ccec6b06372d56a91/types/jasminewd2/index.d.ts#L9-L15 Fixes #23952 Closes #24733 PR Close #19904 test: make `NgMatchers` type-aware (#19904) PR Close #19904 refactor: infer type for `it()` assertion functions (#19904) PR Close #19904 build: upgrade jasmine to 2.99.x and fix tests (#19904) PR Close #19904 refactor: re-organize and "modernize" cjs-jasmine scripts (#19904) PR Close #19904 test: run unit tests in random order (#19904) PR Close #19904 build: upgrade jasmine to 3.1.0 (#19904) PR Close #19904 build: upgrade karma and related dependencies (#19904) PR Close #19904 docs: refactored ng-container code (#22742) PR Close #22742 docs: update Angular Boot Camp description (#23653) PR Close #23653 feat(service-worker): add support for `?` in SW config globbing (#24105) The globbing is used in the following sections: - `assetGroups` > `resources` > `files`/`versionedFiles` - `assetGroups` > `resources` > `urls` - `dataGroups` > `urls` - `navigationUrls` Query params are ignored for `files`/`versionedFiles` and `navigationUrls`, but they are still taken into account for `assetGroups`/`dataGroups` `urls`. To avoid a breaking change, `?` is matched literally for these patterns. PR Close #24105 refactor(service-worker): avoid unnecessary operations and remove unused code (#24127) PR Close #24127 fix(service-worker): avoid network requests when looking up hashed resources in cache (#24127) PR Close #24127 feat(ivy): properly apply style="", [style], [style.foo] and [attr.style] bindings (#24602) PR Close #24602 fix(language-service): do not overwrite native `Reflect` (#24299) Fixes #21420 PR Close #24299 fix(common): use correct currency format for locale de-AT (#24658) Fixes #24609 PR Close #24658 fix(ivy): correctly resolve Array property access (#24664) PR Close #24664 build: make `internal-angular` karma reporter compatible with latest karma (#24803) Due to changes in karma@1.0.0, `internal-angular` karma reporter stopped showing browser logs (such as `console.log()` etc.). Related to d571a51. PR Close #24803 build: remove unnecessary `internal-angular` karma reporter (#24803) The reporter was added in 87d56ac, with the purpose of fixing source-map paths (which was apparently needed back then). Things have moved around a lot since then and the custom reporter doesn't seem to be necessary any more. By removing the reporter, we have one less thing to worry about while upgrading karma; plus we get improvements in built-in reporters for free. Output with the custom reporter: ``` at someMethod (packages/core/.../some-file.ts:13:37) ``` Output with the built-in reporter: ``` at someMethod (packages/core/.../some-file.ts:13.37 <- dist/all/@angular/core/.../some-file.js:1:337) ``` PR Close #24803 fix(core): mark NgModule as not the root if APP_ROOT is set to false (#24814) Tree shakable providers use the APP_ROOT token to determine where to attach themselves. APP_ROOT gets set on NgModule with BrowserModule irrespective of whether it is actually the root(Ex. in case of SSR app where the shell app is first bootstrapped without BrowserModule being the root module). This change allows a NgModule with BrowserModule to explicitly mark itself as not the root by setting APP_ROOT token to false. This allows tree shakable providers to be attached to the right rott module. PR Close #24814 fix(platform-browser): mark Meta and Title services as tree shakable providers (#24815) This lets services that use Meta and Title services to be tree shakable and provided in root. PR Close #24815 docs(aio): unified console.log single string style (#22737) PR Close #22737 docs: unified console.log single string style (#22737) PR Close #22737 fix(compiler-cli): Use typescript to resolve modules for metadata (#22856) The current module resolution simply attaches .ts to the import/export path, which does not work if the path is using Node / CommonJS behavior to resolve to an index.ts file. This patch uses typescript's module resolution logic, and will attempt to load the original typescript file if this resolution returns a .js or .d.ts file PR Close #22856 docs: clarify wording in architecture overview (#24481) Closes #23463 Closes #22158 PR Close #24481 docs: add tree-shakable providers (#24481) PR Close #24481 fix(ivy): support projecting into dynamic views (#24752) PR Close #24752 refactor(ivy): replace pNextOrParent with TNode props (#24752) PR Close #24752 docs: fix typo in Universal guide (#24812) PR Close #24812 fix(platform-browser): workaround wrong import path generated by ngc for DOCUMENT (#24830) docs: correct project definition (#24807) PR Close #24807 build: update to latest nodejs bazel rules (#24817) PR Close #24817 fix(common): do not round factional seconds (#24831) fixes #24384 PR Close #24831 docs: fix typos referencing inline component styles (#22557) PR Close #22557 fix(router): add ability to recover from malformed url (#23283) Fixes #21468 PR Close #23283 docs: fix incorrect forms selector references (#22631) PR Close #22631 docs(aio): unified string chaining (#22735) PR Close #22735 docs: unified string chaining (#22735) PR Close #22735 docs(forms): added missing backtick (#24451) Fixed trivial markdown problem with a missing backtick. PR Close #24451 docs(forms): update API reference for form validators (#24734) PR Close #24734 Merge remote-tracking branch 'upstream/master' into refactor-example-pipe docs: refactor pipe example to use the HttpClient docs: refactor pipe example to use the HttpClient docs: refactor pipe example to use the HttpClient PR Close #22741
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information