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

The vendir docs have typo in spelling of dangerouSkipTLSVerify #681

Closed
GrahamDumpleton opened this issue Sep 15, 2023 · 5 comments
Closed
Assignees
Labels
bug This issue describes a defect or unexpected behavior carvel accepted This issue should be considered for future work and that the triage process has been completed carvel-triage documentation This issue indicates a change to the docs should be considered good first issue An issue that will be a good candidate for a new contributor

Comments

@GrahamDumpleton
Copy link

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.

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

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

@GrahamDumpleton GrahamDumpleton added bug This issue describes a defect or unexpected behavior carvel-triage labels Sep 15, 2023
@praveenrewar praveenrewar added good first issue An issue that will be a good candidate for a new contributor documentation This issue indicates a change to the docs should be considered carvel accepted This issue should be considered for future work and that the triage process has been completed and removed carvel-triage labels Sep 15, 2023
@duckling69
Copy link

duckling69 commented Sep 19, 2023

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

@praveenrewar
Copy link
Member

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

@Kiran-pro2001
Copy link

Can I work on this project?

@poojatalele
Copy link

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

@praveenrewar
Copy link
Member

The issue was closed with #715

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue describes a defect or unexpected behavior carvel accepted This issue should be considered for future work and that the triage process has been completed carvel-triage documentation This issue indicates a change to the docs should be considered good first issue An issue that will be a good candidate for a new contributor
Projects
Archived in project
Development

No branches or pull requests

5 participants