search

tellerops / teller

Cloud native secrets management for developers - never leave your command line for secrets.
https://github.com/tellerops/teller
Apache License 2.0
2.83k stars 186 forks source link

Documentation is now a little bit horrible #305

Open david-heward-unmind opened 4 weeks ago

david-heward-unmind commented 4 weeks ago

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.

jondot commented 4 weeks ago

Honest feedback is the best! Thank you for that. I know that in the major transition between 1 and 2 major changes have happened. The most we invested in was that the README will be as close to v2 as possible.

Can you point 1-2 examples just so we can pinpoint what we need to invest in next?

david-heward-unmind commented 1 week ago

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. Example 2. I used the KeePass provider in v1, but that's just now vanished; zero docs around whether I could bring it back etc. I get the refactor, but its just poor experience for users.