devspace icon indicating copy to clipboard operation
devspace copied to clipboard

Documentation bugs?

Open withinboredom opened this issue 2 years ago • 0 comments

I started going through the docs page by page after noticing a few oddities. I was digging for how to force Docker to always --pull base images. Anyway, I managed to go through each page looking for more oddities and thought I'd report the ones I discovered. I didn't make it through every single page, but a good number of them, so someone will need to finish because I'm sure there are more.

  1. Under pipeline only functions
image

A number of arguments have the description "Skip pushing" which doesn't reflect the argument name.

image

It's not clear what values --only accepts.

image

This also looks like --disable-open has the wrong description.

Random Q, when an argument accepts an array, how is that formatted? Is it a , delimited or space-delimited or a literal json array?

  1. BuildKit docs
image

BuildKitInClusterConfig doesn't actually provide an "args" key. From a few tests, it appears "createArgs" might be the new key?

  1. I stopped just before Deployments, going down the list in the sidebar of the docs if anyone wants to pick up where I left off. I'm going to be out of town for the next couple of days, so I won't be able to finish.

All in all, the docs are amazing! These are tiny things that I managed to locate.

withinboredom avatar Jun 22 '22 19:06 withinboredom