-
-
Notifications
You must be signed in to change notification settings - Fork 311
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
Create use-case driven examples in the README #146
Comments
Another thing that might help adoption: explaining, with examples, what problem this module is meant to solve. I recently found this module because it was used by other CloudPosse modules. As I read the readme, I realized that I didn't really understand why I'd want to use this module. And the wall of text you mentioned further muddied the waters... so I stopped reading. Are there any real-world examples of folks using the module to go from Anyway, just my 2 cents as someone recently discovering this module and wondering if I should use it. Thanks for making these modules 🍻 |
@natemccurdy I completely agree. I added some use-cases above after your comment that might help explain it a little more. |
cc: @Gowiem posted this https://masterpoint.io/updates/terraform-null-label/ |
Have a question? Please checkout our Slack Community or visit our Slack Archive.
Describe the Feature
The README has a Wall of Text (WoT) which is overwhelming even for people who are familiar with the null label.
This prevents people from deliberately adopting (instead of accidentally adopting through usage of the open source modules) this module.
Expected Behavior
Real simple
Running the above terraform shows you the full output of the module
There are other examples already (label2.tf) in the repo too which can be useful to figure out how to use this. However you'd have to dig here.
Use Case
This module is difficult to explain to users. I find myself going to the readme and then creating my own explanation or showing the users via an example like the one above.
Describe Ideal Solution
null-label
modulenull-label
instead of justlabel
?id
andtags
contextcontext
and what makes it so powerful?context.tf
mixin can use the same identifier and override valuescontext = module.label.contect
to reuse namesid_length_limit
or set one of the above inputs tonull
or""
to omit it from theid
atmos
make use of this module ?context.tf
and why should I use it in my terraform module?Alternatives Considered
I write a blogpost on this or someone else does to help explain everything
Additional Context
N/A
The text was updated successfully, but these errors were encountered: