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.

Sign up for GitHub

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

add bcd link for cli upgrade #3768

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

add bcd link for cli upgrade #3768

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f56ba74
add bcd link
AllyW Jul 31, 2023
a4fad7b
add gif
AllyW Jul 31, 2023
20c5caf
update link
AllyW Jul 31, 2023
977cde3
adjust text
AllyW Aug 4, 2023
e3892de
Update docs-ref-conceptual/update-azure-cli.md
dbradish-microsoft Jul 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs-ref-conceptual/media/azure-cli-diff-site.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-ref-conceptual/media/command-change.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion docs-ref-conceptual/update-azure-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,15 @@ az config set auto-upgrade.all=no
If you decide not to use the automatic update feature any more for cases like keeping command scripts running stably, you can turn it off through configuration.
```azurecli
az config set auto-upgrade.enable=no
```
```
## Update Assistance
dbradish-microsoft marked this conversation as resolved.
Show resolved Hide resolved

Azure cli also provides a command line tool [command-change](https://github.com/Azure/azure-cli-extensions/blob/main/src/command-change/README.md) and a [azure-cli-diff-site](https://azure-cli-diff-site.azurewebsites.net/) to help users justify whether a cli upgrade is safe, how to adjust current command usage by checking the changelist between two cli versions. For detailed usage doc and result analysis, please refer to this [doc](https://github.com/Azure/azure-cli/blob/897a4cd2874e315558d1f1925e866a80ab945f18/doc/breaking_change_detection_guidelines.md).
Copy link
Collaborator

@dbradish-microsoft dbradish-microsoft Jul 31, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Suggestion 1: [command-change](https://github.com/Azure/azure-cli-extensions/blob/main/src/command-change/README.md)
We should not be sending customers to GitHub from conceptual content unless it is for a sample. Can this be changed to a link to our autogenerated reference content?

Comment 2: I'm thinking about SEO. Can the azure-cli-diff-site.azurewebsites.net be given a H1 name? The only way for our customers to find this URL is through this one conceptual doc link?

Suggestion 3: This information is very informative and I feel needs to be in azure-docs-cli published in the same node as our Breaking Changes doc --> [doc] (https://github.com/Azure/azure-cli/blob/897a4cd2874e315558d1f1925e866a80ab945f18/doc/breaking_change_detection_guidelines.md)

Suggestion 4: Can we reword this paragraph to something along the lines of ...

"The Azure CLI also provides a reference command, [az command-change](link to ref content), and a website, azure-cli-diff-site, to help you examine changes between CLI versions. Use the version comparison list provided to prepare your scripts for a version update. See [Breaking change detection for the Azure CLI](link to new doc in azure-docs-cli) for more information.

Copy link
Contributor

@jsntcy jsntcy Aug 4, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

@dbradish-microsoft, thanks for the good suggestions.

@dcaro, @Jacekey23 how about your thoughts?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is misleading in the upcoming breaking change since the tools does not show content of future versions.
SEO is important, search is the primary way people discover content nowdays.


### command-change

AllyW marked this conversation as resolved.
Show resolved Hide resolved
![command-change](media/command-change.gif)

### azure-cli-diff-site

AllyW marked this conversation as resolved.
Show resolved Hide resolved
![azure-cli-diff-site](media/azure-cli-diff-site.gif)