Skip to content

refactor(compiler-cli): update template typechecking link to latest angular.io version#44649

Closed
dgp1130 wants to merge 1 commit intoangular:masterfrom
dgp1130:v9-doc
Closed

refactor(compiler-cli): update template typechecking link to latest angular.io version#44649
dgp1130 wants to merge 1 commit intoangular:masterfrom
dgp1130:v9-doc

Conversation

@dgp1130
Copy link
Copy Markdown
Contributor

@dgp1130 dgp1130 commented Jan 6, 2022

This page exists in the most recent angular.io version (v13 currently), so there's no need to link to an old version. The hash also refers to the title section of the page, which isn't necessary and is now dropped.

This was originally added in #34887, and doesn't appear to actually require the v9 version, so I don't see any reason not to update the link.

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Refactoring (no functional changes, no api changes)

What is the current behavior?

Error message links to old v9 documentation.

What is the new behavior?

Error message now links to the most current documentation.

Does this PR introduce a breaking change?

  • No

Other information

Identified in #44391 (comment), but pulled into its own PR to be more obvious about the change.

…ngular.io version

This page exists in the most recent angular.io version (v13 currently), so there's no need to link to an old version. The hash also refers to the title section of the page, which isn't necessary and is now dropped.
@dgp1130 dgp1130 added target: patch This PR is targeted for the next patch release area: compiler Issues related to `ngc`, Angular's template compiler labels Jan 6, 2022
@dgp1130 dgp1130 requested a review from jessicajaniuk January 6, 2022 19:19
@ngbot ngbot bot modified the milestone: Backlog Jan 6, 2022
@pullapprove pullapprove bot requested a review from JoostK January 6, 2022 19:20
Copy link
Copy Markdown
Contributor

@jessicajaniuk jessicajaniuk left a comment

Choose a reason for hiding this comment

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

LGTM 🍪

Copy link
Copy Markdown
Member

@JoostK JoostK left a comment

Choose a reason for hiding this comment

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

FYI, I added this in #34195 (it was only moved in #34887) and I think the reason back then was that it required the v9 page, as the v8 docs did not have these flags.

One caveat with dropping the version is that the link is more likely to break in the future, where old versions of Angular would continue to link to a page that would no longer exist. But the same is true for

export const ERROR_DETAILS_PAGE_BASE_URL = 'https://angular.io/errors';

and I don't think it's a big problem.

@dgp1130
Copy link
Copy Markdown
Contributor Author

dgp1130 commented Jan 6, 2022

@JoostK, I figured this might have originally been to "link into the future", though it seems like the PR landed after v9 (maybe it was drafted before that?).

the proper solution would probably be to tie AIO links in error message to the version of Angular that the user is currently running. We could certainly do that, though it's a bit more effort than this one change. I made #44650 to follow up with a proper solution for error messages.

@dgp1130 dgp1130 added the action: merge The PR is ready for merge by the caretaker label Jan 6, 2022
@JoostK
Copy link
Copy Markdown
Member

JoostK commented Jan 6, 2022

I figured this might have originally been to "link into the future", though it seems like the PR landed after v9 (maybe it was drafted before that?).

It landed a bit before the v9 release; commit 2e82357 is from Jan 2020 whereas v9 was released in Feb 2020. I remember specifically because this was one of the last things on the list of releasing Ivy as stable 🙂

And yeah, capturing this in a separate issue makes sense, thanks for creating it.

@atscott
Copy link
Copy Markdown
Contributor

atscott commented Jan 7, 2022

This PR was merged into the repository by commit de93b6e.

@atscott atscott closed this in de93b6e Jan 7, 2022
atscott pushed a commit that referenced this pull request Jan 7, 2022
…ngular.io version (#44649)

This page exists in the most recent angular.io version (v13 currently), so there's no need to link to an old version. The hash also refers to the title section of the page, which isn't necessary and is now dropped.

PR Close #44649
@dgp1130 dgp1130 deleted the v9-doc branch January 7, 2022 18:46
@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 Feb 7, 2022
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 area: compiler Issues related to `ngc`, Angular's template compiler target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants