carvel icon indicating copy to clipboard operation
carvel copied to clipboard

The vendir docs have typo in spelling of dangerouSkipTLSVerify

Open GrahamDumpleton opened this issue 2 years ago • 3 comments

What steps did you take:

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

  • https://carvel.dev/vendir/docs/v0.34.x/vendir-spec/

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.

  • site/content/vendir/docs/*/vendir-spec.md

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

GrahamDumpleton avatar Sep 15 '23 05:09 GrahamDumpleton

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

duckling69 avatar Sep 19 '23 05:09 duckling69

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

praveenrewar avatar Sep 19 '23 11:09 praveenrewar

Can I work on this project?

Kiran-pro2001 avatar Apr 30 '24 12:04 Kiran-pro2001

Is this issue stlill open, if yes, I would like to work on this.

poojatalele avatar Jul 25 '24 10:07 poojatalele

The issue was closed with #715

praveenrewar avatar Aug 28 '24 12:08 praveenrewar