godoc for etcd 3.5 is missing/broken

[purpleidea]

Bug report criteria

• This bug report is not security related, security issues should be disclosed privately via etcd maintainers.
• This is not a support request or question, support requests or questions should be raised in the etcd discussion forums.
• You have read the etcd bug reporting guidelines.
• Existing open issues along with etcd frequently asked questions have been checked and this is not a duplicate.

What happened?

If you browse: https://pkg.go.dev/github.com/etcd-io/etcd you see version "v3.3.27+incompatible". No idea why this shows such an old version, but this is quite confusing when trying to read the docs.

I've tried to ask the website to pull a new version but it seems to not work. I've also tried to fetch docs on the better godocs.io site: https://godocs.io/github.com/etcd-io/etcd/clientv3 but also only old versions exist.

If you could fix this, that would be great. Not sure who's at fault, probably google somehow!

Thanks!

What did you expect to happen?

Docs should see v3.5.20

How can we reproduce it (as minimally and precisely as possible)?

See above

Anything else we need to know?

No response

Etcd version (please run commands below)

N/A

Etcd configuration (command line flags or environment variables)

paste your configuration here

Etcd debug information (please run commands below, feel free to obfuscate the IP address or FQDN in the output)

$ etcdctl member list -w table
# paste output here

$ etcdctl --endpoints=<member list> endpoint status -w table
# paste output here

Relevant log output

[ghouscht]

The link you’re looking for is: https://pkg.go.dev/go.etcd.io/etcd/v3

The link you posted is pointing to the „v0“ (in go module terms) version of the code, this is also the reason why it has the +incompatible suffix.

[purpleidea]

This doesn't seem to show the API docs. I'm following the go documentation badge in the etcd README to get the "bad" link. If you send me the correct one I'll update it with a patch.

[ivanvc]

Thanks, @ghouscht, for pointing out the correct location in the documentation.

@purpleidea, thanks for raising this issue. It's right; the link is broken because of how 3.5 split the project into submodules. I believe the API documentation you're looking for is at https://pkg.go.dev/go.etcd.io/etcd/api/v3. We could update the badge URL to match what Thomas suggested. Maybe we should have a section in the README pointing to the godoc for each of the modules:

• go.etcd.io/etcd/api/v3 => https://pkg.go.dev/go.etcd.io/etcd/api/v3
• go.etcd.io/etcd/client/pkg/v3 => https://pkg.go.dev/go.etcd.io/etcd/client/pkg/v3
• go.etcd.io/etcd/client/v2 => https://pkg.go.dev/go.etcd.io/etcd/client/v2
• go.etcd.io/etcd/client/v3 => https://pkg.go.dev/go.etcd.io/etcd/client/v3
• go.etcd.io/etcd/etcdctl/v3 => https://pkg.go.dev/go.etcd.io/etcd/etcdctl/v3
• go.etcd.io/etcd/etcdutl/v3 => https://pkg.go.dev/go.etcd.io/etcd/etcdutl/v3
• go.etcd.io/etcd/pkg/v3 => https://pkg.go.dev/go.etcd.io/etcd/pkg/v3
• go.etcd.io/etcd/raft/v3 => https://pkg.go.dev/go.etcd.io/etcd/raft/v3
• go.etcd.io/etcd/server/v3 => https://pkg.go.dev/go.etcd.io/etcd/server/v3
• go.etcd.io/etcd/tests/v3 => https://pkg.go.dev/go.etcd.io/etcd/tests/v3

[purpleidea]

These are the links I was looking for, thanks! In particular: https://pkg.go.dev/go.etcd.io/etcd/client/v3#pkg-index and also https://pkg.go.dev/go.etcd.io/etcd/server/v3#section-sourcefiles for example.

Want me to send a patch? Not sure what the consensus about what the patch should look like is, but at the moment it's definitely something that needs fixing.

Cheers!

[ivanvc]

@purpleidea, if you're able, please send the patch. It would be greatly appreciated. I suggest replacing the Go doc badge with https://pkg.go.dev/go.etcd.io/etcd/v3 and adding a section in the README pointing to the submodule documentation pages. Thanks!

[purpleidea]

Here you go: #19649