diff --git a/azure-devops/azext_devops/dev/repos/_help.py b/azure-devops/azext_devops/dev/repos/_help.py index 93f90b6a..ffd110d3 100644 --- a/azure-devops/azext_devops/dev/repos/_help.py +++ b/azure-devops/azext_devops/dev/repos/_help.py @@ -41,7 +41,6 @@ def load_repos_help(): type: group short-summary: Manage Git repositories import long-summary: This command imports the public repo fabrikam-open-source to the empty Git repo fabrikam-open-source for the default configuration - az devops configure --defaults organization=https://dev.azure.com/fabrikamprime project="Fabrikam Fiber". examples: - name: Manage Git repositories import. text: | diff --git a/azure-devops/azext_devops/dev/team/arguments.py b/azure-devops/azext_devops/dev/team/arguments.py index 670b25e3..0ba64cd0 100644 --- a/azure-devops/azext_devops/dev/team/arguments.py +++ b/azure-devops/azext_devops/dev/team/arguments.py @@ -28,7 +28,7 @@ def load_global_args(context): context.argument('organization', options_list=('--organization', '--org'), help='Azure DevOps organization URL. You can configure the default organization using ' 'az devops configure -d organization=ORG_URL. Required if not configured as ' - 'default or picked up via git config. Example: https://dev.azure.com/MyOrganizationName/') + 'default or picked up via git config. Example: `https://dev.azure.com/MyOrganizationName/`') context.argument('detect', arg_type=get_three_state_flag(), help='Automatically detect organization.') context.argument('project', options_list=('--project', '-p'), @@ -41,11 +41,11 @@ def load_global_args(context): def load_team_arguments(self, _): with self.argument_context('devops login') as context: context.argument('organization', - help='Azure DevOps organization URL. Example: https://dev.azure.com/MyOrganizationName') + help='Azure DevOps organization URL. Example: `https://dev.azure.com/MyOrganizationName`') with self.argument_context('devops logout') as context: context.argument('organization', - help='Azure DevOps organization URL. Example: https://dev.azure.com/MyOrganizationName/. ' + help='Azure DevOps organization URL. Example: `https://dev.azure.com/MyOrganizationName/`. ' 'If no organization is specified, all organizations will be logged out.') with self.argument_context('devops configure') as context: diff --git a/azure-devops/azext_devops/dev/team/configure.py b/azure-devops/azext_devops/dev/team/configure.py index 5ba4099e..fccef3ee 100644 --- a/azure-devops/azext_devops/dev/team/configure.py +++ b/azure-devops/azext_devops/dev/team/configure.py @@ -26,7 +26,7 @@ def configure(defaults=None, use_git_aliases=None, list_config=False): """Configure the Azure DevOps CLI or view your configuration. :param defaults: Space separated 'name=value' pairs for common arguments defaults, - e.g. '--defaults project=my-project-name organization=https://dev.azure.com/organizationName + e.g. '--defaults project=my-project-name organization=my-org-url arg=value'. Use '' to clear the defaults, e.g. --defaults project=''. :type defaults: str :param use_git_aliases: Set to 'true' to configure Git aliases global git config file diff --git a/azure-devops/azext_devops/dev/team/credentials.py b/azure-devops/azext_devops/dev/team/credentials.py index 70d9d012..beb99b65 100644 --- a/azure-devops/azext_devops/dev/team/credentials.py +++ b/azure-devops/azext_devops/dev/team/credentials.py @@ -40,7 +40,7 @@ def credential_set(organization=None): def credential_clear(organization=None): """Clear the credential for all or a particular organization - :param organization: Azure Devops organization URL. Example: https://dev.azure.com/MyOrganizationName/. + :param organization: Azure Devops organization URL. Example: `https://dev.azure.com/MyOrganizationName/`. If no organization is specified, all organizations will be logged out. :type organization: str """ diff --git a/azure-devops/azext_devops/dev/team/service_endpoint.py b/azure-devops/azext_devops/dev/team/service_endpoint.py index 7b522799..c91815d5 100644 --- a/azure-devops/azext_devops/dev/team/service_endpoint.py +++ b/azure-devops/azext_devops/dev/team/service_endpoint.py @@ -101,7 +101,7 @@ def create_azurerm_service_endpoint(name, azure_rm_tenant_id, azure_rm_service_p :param azure_rm_subscription_id: subscription id for azure rm service endpoint :type azure_rm_subscription_id: str :param azure_rm_service_principal_certificate_path: Path to (.pem) which is certificate. - Create using command "openssl pkcs12 -in file.pfx -out file.pem -nodes -password pass:". + Create using command "openssl pkcs12 -in file.pfx -out file.pem -nodes -password pass:password_here". More details : https://aka.ms/azure-devops-cli-azurerm-service-endpoint :type azure_rm_service_principal_certificate_path: str :param azure_rm_subscription_name: name of azure subscription for azure rm service endpoint diff --git a/doc/getting_started.md b/doc/getting_started.md index 889c1a13..f3b38186 100644 --- a/doc/getting_started.md +++ b/doc/getting_started.md @@ -67,7 +67,7 @@ Command Arguments --defaults -d : Space separated 'name=value' pairs for common arguments defaults, e.g. '-- - defaults project=my-project-name organization=https://dev.azure.com/organizationName arg=value' Use '' to + defaults project=my-project-name organization=my-org-url arg=value' Use '' to clear the defaults, e.g. --defaults project=''. -- list -l : Lists the contents of the config file. --use-git-aliases : Set to 'yes' to configure Git aliiases global git config file (to enable