-
Notifications
You must be signed in to change notification settings - Fork 24.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add ivy opt-in docs #28569
docs: add ivy opt-in docs #28569
Conversation
aio/content/cli/ivy.md
Outdated
@@ -0,0 +1,68 @@ | |||
# Using Ivy with Angular CLI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the best place to add this page in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure. @jenniferfell can you please propose some place?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doc should be placed in the aio/content/guide
directory. I think it would be good also to rename the doc to something like ivy-preview
if this is going to be temporary.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Renamed and added under the Techniques
section of navigation as Ivy Preview
. @StephenFluin @jenniferfell can you confirm this location is the appropriate one?
You can preview 0982573 at https://pr28569-0982573.ngbuilds.io/. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great start!
Let's wait for the blog post to land and experimentalIvy boolean flag to land and then merge this PR
aio/content/cli/ivy.md
Outdated
@@ -0,0 +1,68 @@ | |||
# Using Ivy with Angular CLI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure. @jenniferfell can you please propose some place?
Blocked on #28616. |
0982573
to
58af057
Compare
You can preview 58af057 at https://pr28569-58af057.ngbuilds.io/. |
aio/content/cli/ivy.md
Outdated
|
||
Using a postinstall hook to run `ngcc` is just a temporary integration. | ||
We expect `ngcc` to be seamlessly integrated into the Angular CLI build pipeline in the future before the full Ivy rollout. | ||
Once that's implemented `ngcc` will and not be visible to developers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@filipesilva, this is really good!
Should we mentioned the limitation that if one has multiple projects within the workspace, all of them will need to be build using Ivy? As users will have cryptic error messages on projects that rely on ngc
but ngcc
was run.
At least until ngcc
is around and not part of the build pipeline.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added a note about that:
Until that happens, opting into Ivy means that all projects in a single CLI workspace will be compiled with Ivy.
58af057
to
a743c6d
Compare
@jenniferfell can you review and advise on where the best place to link this page in is please? |
You can preview a743c6d at https://pr28569-a743c6d.ngbuilds.io/. |
aio/content/cli/ivy.md
Outdated
{ | ||
"compilerOptions": { ... }, | ||
"angularCompilerOptions": { | ||
"enableIvy": true, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't "allowEmptyCodegenFiles": true
required any more?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it is still required right now. But #28685 (or a similar approach) will make it not needed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added it here for now, to remove later when the other PR is in.
a743c6d
to
e6b7e28
Compare
CLAs look good, thanks! ℹ️ Googlers: Go here for more info. |
You can preview 6a57d06 at https://pr28569-6a57d06.ngbuilds.io/. |
You can preview 7cdd898 at https://pr28569-7cdd898.ngbuilds.io/. |
You can preview 16b9b39 at https://pr28569-16b9b39.ngbuilds.io/. |
You can preview 3a91668 at https://pr28569-3a91668.ngbuilds.io/. |
3a91668
to
e6211d6
Compare
You can preview e6211d6 at https://pr28569-e6211d6.ngbuilds.io/. |
To summarize, this PR is ready to merge but there are still open action items that should be addressed and whose changes are to be fed back into this document:
|
aio/content/guide/ivy.md
Outdated
|
||
Using a postinstall hook to run `ngcc` is just a temporary integration. | ||
We expect `ngcc` to be seamlessly integrated into the Angular CLI build pipeline in the future before the full Ivy rollout. | ||
Once that's implemented `ngcc` will and not be visible to developers. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove 'and' from this sentence?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey thanks for taking a look! Yes that shouldn't be there, removed now.
e6211d6
to
c030eeb
Compare
You can preview c030eeb at https://pr28569-c030eeb.ngbuilds.io/. |
aio/content/navigation.json
Outdated
{ | ||
"url": "guide/ivy", | ||
"title": "Angular Ivy", | ||
"tooltip": "Opt-ing into Angular Ivy with Angular CLI." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Opting is a word - no hyphen needed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed mentions of opt-ing
to opting
but left mentions of opt-in
as is.
c030eeb
to
a907c80
Compare
You can preview a907c80 at https://pr28569-a907c80.ngbuilds.io/. |
Followup to angular#28569 (comment) and angular/angular-cli#13773. Note: this flag will only work on `@angular/cli@8.0.0-beta.3` (currently unreleased) and above.
Followup to angular#28569 (comment) and angular/angular-cli#13773. Note: this flag will only work on `@angular/cli@8.0.0-beta.3` (currently unreleased) and above.
Followup to #28569 (comment) and angular/angular-cli#13773. Note: this flag will only work on `@angular/cli@8.0.0-beta.3` (currently unreleased) and above. PR Close #29010
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 new behavior?
Adds a Ivy opt-in instructions.
Does this PR introduce a breaking change?
Other information