docs: add documentation of NgZone with zone.js #34295

JiaLiPassion · 2019-12-07T14:32:16Z

PR Checklist

Please check if your PR fulfills the following requirements:

The commit message follows our guidelines: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
Tests for the changes have been added (for bug fixes / features)
Docs have been added / updated (for bug fixes / features)

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?

Add the documentation about NgZone and the relationship with zone.js, and some configuration of noop zone and zone flags.

ajitsinghkaler · 2019-12-07T14:38:43Z

@JiaLiPassion this can also be the first draft for the official change detection documentation as aked in #33731. So, I think we can close that issue also with this pr.

JiaLiPassion · 2019-12-07T14:46:51Z

@ajitsinghkaler , thanks, and I will check the issue, this document is not talking about Change Detection itself, but when to trigger change detection, but yeah they are related.

mary-poppins · 2019-12-07T16:28:36Z

You can preview cae3494 at https://pr34295-cae3494.ngbuilds.io/.
You can preview e82514f at https://pr34295-e82514f.ngbuilds.io/.
You can preview 610cdd2 at https://pr34295-610cdd2.ngbuilds.io/.

aikithoughts

I know there's a lot here, and I apologize. I mostly focused on making the document as easy to read as possible. I'm happy to discuss these changes (or any other thoughts) at any time! Please let me know how I can help.

aio/content/guide/zone.md

aikithoughts · 2019-12-09T22:51:43Z

aio/content/guide/zone.md

+
+### NoopZone
+
+`Zone` will help Angular to know when to trigger Change Detection and let the developers focus on the application development, by default, `Zone` will be loaded and everything works out of the box. But you don't have to use `Zone` to make Angular work, you can still trigger Change Detection all by yourself. To remove `zone.js`, you need to do the following steps, **ALERT! if you do this, you need to understand what you are doing clearly, and you need to trigger all the change detection at the correct timing yourself**.


I wonder if this is appropriate here? it seems like we're encouraging developers to do something that may cause problems later. Maybe this should go in a separate topic?

Yeah, I am not sure about this, so the noop zone is already been official supported for a while, so the reason I put it here is it is also about Zone, so the user may have a full picture.
And of course we can also put it into a sub chapter.

We need documentation for no-zone, but that is outside the scope of these docs.

Got it, I will create another PR to add no-zone.

JiaLiPassion · 2019-12-10T06:09:22Z

@aikidave , Thank you so much for the detailed review, I will update the doc and let you know. Thanks again and I learned a lot.

mary-poppins · 2019-12-11T15:39:35Z

You can preview ef80a30 at https://pr34295-ef80a30.ngbuilds.io/.

JiaLiPassion · 2019-12-11T19:48:05Z

@aikidave, I have updated the doc and reply what I changed in the comments, please review, thank you!

aikithoughts

I have some additional questions about how the Angular community talks about certain ideas and concepts, but nothing that should stop this from moving forward. Thanks for incorporating my suggestions!

aio/content/guide/zone.md

JiaLiPassion · 2019-12-12T12:39:26Z

@aikidave , thanks for the review again, I updated the docs based on your comments.

mary-poppins · 2019-12-12T12:47:33Z

You can preview 644e54e at https://pr34295-644e54e.ngbuilds.io/.

googlebot · 2020-01-31T21:11:33Z

All (the pull request submitter and all commit authors) CLAs are signed, but 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 by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

mary-poppins · 2020-01-31T21:20:44Z

You can preview c26307d at https://pr34295-c26307d.ngbuilds.io/.

JiaLiPassion · 2020-02-01T04:12:09Z

@kapunahelewong, thank you very much for the review and the update!

googlebot · 2020-02-06T04:07:25Z

CLAs look good, thanks!

ℹ️ Googlers: Go here for more info.

mary-poppins · 2020-02-06T04:15:37Z

You can preview eb34fd6 at https://pr34295-eb34fd6.ngbuilds.io/.

mhevery

Approving with a single nit so adding needs_cleanup label. Once you fix the issue please remove the label.

aio/content/guide/zone.md

mary-poppins · 2020-02-24T19:56:20Z

You can preview fa479ae at https://pr34295-fa479ae.ngbuilds.io/.

PR Close #34295

angular-automatic-lock-bot · 2020-03-28T16:06:47Z

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.}

JiaLiPassion requested review from IgorMinar and a team as code owners December 7, 2019 14:32

googlebot added the cla: yes label Dec 7, 2019

JiaLiPassion force-pushed the zone-doc branch from 876d103 to cae3494 Compare December 7, 2019 14:45

JiaLiPassion force-pushed the zone-doc branch from cae3494 to e82514f Compare December 7, 2019 14:56

JiaLiPassion added comp: docs area: zones labels Dec 7, 2019

ngbot bot modified the milestone: needsTriage Dec 7, 2019

petebacondarwin added the aio: preview label Dec 7, 2019

kapunahelewong added effort3: weeks risk: low feature Issue that requests a new feature labels Dec 9, 2019

