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

"Install the Azure CLI on Linux" should focus on that and tell URL #3183

Closed
3 tasks done
sdettmer opened this issue Jun 13, 2022 · 5 comments
Closed
3 tasks done

"Install the Azure CLI on Linux" should focus on that and tell URL #3183

sdettmer opened this issue Jun 13, 2022 · 5 comments

Comments

@sdettmer
Copy link

Prerequisites

  • Write a descriptive title.
  • Search the existing issues.
  • I am reporting the documentation problem for the current version of Azure CLI.

Azure CLI version being used

bash: az: command not found

Link to affected document

https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=apt

Description of the documentation error

The article "Install the Azure CLI on Linux" does not mention the URL where to download packages in case "you may manually install the Azure CLI on Linux by selecting the Install script option" (I like the "az" script (or binary?) as TGZ). This makes it very time consuming: instead of "Browse downloads [here]" and a two minutes job, it is a "25 minutes to read" (!!!) posting which forgets to mention the URL where to download a tarbal from.

Suggested fix

The article should focus on installing and for example mention the URL where to download the "az" script (or binary?) in case "you may manually install the Azure CLI on Linux by selecting the Install script option", but instead it repeats APT basics like proxy configuration, where a link would be suited better. This would save readers time and if reading time would be 2 minutes instead 25 minutes, it would be ten times more efficient!

@AjayKumar-MSFT
Copy link

Adding doc metadata info:


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

@JamesTran-MSFT
Copy link

@sdettmer
Thanks for your feedback! I've assigned this issue to the author who will investigate and update as appropriate.

@jiasli
Copy link
Member

jiasli commented Jul 5, 2022

Install script means this page: https://docs.microsoft.com/en-us/cli/azure/install-azure-cli-linux?pivots=script

It actually installs from PyPI (https://pypi.org/) with pip so the URL doesn't necessarily need to be documented. Actually, that document hasn't been updated for some time. We do have a plan to provide a new pip installation guidance: Azure/azure-cli#20476

@sdettmer
Copy link
Author

sdettmer commented Jul 6, 2022 via email

@dbradish-microsoft
Copy link
Collaborator

sdettmer, Thanks for providing feedback that helps improve our documentation. We are in the process of freshening this article, and your feedback is very helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants