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

Documentation does not include required resourcePrefix parameter #568

Closed
lisamurphy-msft opened this issue Dec 9, 2021 · 3 comments · Fixed by #587
Closed

Documentation does not include required resourcePrefix parameter #568

lisamurphy-msft opened this issue Dec 9, 2021 · 3 comments · Fixed by #587
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@lisamurphy-msft
Copy link
Contributor

Description

When deploying MLZ with the instructions provided, there is indication that there is an additional required parameter:

Please provide string value for 'resourcePrefix' (? for help):

Steps to Reproduce

az deployment sub create -n <deployment-name> -l <location> -f mlz.bicep 
@lisamurphy-msft lisamurphy-msft added bug Something isn't working documentation Improvements or additions to documentation labels Dec 9, 2021
@brooke-hamilton
Copy link
Contributor

@lisamurphy-msft There are references to resourcePrefix in these two documents. They were added around the same time as you created this bug, so maybe the weren't in the version you saw when this bug was created. Or is there an additional place we need a reference to resourcePrefix?
https://github.com/Azure/missionlz#quickstart
https://github.com/Azure/missionlz/blob/main/src/bicep/README.md#azure-cli

@lisamurphy-msft
Copy link
Contributor Author

I see it in the documentation; https://github.com/Azure/missionlz/blob/main/src/bicep/README.md#Azure-CLI as you previously stated. My contention is that required parameters should be listed in the examples as a one-liner instead of the additional prompt which is not what would be expected previously. This is a change in the customer experience with the new required parameter.

@brooke-hamilton
Copy link
Contributor

brooke-hamilton commented Dec 14, 2021

The expected result (the fix for this bug) is to add resourcePrefix to the command line examples so that the user is not prompted to enter the value after running the deployment command.

Update these docs:
https://github.com/Azure/missionlz#quickstart
https://github.com/Azure/missionlz/blob/main/src/bicep/README.md#azure-cli

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants