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

kv import doc ahead of released version #10172

Closed
rjhornsby opened this issue May 4, 2021 · 3 comments · Fixed by #10684
Closed

kv import doc ahead of released version #10172

rjhornsby opened this issue May 4, 2021 · 3 comments · Fixed by #10684
Labels
type/docs Documentation needs to be created/updated/clarified type/question Not an "enhancement" or "bug". Please post on discuss.hashicorp

Comments

@rjhornsby
Copy link

Overview of the Issue

As of this writing, the current consul docs for kv import describe a -prefix argument that is not available in the current consul release 1.9.5. It looks like this is planned for the 1.10 series.

I know there are nearly 800 open issues and this falls somewhere below the lowest priority. Filing the issue anyway because it's confusing and less than ideal use of time to RTFM, go try something the docs say can be done - then head scratching, digging, goose chasing, then figure out the docs are wrong.

Maybe a little note near an upcoming feature in the docs that says "new in 1.10+" - just some way that makes it clear doesn't work yet. I went to the consul code to figure it out because I can more or less read Golang, but that's a bit much for most users IMHO.

Reproduction Steps

Steps to reproduce this issue, eg:

  1. Run consul kv import -prefix=foo/bar < some_file.json
  2. Get error flag provided but not defined: -prefix

Consul info for both Client and Server

Client info

version 1.9.5

Operating system and Environment details

CLI client on macOS

@dnephin
Copy link
Contributor

dnephin commented May 4, 2021

Thank you for reporting the problem. That enhancement was merged in PR #9792. Normally docs should not get published until the release is out. We released a beta version of 1.10. It may be that we accidentally published the docs ahead of time as part of the beta release.

@jsosulska jsosulska added type/docs Documentation needs to be created/updated/clarified type/question Not an "enhancement" or "bug". Please post on discuss.hashicorp labels May 6, 2021
blake added a commit that referenced this issue Jul 22, 2021
Add a sentence stating the version of Consul that introduced the
`-prefix` option for `consul kv import`.

Resolves #10172
blake added a commit that referenced this issue Jul 26, 2021
Add a sentence stating the version of Consul that introduced the
`-prefix` option for `consul kv import`.

Resolves #10172
@blake
Copy link
Contributor

blake commented Jul 26, 2021

Hi @rjhornsby, thanks for bringing this to our attention. I've updated the docs to state that the prefix option was recently added as of Consul 1.10. Hopefully this helps avoid confusion in future.

blake added a commit that referenced this issue Jul 26, 2021
Add a sentence stating the version of Consul that introduced the
`-prefix` option for `consul kv import`.

Resolves #10172
@rjhornsby
Copy link
Author

Thanks guys. Sometimes things fall through the cracks, and sometimes things are meant to be in the cracks until they’re ready. It happens.

Appreciate your willingness to attend to what might seem like trivial details despite how busy I’m sure you are. So much of what we do is many little things accumulating over time, hardly noticed, forming into something not so little — either a big, sloppy, frustrating mess or a solid product that feels well designed and productive.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Documentation needs to be created/updated/clarified type/question Not an "enhancement" or "bug". Please post on discuss.hashicorp
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants