docs: refactor routing doc by kapunahelewong · Pull Request #35566 · angular/angular

kapunahelewong · 2020-02-19T22:45:03Z

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 current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

Yes
No

Other information

mary-poppins · 2020-02-19T22:58:17Z

You can preview 361cbd0 at https://pr35566-361cbd0.ngbuilds.io/.

mary-poppins · 2020-02-20T19:35:50Z

You can preview a545f6b at https://pr35566-a545f6b.ngbuilds.io/.

mary-poppins · 2020-02-27T21:51:41Z

You can preview 8e1340d at https://pr35566-8e1340d.ngbuilds.io/.

mary-poppins · 2020-02-28T19:24:02Z

You can preview c844c1a at https://pr35566-c844c1a.ngbuilds.io/.

mary-poppins · 2020-03-05T18:47:11Z

You can preview cc3f85f at https://pr35566-cc3f85f.ngbuilds.io/.

mary-poppins · 2020-03-10T20:38:52Z

You can preview bd4fd20 at https://pr35566-bd4fd20.ngbuilds.io/.

atscott

Approved from technical standpoint. I can re-review if there are changes requested from Dave.

mary-poppins · 2020-04-01T19:13:28Z

You can preview a47d9c1 at https://pr35566-a47d9c1.ngbuilds.io/.

aikithoughts

I am about halfway through my review, but thought I'd send you these comments to get started.

mary-poppins · 2020-04-06T16:56:49Z

You can preview 4e89666 at https://pr35566-4e89666.ngbuilds.io/.

aikithoughts

One last change. I think this is enough for this PR. Next steps, however, include:

Refining the section on accessing query parameters to be as straightforward/minimal as possible.
Move the content on lazy loading and preloading into the Lazy Loading topic.
Move the tutorial to a new top-level section, Tutorials, in the guide.

atscott

Reviewed-for: fw-router

LGTM with a few additional nits

mary-poppins · 2020-04-09T22:13:17Z

You can preview 897f521 at https://pr35566-897f521.ngbuilds.io/.

mary-poppins · 2020-04-13T15:02:16Z

You can preview faeb1e5 at https://pr35566-faeb1e5.ngbuilds.io/.

mary-poppins · 2020-04-13T16:07:16Z

You can preview 4639966 at https://pr35566-4639966.ngbuilds.io/.

gkalpak

Thx for reducing the hard-coded code snippets, @kapunahelewong.
I've left some minor comments (and a couple of suggestions for future PRs) - otherwise lgtm ✨

gkalpak · 2020-04-13T17:24:50Z

This could be extracted into a separate docs (a router glossary).
_{Not necessary on this PR.}

Agreed and it will be moved into the glossary in a follow up PR. Thanks!!

@kapunahelewong : I don't think these are glossary-style terms. They are in code font and should probably link to APIs, such as RouterModule. I could see possibly updating the existing Glossary entry to include more terminology.

mary-poppins · 2020-04-14T19:25:43Z

You can preview 1a04e38 at https://pr35566-1a04e38.ngbuilds.io/.

mary-poppins · 2020-04-14T20:27:30Z

You can preview 484e9f9 at https://pr35566-484e9f9.ngbuilds.io/.

mary-poppins · 2020-04-15T13:46:39Z

You can preview ec661b5 at https://pr35566-ec661b5.ngbuilds.io/.

kara

Still LGTM for the browser-support page

This rewrite changes headings to focus on user tasks rather than features, verifies that content is up-to-date and complete, removes colloquial phrases, adds prerequisites, and expands on a task-based section in the beginning (a quick reference).

mary-poppins · 2020-04-16T17:12:53Z

You can preview 745d624 at https://pr35566-745d624.ngbuilds.io/.

This rewrite changes headings to focus on user tasks rather than features, verifies that content is up-to-date and complete, removes colloquial phrases, adds prerequisites, and expands on a task-based section in the beginning (a quick reference). PR Close #35566

angular-automatic-lock-bot · 2020-05-24T16:12:40Z

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

googlebot added the cla: yes label Feb 19, 2020

pullapprove Bot requested a review from atscott February 19, 2020 22:45

kapunahelewong added comp: docs effort3: weeks risk: medium type: bug/fix labels Feb 19, 2020

ngbot Bot modified the milestone: Backlog Feb 19, 2020

kapunahelewong changed the title ~~docs: refactor routing doc~~ [WIP]docs: refactor routing doc Feb 19, 2020

kapunahelewong added the aio: preview label Feb 19, 2020

kapunahelewong changed the title ~~[WIP]docs: refactor routing doc~~ docs: refactor routing doc Mar 5, 2020

pullapprove Bot requested a review from kara March 5, 2020 18:53

kapunahelewong requested a review from aikithoughts March 10, 2020 18:42

aikithoughts mentioned this pull request Mar 10, 2020

Rework nav to improve startup experience #35533

Closed

4 of 14 tasks

aikithoughts added the state: needs doc team review label Mar 27, 2020

atscott requested changes Mar 27, 2020

View reviewed changes

atscott reviewed Mar 31, 2020

View reviewed changes

aikithoughts reviewed Apr 2, 2020

View reviewed changes

aikithoughts approved these changes Apr 6, 2020

View reviewed changes

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

atscott approved these changes Apr 6, 2020

View reviewed changes

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

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

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

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

gkalpak suggested changes Apr 9, 2020

View reviewed changes

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

kapunahelewong added target: patch This PR is targeted for the next patch release and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Apr 13, 2020

gkalpak approved these changes Apr 13, 2020

View reviewed changes

gkalpak added the action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews label Apr 13, 2020

petebacondarwin removed their request for review April 14, 2020 20:41

kapunahelewong removed the request for review from clydin April 14, 2020 21:58

pullapprove Bot requested a review from clydin April 14, 2020 21:58

clydin approved these changes Apr 14, 2020

View reviewed changes

kara removed their request for review April 14, 2020 22:19

pullapprove Bot requested a review from kara April 14, 2020 22:19

kapunahelewong 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 Apr 15, 2020

kara approved these changes Apr 15, 2020

View reviewed changes

kapunahelewong added the action: merge The PR is ready for merge by the caretaker label Apr 15, 2020

docs: refactor routing doc

745d624

This rewrite changes headings to focus on user tasks rather than features, verifies that content is up-to-date and complete, removes colloquial phrases, adds prerequisites, and expands on a task-based section in the beginning (a quick reference).

atscott closed this in 305b059 Apr 16, 2020

angular-automatic-lock-bot Bot locked and limited conversation to collaborators May 24, 2020

kapunahelewong deleted the router-refactor branch May 26, 2020 15:19

Conversation

kapunahelewong commented Feb 19, 2020

PR Checklist

PR Type

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change?

Other information

Uh oh!

mary-poppins commented Feb 19, 2020

Uh oh!

mary-poppins commented Feb 20, 2020

Uh oh!

mary-poppins commented Feb 27, 2020

Uh oh!

mary-poppins commented Feb 28, 2020

Uh oh!

mary-poppins commented Mar 5, 2020

Uh oh!

mary-poppins commented Mar 10, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

atscott left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mary-poppins commented Apr 1, 2020

Uh oh!

aikithoughts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mary-poppins commented Apr 6, 2020

Uh oh!

aikithoughts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

atscott left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mary-poppins commented Apr 9, 2020

Uh oh!

mary-poppins commented Apr 13, 2020

Uh oh!

mary-poppins commented Apr 13, 2020

Uh oh!

gkalpak left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!