devspace
devspace copied to clipboard
Documentation bugs?
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.
- Under pipeline only functions
![image](%5Bhttps://user-images.githubusercontent.com/1883296/175118609-a1a5d3d5-5437-480d-bc45-7fe3e5be78e2.png%5D(https://user-images.githubusercontent.com/1883296/175118609-a1a5d3d5-5437-480d-bc45-7fe3e5be78e2.png))
A number of arguments have the description "Skip pushing" which doesn't reflect the argument name.
![image](%5Bhttps://user-images.githubusercontent.com/1883296/175119153-a739fa6b-03de-4043-9793-75be80e4eb86.png%5D(https://user-images.githubusercontent.com/1883296/175119153-a739fa6b-03de-4043-9793-75be80e4eb86.png))
It's not clear what values --only
accepts.
![image](%5Bhttps://user-images.githubusercontent.com/1883296/175119324-213f8ea3-8919-44d8-8516-bdbd2815c810.png%5D(https://user-images.githubusercontent.com/1883296/175119324-213f8ea3-8919-44d8-8516-bdbd2815c810.png))
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?
![image](%5Bhttps://user-images.githubusercontent.com/1883296/175122370-15e97ff0-455e-4c51-b105-ca8fbfe95b0b.png%5D(https://user-images.githubusercontent.com/1883296/175122370-15e97ff0-455e-4c51-b105-ca8fbfe95b0b.png))
BuildKitInClusterConfig doesn't actually provide an "args" key. From a few tests, it appears "createArgs" might be the new key?
- 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.