Skip to content
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 bugs? #2122

Closed
withinboredom opened this issue Jun 22, 2022 · 0 comments
Closed

Documentation bugs? #2122

withinboredom opened this issue Jun 22, 2022 · 0 comments

Comments

@withinboredom
Copy link

withinboredom commented Jun 22, 2022

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants