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

Clarify help text for project and instance parameters #100

Closed
willsmythe opened this issue Nov 28, 2017 · 3 comments
Closed

Clarify help text for project and instance parameters #100

willsmythe opened this issue Nov 28, 2017 · 3 comments
Assignees
Labels
enhancement Task Enhancements or engineering items will fall in this category.

Comments

@willsmythe
Copy link
Contributor

The in-product help (i.e. --help) and the docs indicate that --project and --instance are optional arguments in many calls, but this is only true if --detect on is passed and the CLI is able to detect the project and instance from the local Git directory.

We should clarify the help text for both of these arguments to explain when one or both is required, and refer to the detect option. Also may need to update the error text shown by the CLI when no project is supplied.

@willsmythe willsmythe self-assigned this Nov 28, 2017
@bergmeister
Copy link
Contributor

I found it very confusing when I first started using the cli. detect should be enabed by default and on the first command after the installation, if it cannot detect the project/instance, then it should ask the user if he/she wants to configure defaults. Only after 15 minutes when I got too annoyed, I had to look up how to set the defaults.

@tedchamb
Copy link
Contributor

@bergmeister , --detect is enabled by default. It just has no effect if your current working directory is not associated with a git repo. Did you experience something different?

@atbagga atbagga added the Task Enhancements or engineering items will fall in this category. label Dec 28, 2018
@snankani snankani assigned atbagga and unassigned willsmythe Jan 24, 2019
@atbagga
Copy link
Collaborator

atbagga commented Jan 24, 2019

VSTS CLI is now Azure DevOps Extension. Refer the repo readme for more details.

We have updated the help texts and getting started guides to educate the new users on setting defaults including setting the defaults implicitly if you login with a particular organization.

Hopefully that fixes this and any similar issues that the users were facing.

e.g. Updates Error messages look like below:
"--organization must be specified. The value should be the URI of your Azure DevOps organization, for example: https://dev.azure.com/MyOrganization/ or your TFS organization. You can set a default value by running: az devops configure --defaults organization=https://dev.azure.com/MyOrganization/. For auto detection to work (--detect on), you must be in a local Git directory that has a "remote" referencing a Azure DevOps or TFS repository."
AND
"--project must be specified. The value should be the ID or name of a team project. You can set a default value by running: az devops configure --defaults project=."

Hence closing the issue.

@atbagga atbagga closed this as completed Jan 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Task Enhancements or engineering items will fall in this category.
Projects
None yet
Development

No branches or pull requests

4 participants