Skip to content

docs: refactor routing doc#35566

Closed
kapunahelewong wants to merge 1 commit intoangular:masterfrom
kapunahelewong:router-refactor
Closed

docs: refactor routing doc#35566
kapunahelewong wants to merge 1 commit intoangular:masterfrom
kapunahelewong:router-refactor

Conversation

@kapunahelewong
Copy link
Copy Markdown
Contributor

@kapunahelewong kapunahelewong commented Feb 19, 2020

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

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@pullapprove pullapprove Bot requested a review from atscott February 19, 2020 22:45
@ngbot ngbot Bot modified the milestone: Backlog Feb 19, 2020
@kapunahelewong kapunahelewong changed the title docs: refactor routing doc [WIP]docs: refactor routing doc Feb 19, 2020
@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Feb 19, 2020

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

@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Feb 20, 2020

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

@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Feb 27, 2020

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

@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Feb 28, 2020

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

@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Mar 5, 2020

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

@kapunahelewong kapunahelewong changed the title [WIP]docs: refactor routing doc docs: refactor routing doc Mar 5, 2020
@pullapprove pullapprove Bot requested a review from kara March 5, 2020 18:53
@aikithoughts aikithoughts mentioned this pull request Mar 10, 2020
Closed
14 tasks
@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Mar 10, 2020

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

atscott
atscott requested changes Mar 27, 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
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
Comment thread aio/content/guide/router.md Outdated
Comment thread aio/content/guide/router.md Outdated
@kapunahelewong 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
gkalpak approved these changes Apr 13, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@gkalpak gkalpak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ✨

Comment thread packages/router/src/events.ts Outdated
Comment thread aio/content/examples/router/src/app/auth/auth.guard.3.ts Outdated
Comment thread aio/content/examples/router/src/app/auth/auth.guard.2.ts Outdated
Comment thread aio/content/examples/router/src/app/app.component.8.html Outdated
Comment thread aio/content/examples/router/src/app/app.component.4.ts Outdated
Comment thread aio/content/examples/router/src/app/app.component.4.ts Outdated
Comment thread aio/content/examples/router/src/app/app.component.4.ts Outdated
Comment thread aio/content/examples/router/src/app/app.component.1.ts Outdated
Comment thread aio/content/examples/router/src/app/app-routing.module.7.ts Outdated
Comment thread aio/content/guide/router.md Outdated
Copy link
Copy Markdown
Member

@gkalpak gkalpak Apr 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor Author

@kapunahelewong kapunahelewong Apr 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

@rockument69 rockument69 Apr 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@gkalpak 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
@kapunahelewong kapunahelewong 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: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews state: needs doc team review labels Apr 13, 2020
@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Apr 14, 2020

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

@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Apr 14, 2020

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

@petebacondarwin petebacondarwin removed their request for review April 14, 2020 20:41
@kapunahelewong kapunahelewong removed the request for review from clydin April 14, 2020 21:58
@pullapprove pullapprove Bot requested a review from clydin April 14, 2020 21:58
@kara kara removed their request for review April 14, 2020 22:19
@pullapprove pullapprove Bot requested a review from kara April 14, 2020 22:19
@kapunahelewong 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
@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Apr 15, 2020

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

kara
kara approved these changes Apr 15, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@kara kara left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still LGTM for the browser-support page

@kapunahelewong kapunahelewong added the action: merge The PR is ready for merge by the caretaker label Apr 15, 2020
@kapunahelewong
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).
@mary-poppins
Copy link
Copy Markdown

mary-poppins commented Apr 16, 2020

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

@atscott atscott closed this in 305b059 Apr 16, 2020
atscott pushed a commit that referenced this pull request Apr 16, 2020
@kapunahelewong @atscott
docs: refactor routing doc (#35566)
1e4fb74 
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
Copy link
Copy Markdown

angular-automatic-lock-bot Bot commented May 24, 2020

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 May 24, 2020
@kapunahelewong kapunahelewong deleted the router-refactor branch May 26, 2020 15:19
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@atscott atscott atscott approved these changes

@clydin clydin clydin approved these changes

+4 more reviewers

@gkalpak gkalpak gkalpak approved these changes

@rockument69 rockument69 rockument69 left review comments

@kara kara kara approved these changes

@aikithoughts aikithoughts aikithoughts approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@kapunahelewong kapunahelewong

Labels

action: merge The PR is ready for merge by the caretaker cla: yes effort3: weeks risk: medium target: patch This PR is targeted for the next patch release type: bug/fix

Projects

None yet

Milestone

Backlog

Development

Successfully merging this pull request may close these issues.

9 participants

@kapunahelewong @mary-poppins @atscott @kara @gkalpak @clydin @aikithoughts @rockument69 @googlebot