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: simplify README.md #107

Merged
merged 4 commits into from
Nov 16, 2022
Merged

docs: simplify README.md #107

merged 4 commits into from
Nov 16, 2022

Conversation

LukeWinikates
Copy link
Contributor

@LukeWinikates LukeWinikates commented Sep 22, 2022

  • 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

@LukeWinikates
Copy link
Contributor Author

see #106

Copy link
Contributor

@keep94 keep94 left a 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.

@keep94
Copy link
Contributor

keep94 commented Oct 21, 2022

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.

@LukeWinikates
Copy link
Contributor Author

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.

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.

Copy link
Contributor

@keep94 keep94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@shavidissa
Copy link
Contributor

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) :)

@keep94
Copy link
Contributor

keep94 commented Oct 24, 2022

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.

Copy link
Contributor

@shavidissa shavidissa left a 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 :)

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
RELEASING.md Outdated Show resolved Hide resolved
@LukeWinikates
Copy link
Contributor Author

thanks @shavidissa!

@keep94 I also created #118 as a place to discuss whether we can make the RELEASING.md steps easier.

@LukeWinikates
Copy link
Contributor Author

@keep94 do you think we're ok to merge this PR now? I think all the review comments are resolved

@keep94 keep94 merged commit c98ad78 into wavefrontHQ:master Nov 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants