Skip to content

docs: add ivy opt-in docs - #28569

Closed
filipesilva wants to merge 1 commit into
angular:masterfrom
filipesilva:docs-ivy-optin
Closed

filipesilva wants to merge 1 commit into
angular:masterfrom
filipesilva:docs-ivy-optin

Conversation

@filipesilva

Copy link
Copy Markdown
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • angular.io application / infrastructure changes
  • Other... Please describe:

What is the new behavior?

Adds a Ivy opt-in instructions.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Comment thread aio/content/cli/ivy.md Outdated

Copy link
Copy Markdown
Contributor Author

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?

Copy link
Copy Markdown
Contributor

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?

Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Contributor Author

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?

Comment thread aio/content/cli/ivy.md Resolved
Comment thread aio/content/cli/ivy.md Resolved
@mary-poppins

Copy link
Copy Markdown

You can preview 0982573 at https://pr28569-0982573.ngbuilds.io/.

Comment thread aio/content/cli/ivy.md Resolved

@IgorMinar IgorMinar left a comment

Copy link
Copy Markdown
Contributor

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

Comment thread aio/content/cli/ivy.md Outdated

Copy link
Copy Markdown
Contributor

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?

Comment thread aio/content/cli/ivy.md Resolved
Comment thread aio/content/cli/ivy.md Resolved
Comment thread aio/content/cli/ivy.md Resolved
Comment thread aio/content/cli/ivy.md Resolved
@IgorMinar IgorMinar added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews state: blocked labels Feb 8, 2019
@filipesilva

Copy link
Copy Markdown
Contributor Author

Blocked on #28616.

@ngbot ngbot Bot added this to the needsTriage milestone Feb 8, 2019
@alexeagle alexeagle added the target: major This PR is targeted for the next major release label Feb 12, 2019
@mary-poppins

Copy link
Copy Markdown

You can preview 58af057 at https://pr28569-58af057.ngbuilds.io/.

Comment thread aio/content/cli/ivy.md Outdated

@alan-agius4 alan-agius4 Feb 14, 2019 •

Copy link
Copy Markdown
Contributor

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.

Copy link
Copy Markdown
Contributor Author

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.

@filipesilva

Copy link
Copy Markdown
Contributor Author

@jenniferfell can you review and advise on where the best place to link this page in is please?

@filipesilva filipesilva added action: review The PR is still awaiting reviews from at least one requested reviewer and removed state: blocked state: WIP action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Feb 20, 2019
@mary-poppins

Copy link
Copy Markdown

You can preview a743c6d at https://pr28569-a743c6d.ngbuilds.io/.

Comment thread aio/content/cli/ivy.md Outdated

Copy link
Copy Markdown
Member

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?

Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Contributor Author

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.

@mary-poppins

Copy link
Copy Markdown

You can preview e6b7e28 at https://pr28569-e6b7e28.ngbuilds.io/.

@googlebot

Copy link
Copy Markdown

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored or co-authored by someone other than the pull request submitter. We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of all the commit author(s), set the cla label to yes (if enabled on your project), and then merge this pull request when appropriate.

ℹ️ Googlers: Go here for more info.

@mary-poppins

Copy link
Copy Markdown

You can preview 85158bb at https://pr28569-85158bb.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview baa0444 at https://pr28569-baa0444.ngbuilds.io/.

@googlebot

Copy link
Copy Markdown

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

@mary-poppins

Copy link
Copy Markdown

You can preview 6a57d06 at https://pr28569-6a57d06.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview 7cdd898 at https://pr28569-7cdd898.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview 16b9b39 at https://pr28569-16b9b39.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview 3a91668 at https://pr28569-3a91668.ngbuilds.io/.

@mary-poppins

Copy link
Copy Markdown

You can preview e6211d6 at https://pr28569-e6211d6.ngbuilds.io/.

@filipesilva filipesilva removed action: review The PR is still awaiting reviews from at least one requested reviewer action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Feb 26, 2019
@filipesilva

filipesilva commented Feb 26, 2019 •

Copy link
Copy Markdown
Contributor Author

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:

Comment thread aio/content/guide/ivy.md Outdated

Copy link
Copy Markdown

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?

Copy link
Copy Markdown
Contributor Author

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.

@mary-poppins

Copy link
Copy Markdown

You can preview c030eeb at https://pr28569-c030eeb.ngbuilds.io/.

Comment thread aio/content/navigation.json Outdated

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor Author

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.

@mary-poppins

Copy link
Copy Markdown

You can preview a907c80 at https://pr28569-a907c80.ngbuilds.io/.

@benlesh benlesh closed this in f01247f Feb 26, 2019
mgechev pushed a commit to angular/angular-cli that referenced this pull request Feb 26, 2019
@filipesilva filipesilva mentioned this pull request Feb 27, 2019
3 of 14 tasks
@filipesilva
filipesilva deleted the docs-ivy-optin branch February 28, 2019 10:07
AndrewKushnir pushed a commit that referenced this pull request Mar 6, 2019
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
@angular-automatic-lock-bot

Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Sep 14, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

action: merge The PR is ready for merge by the caretaker cla: yes target: major This PR is targeted for the next major release

Projects

None yet

Development

Successfully merging this pull request may close these issues.