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.

Sign up for GitHub

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

Jump to bottom

Review input variable descriptions #388

Open
vburckhardt opened this issue Apr 18, 2024 · 0 comments
Open

Review input variable descriptions #388

vburckhardt opened this issue Apr 18, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@vburckhardt
Copy link
Member

Description

Some confusions - not an exhaustive list - may be worth a review with @SirSpidey :

  • Indicate when an input refers to an existing resource. Prefix the variable name with existing_ if possible. This will help distinguish between resource created by the DA and existing resources that are prereq to run the DA
  • Indicate where some variables are related - eg: some variables enable to take either the crn, id, or guid.
  • Avoid some acronyms that are not obvious to most users - eg: PAT.
  • ...

New or affected modules

By submitting this issue, you agree to follow our Code of Conduct
@vburckhardt vburckhardt added the enhancement New feature or request label Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vburckhardt