search

DataDog / datadog-api-client-go

Golang client for the Datadog API
https://pkg.go.dev/github.com/DataDog/datadog-api-client-go/v2
Apache License 2.0
135 stars 54 forks source link

Can't view documentation #2296

Open mx-psi opened 11 months ago

mx-psi commented 11 months ago

Describe the bug

I can't view the documentation on https://pkg.go.dev/github.com/DataDog/datadog-api-client-go/v2@v2.19.0/api/datadogV2

To Reproduce Steps to reproduce the behavior:

  1. Go to https://pkg.go.dev/github.com/DataDog/datadog-api-client-go/v2@v2.19.0/api/datadogV2
  2. You can see an error message saying 'Documentation is too large to display.'

Expected behavior

I can read the documentation :)

Screenshots

image

therve commented 11 months ago

Hi,

It's a limitation of pkg.go.dev that I don't think we can do much about. We do have a working version at https://datadoghq.dev/datadog-api-client-go/pkg/github.com/DataDog/datadog-api-client-go/v2/api/datadogV2/ though. Does that work for you? Thanks.

mx-psi commented 11 months ago

It's a limitation of pkg.go.dev that I don't think we can do much about.

Splitting into multiple packages would definitely help, but that would be for the next major version I guess

We do have a working version at https://datadoghq.dev/datadog-api-client-go/pkg/github.com/DataDog/datadog-api-client-go/v2/api/datadogV2/ though. Does that work for you? Thanks.

It does! Would be great if that were linked directly on the package page. I think you can do this as described on golang/go/issues/42968, see example on https://pkg.go.dev/github.com/jba/links. That way this will show on the right under the 'Links' header.

github-actions[bot] commented 10 months ago

Thanks for your contribution!

This issue has been automatically marked as stale because it has not had activity in the last 30 days. Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity. Thank you for participating in the Datadog open source community.

If you would like this issue to remain open:

  1. Verify that you can still reproduce the issue in the latest version of this project.

  2. Comment that the issue is still reproducible and include updated details requested in the issue template.

fornellas-udemy commented 2 months ago

OK... so aside the oddity of the humongous package that breaks pkg.go.dev... the other ad-hoc documentation link https://datadoghq.dev/datadog-api-client-go/pkg/github.com/DataDog/datadog-api-client-go/v2/api/datadogV2/ is also broken now: image so... no docs at all :disappointed:

therve commented 2 months ago

This is back, sorry for the inconvenience.

github-actions[bot] commented 1 month ago

Thanks for your contribution!

This issue has been automatically marked as stale because it has not had activity in the last 30 days. Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity. Thank you for participating in the Datadog open source community.

If you would like this issue to remain open:

  1. Verify that you can still reproduce the issue in the latest version of this project.

  2. Comment that the issue is still reproducible and include updated details requested in the issue template.

fornellas-udemy commented 1 month ago

Ping. IMHO this humongous package could / should be broken down into more modest size packages. Even when viewing things on GH pages, the page is so huge, that my browser freezes for 1-2s on every click. Pretty bad.