-
Notifications
You must be signed in to change notification settings - Fork 189
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 is now a little bit horrible #305
Comments
Honest feedback is the best! Thank you for that. Can you point 1-2 examples just so we can pinpoint what we need to invest in next? |
Apologies for not buttering it up! IMO, you went from a tool that documented several "providers" quite well to providing extremely poor documentation of what is a "supported" provider, what happened to the old providers, and if a provider continues to be supported. Ensure supportive documentation of EVERY supported provider, with examples. This is the basic expectation. Tools are supposed to save you time, not leave you scavenging source code for clues. Those of us with previously supported providers who now find ourselves without one—what to do? There is zero guidance, barely even a mention. Is there a roadmap? Etc. etc. For me, it went from being useful and cutting through a bit of noise to being a headache. On that basis, I'd never bake into a production workload due mostly to poor docs. Example 1. It appears etcd is supported but there are no docs. |
I don't mean to be critical, but this project's documentation has been confusing and not fully featured since v2.
Please include some proper documentation of the providers, with examples for every supported provider type.
The text was updated successfully, but these errors were encountered: