Azure-devops-docs: argument names and parameter names agreement

Created on 19 Dec 2019  Â·  8Comments  Â·  Source: MicrosoftDocs/azure-devops-docs

The names of the input arguments in the YAML snippet do not match the argument names in the argument column in the Argument section.


Document Details

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

Pri1 devops-cictech devopprod

Most helpful comment

The actual parameter names do not match the doc, and this is something we should all just get used to? Really?

All 8 comments

Argument column is not meant to be YAML input names. You can use the task assistant to get the YAML snippet.

image

image

image

The actual parameter names do not match the doc, and this is something we should all just get used to? Really?

please re-open and address

The task assistant offers help with exactly FOUR (4) parameters. This task has many more than four (4) parameters. This closure is unacceptable.

@HughDevlin Once you select the destination type (Blob/VM) in the task assistant, the additional fields that are applicable to that destination type appear.

Azure Blob
image

Azure VMs
image

is it Microsoft's position, that since the arguments to this task (all pipeline tasks?) are documented elsewhere (in the task assistant), that Microsoft's documentation on the web (this page) need not be maintained?

It's silly to expect everyone to have to use the task assistant just to put together the task... The documentation here demonstrates the task's yaml configuration and so should document the yaml configuration syntax.

Why have this page showing the config options if they're left undocumented?

For help with the task assistant, the built-in "(i)" buttons pop-out with relevant help text. This page shouldn't need to document the use of the assistant.

We are working on getting all the task docs updated to have the yaml arguments as well. Thanks for your feedback.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

dannyvv picture dannyvv  Â·  3Comments

adnanebrahimi picture adnanebrahimi  Â·  3Comments

csutorasr picture csutorasr  Â·  3Comments

LennartAJansson picture LennartAJansson  Â·  3Comments

dtamai picture dtamai  Â·  3Comments