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

Can't view documentation #2296

Open
mx-psi opened this issue Nov 23, 2023 · 7 comments
Open

Can't view documentation #2296

mx-psi opened this issue Nov 23, 2023 · 7 comments
Labels
documentation Documentation related changes kind/bug Bug related issue severity/normal Normal severity issue stale Stale - Bot reminder

Comments

@mx-psi
Copy link
Member

mx-psi commented Nov 23, 2023

Describe the bug

I can't view the documentation on https://pkg.go.dev/github.com/DataDog/datadog-api-client-go/[email protected]/api/datadogV2

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://pkg.go.dev/github.com/DataDog/datadog-api-client-go/[email protected]/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

@mx-psi mx-psi added documentation Documentation related changes kind/bug Bug related issue severity/normal Normal severity issue labels Nov 23, 2023
@therve
Copy link
Contributor

therve commented Nov 23, 2023

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
Copy link
Member Author

mx-psi commented Nov 24, 2023

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.

Copy link

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.

@github-actions github-actions bot added the stale Stale - Bot reminder label Dec 25, 2023
@fornellas-udemy
Copy link

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 😞

@github-actions github-actions bot removed the stale Stale - Bot reminder label Aug 24, 2024
@therve
Copy link
Contributor

therve commented Aug 26, 2024

This is back, sorry for the inconvenience.

Copy link

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.

@github-actions github-actions bot added the stale Stale - Bot reminder label Sep 26, 2024
@fornellas-udemy
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation related changes kind/bug Bug related issue severity/normal Normal severity issue stale Stale - Bot reminder
Projects
None yet
Development

No branches or pull requests

3 participants