-
Notifications
You must be signed in to change notification settings - Fork 21
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: simplify README.md #107
Conversation
LukeWinikates
commented
Sep 22, 2022
•
edited
Loading
edited
- move releasing instructions into their own file
- remove table discussing SDKs not in this repo
- remove examples in README in favor of code examples
- add internal SDK metrics to this README
see #106 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems you are removing all the SDK examples from the readme documentation. I believe this is the direction we want to go, but I don't remember seeing example code in your other PR for histograms for instance.
Someone from our tech writing team should have a look at this PR since it involves changes to the README file. I am figuring out who that person will be. |
Thanks Travis - yep, this PR removes the examples from the README. It looks like I did convert all of the readme examples into godoc examples, so spans, histograms, metrics, and delta counters are all included in the test file added by this PR. |
…structions to RELEASING.md
the individual interfaces method examples were not showing up in godoc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Hi Team, Question: Why are we removing the section on how to send data and configure. (how will a user know how to do these. Can we document the content so it's clear to users) :) |
Hi shavidissa, we are planning to move all the example code over to pkg.go.dev and add a link to pkg.go.dev from the readme. For you to see the changes on pkg.go.dev, we'd have to do a release, but if you download the godoc tool on your machine and checkout this PR, you can get a fairly accurate preview of what the page on pkg.go.dev will look like. I can show you how to do this if you'd like. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the explanation! I have a few minor comments.
LGTM after the changes are made :)
thanks @shavidissa! @keep94 I also created #118 as a place to discuss whether we can make the RELEASING.md steps easier. |
@keep94 do you think we're ok to merge this PR now? I think all the review comments are resolved |