6 ms·
I hate the trend of documenting by giving only examples and tutorials. Examples are nice to get started, but completely useless otherwise. Please just give me
by Seb-C 4y ago
I hate the trend of documenting by giving only examples and tutorials.
Examples are nice to get started, but completely useless otherwise. Please just give me a list of possible parameters/properties with their meaning, type and possible values.
For example, the Kubernetes documentation is a nightmare to me because it's not a real documentation, just a bunch of examples. Not only it is very inefficient to look for a very specific piece of information in that, but if my case happens not to be in it (which is most of the time) I can waste hours looking everywhere to finally learn that there is actually a x.y[0].z key that does exactly what I need.
Other example: Github actions. If you look hard enough, you may find something close to a yaml specification, but it's quite hidden, confusing and difficult to understand which property belongs to what. In contrast, CircleCI is extremely easy.
- bcoughlan 4y agoBuried in the Kubernetes docs is also a link to the API reference https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.24/ https://kubernetes.io/docs/reference/generated/kubernetes-ap...
- TheJoeMan 4y agoWorse is when the examples throw out some of the parameters or returned variables! Like a Python function that returns a tuple should never have an underscore in documentation.