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

docs: add READMEs for instrumentation modules #674

Open
axw opened this issue Nov 14, 2019 · 2 comments
Open

docs: add READMEs for instrumentation modules #674

axw opened this issue Nov 14, 2019 · 2 comments
Labels

Comments

@axw
Copy link
Member

axw commented Nov 14, 2019

We should add READMEs for each instrumentation module, providing basic usage docs which will show up on pkg.go.dev. When we do this, we may want to use the content to generate docs for elastic.co.

@axw axw added the docs label Nov 14, 2019
@bmorelli25
Copy link
Member

👋 Going through old issues today. I clicked through a few of the modules on this list https://pkg.go.dev/go.elastic.co/apm/module, and it seems like they all have readmes. Is this issue still relevant?

@axw
Copy link
Member Author

axw commented Apr 1, 2021

Still somewhat relevant I think. It seems pkg.go.dev no longer shows that warning, but shows the basic package doc comment. I'd like to have some basic documentation about usage show up on that site, as it's pretty common avenue for Go devs to get their docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants