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

Documentation on pkg.go.dev not available due to licence file and tags #169

Closed
rogchap opened this issue Jul 3, 2020 · 9 comments · Fixed by #254
Closed

Documentation on pkg.go.dev not available due to licence file and tags #169

rogchap opened this issue Jul 3, 2020 · 9 comments · Fixed by #254

Comments

@rogchap
Copy link
Contributor

rogchap commented Jul 3, 2020

The recent change to the license file has caused the documentation to be removed from https://pkg.go.dev site:

image

https://pkg.go.dev/github.com/newrelic/go-agent/v3/newrelic?tab=overview

@purple4reina
Copy link
Contributor

@rogchap Thanks for bringing this to our attention. We are working to address it.

@v3n
Copy link

v3n commented Sep 24, 2020

I think what's causing the problem is the repository layout. When using the major directory model, everything must exist in that directory, including licenses/readmes.

golang/go#41333 (comment)

I'd like to request the removal of the V3 directory, moving everything up to root and instead use the layout that Google uses for their Github library:

The major directory model has been causing pain for me, since the repository is unsearchable via Github without finding both v2 and v3 code.

@tydavis
Copy link
Contributor

tydavis commented Dec 17, 2020

I might have been a little overzealous, but the license file was copied to both the v3 and v3/newrelic subdirectories to guarantee coverage.

@tydavis
Copy link
Contributor

tydavis commented Jan 7, 2021

#254 has been merged. When released, it should fix this issue.

@RichVanderwal
Copy link
Contributor

We're targeting a Monday afternoon (January 11, 2021) release.

Go Engineering Board automation moved this from Triage to Done Jan 11, 2021
@tydavis
Copy link
Contributor

tydavis commented Jan 11, 2021

https://pkg.go.dev/github.com/newrelic/go-agent/v3/newrelic -- Issue resolved as of 2021-01-11 3:40pm Pacific time.

@RichVanderwal RichVanderwal moved this from Done to To Do in Go Engineering Board May 11, 2021
@RichVanderwal RichVanderwal changed the title Documentation on pkg.go.dev not available due to licence file Documentation on pkg.go.dev not available due to licence file and tags May 11, 2021
@RichVanderwal
Copy link
Contributor

The integrations' documentation still isn't showing up, most likely due to tags not being updated. I'm reopening this issue until we can see documentation for the tools in v3/integrations.

@RichVanderwal RichVanderwal added this to the May Go Agent Release milestone May 11, 2021
@RichVanderwal RichVanderwal reopened this May 11, 2021
Go Engineering Board automation moved this from To Do to Triage May 11, 2021
@tydavis
Copy link
Contributor

tydavis commented May 11, 2021

@RichVanderwal Likely a tagging problem, yes. Once the tag for the 3.X series is pushed/scanned/updated, it should trigger an update.

You could also try running:

curl https://sum.golang.org/lookup/github.com/newrelic/go-agent/v3/integrations@v3.12.0

Update: Response from the server:

not found: github.com/newrelic/go-agent/v3/integrations@v3.12.0: invalid version: unknown revision v3/integrations/v3.12.0

@RichVanderwal
Copy link
Contributor

Still working on this. Testing the two updated integration packages nrawssdk-v2 and nrgrpc, and also with one un-updated integration, nrzap.

@nr-swilloughby nr-swilloughby moved this from Triage to To Do in Go Engineering Board Jun 25, 2021
@nr-swilloughby nr-swilloughby moved this from To Do to In progress in Go Engineering Board Jun 25, 2021
Go Engineering Board automation moved this from In progress to Done Jun 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

6 participants