search

carvel-dev / carvel

Carvel provides a set of reliable, single-purpose, composable tools that aid in your application building, configuration, and deployment to Kubernetes. This repo contains information regarding the Carvel open-source community.
https://carvel.dev/
Apache License 2.0
369 stars 108 forks source link

The vendir docs have typo in spelling of dangerouSkipTLSVerify #681

Open GrahamDumpleton opened 9 months ago

GrahamDumpleton commented 9 months ago

What steps did you take:

I read the docs and used the example from the page:

where example is:

      # specify wether to skip TLS verification; defaults to false (optional;v0.18.0+)
      dangerouSkipTLSVerify: false

but where changed value to true.

What happened:

Obviously there is a typo here in the documentation and it should be:

dangerousSkipTLSVerify

but the wrong spelling as given in docs was silently accepted so only knew there was an issue when it didn't actually work as expected.

What did you expect:

For the docs to be correct. ;-)

Anything else you would like to add:

This needs to be fixed in all versions of vendir docs in the repo, not just latest.

There are multiple places in file where needs to be fixed.

duckling69 commented 9 months ago

I'd like to work on this issue // @coreyti @GrahamDumpleton @praveenrewar

praveenrewar commented 9 months ago

Thanks @duckling69! I have assigned the issue to you.

Kiran-pro2001 commented 2 months ago

Can I work on this project?