ngbot bot modified the milestones: needsTriage, Backlog Dec 9, 2019

kapunahelewong added this to In Review in docs Dec 9, 2019

aikithoughts reviewed Dec 9, 2019

View reviewed changes

ajitsinghkaler mentioned this pull request Dec 10, 2019

docs: add change detection docs to angular.io #34299

Closed

14 tasks

aikithoughts approved these changes Dec 11, 2019

View reviewed changes

JiaLiPassion added the target: patch This PR is targeted for the next patch release label Jan 30, 2020

googlebot added cla: no and removed cla: yes labels Jan 31, 2020

kapunahelewong approved these changes Feb 4, 2020

View reviewed changes

JiaLiPassion force-pushed the zone-doc branch from c26307d to eb34fd6 Compare February 6, 2020 04:07

googlebot added cla: yes and removed cla: no labels Feb 6, 2020

kapunahelewong added the action: review The PR is still awaiting reviews from at least one requested reviewer label Feb 17, 2020

mhevery approved these changes Feb 24, 2020

View reviewed changes

aio/content/guide/zone.md Outdated Show resolved Hide resolved

mhevery added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Feb 24, 2020

mhevery removed request for a team, IgorMinar and aikithoughts February 24, 2020 17:31

JiaLiPassion force-pushed the zone-doc branch from eb34fd6 to 4eca456 Compare February 24, 2020 19:32

JiaLiPassion removed the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Feb 24, 2020

docs: add documentation of NgZone with zone.js

fa479ae

JiaLiPassion force-pushed the zone-doc branch from 4eca456 to fa479ae Compare February 24, 2020 19:46

mhevery added the action: merge The PR is ready for merge by the caretaker label Feb 26, 2020

mhevery closed this in bde4cd7 Feb 26, 2020

mhevery pushed a commit that referenced this pull request Feb 26, 2020

docs: add documentation of NgZone with zone.js (#34295)

1a4456d

PR Close #34295

jbogarthyde moved this from In Review to Done in docs Mar 2, 2020

angular-automatic-lock-bot bot locked and limited conversation to collaborators Mar 28, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add documentation of NgZone with zone.js #34295

docs: add documentation of NgZone with zone.js #34295

JiaLiPassion commented Dec 7, 2019

ajitsinghkaler commented Dec 7, 2019

JiaLiPassion commented Dec 7, 2019

mary-poppins commented Dec 7, 2019

aikithoughts left a comment

aikithoughts Dec 9, 2019

JiaLiPassion Dec 10, 2019

mhevery Jan 29, 2020

JiaLiPassion Jan 30, 2020

JiaLiPassion commented Dec 10, 2019

mary-poppins commented Dec 11, 2019

JiaLiPassion commented Dec 11, 2019

aikithoughts left a comment

JiaLiPassion commented Dec 12, 2019

mary-poppins commented Dec 12, 2019

googlebot commented Jan 31, 2020

mary-poppins commented Jan 31, 2020

JiaLiPassion commented Feb 1, 2020

googlebot commented Feb 6, 2020

mary-poppins commented Feb 6, 2020

mhevery left a comment

mary-poppins commented Feb 24, 2020

angular-automatic-lock-bot bot commented Mar 28, 2020


		### NoopZone

		`Zone` will help Angular to know when to trigger Change Detection and let the developers focus on the application development, by default, `Zone` will be loaded and everything works out of the box. But you don't have to use `Zone` to make Angular work, you can still trigger Change Detection all by yourself. To remove `zone.js`, you need to do the following steps, ALERT! if you do this, you need to understand what you are doing clearly, and you need to trigger all the change detection at the correct timing yourself.

docs: add documentation of NgZone with zone.js #34295

docs: add documentation of NgZone with zone.js #34295

Conversation

JiaLiPassion commented Dec 7, 2019

PR Checklist

PR Type

What is the new behavior?

ajitsinghkaler commented Dec 7, 2019

JiaLiPassion commented Dec 7, 2019

mary-poppins commented Dec 7, 2019

aikithoughts left a comment

Choose a reason for hiding this comment

aikithoughts Dec 9, 2019

Choose a reason for hiding this comment

JiaLiPassion Dec 10, 2019

Choose a reason for hiding this comment

mhevery Jan 29, 2020

Choose a reason for hiding this comment

JiaLiPassion Jan 30, 2020

Choose a reason for hiding this comment

JiaLiPassion commented Dec 10, 2019

mary-poppins commented Dec 11, 2019

JiaLiPassion commented Dec 11, 2019

aikithoughts left a comment

Choose a reason for hiding this comment

JiaLiPassion commented Dec 12, 2019

mary-poppins commented Dec 12, 2019

googlebot commented Jan 31, 2020

mary-poppins commented Jan 31, 2020

JiaLiPassion commented Feb 1, 2020

googlebot commented Feb 6, 2020

mary-poppins commented Feb 6, 2020

mhevery left a comment

Choose a reason for hiding this comment

mary-poppins commented Feb 24, 2020

angular-automatic-lock-bot bot commented Mar 28, 2020