Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document ng update support guarantees #44142

Closed
wants to merge 1 commit into from

Conversation

@dgp1130
Copy link
Contributor

@dgp1130 dgp1130 commented Nov 10, 2021

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Documentation content changes\

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

This adds explicit documentation about official support for ng update, which is a bit awkward since it upgrades between two versions. It specifically calls out two aspects:

  1. ng update can only update across one major version at a time. The CLI should enforce this at run time, but it's good to document this more officially anyways.
  2. Updating from an unsupported version is ok as long as it is updating to a supported version. This clarifies which of the two versions (current vs destination of the update) is relevant for determining the support level.
@google-cla google-cla bot added the cla: yes label Nov 10, 2021
@dgp1130 dgp1130 requested review from jelbourn and removed request for IgorMinar Nov 18, 2021
@dgp1130 dgp1130 force-pushed the ng-update-versioning branch from ba9639d to 3b066cf Nov 18, 2021
Copy link
Member

@jelbourn jelbourn left a comment

LGTM for content, though one of the tech writers should weigh in on structure

@ngbot ngbot bot added this to the Backlog milestone Nov 18, 2021
@alan-agius4 alan-agius4 requested a review from aikidave Nov 19, 2021
aio/content/guide/releases.md Outdated Show resolved Hide resolved
Copy link
Contributor

@aikidave aikidave left a comment

Did a rewrite of your second paragraph to try to help clarify the meaning. Let me know what you think.

aio/content/guide/releases.md Outdated Show resolved Hide resolved
@dgp1130 dgp1130 force-pushed the ng-update-versioning branch from 3b066cf to 658199e Nov 22, 2021
Copy link
Contributor

@aikidave aikidave left a comment

Looking good! A few minor changes. Some details as to why:

  1. Words like "simply" can be construed as condescending and are usually unnecessary anyway.
  2. Made the steps to update across multiple versions into a procedure to make it easier to read (and harder to skip. :) )

aio/content/guide/releases.md Outdated Show resolved Hide resolved
@dgp1130 dgp1130 force-pushed the ng-update-versioning branch from 658199e to f373959 Nov 23, 2021
Copy link
Contributor

@aikidave aikidave left a comment

LGTM!
Reviewed-for: global-docs-approvers

@dgp1130 dgp1130 removed the request for review from clydin Nov 23, 2021
@jessicajaniuk
Copy link
Contributor

@jessicajaniuk jessicajaniuk commented Nov 24, 2021

This PR was merged into the repository by commit 83bbbd3.

@angular-automatic-lock-bot
Copy link

@angular-automatic-lock-bot angular-automatic-lock-bot bot commented Dec 25, 2021

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 Dec 25, 2021
dimakuba added a commit to dimakuba/angular that referenced this issue Dec 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

6 participants