-
Notifications
You must be signed in to change notification settings - Fork 623
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: updating readme #639
Conversation
This is making the readme consistent with some of the other SIG repos: - [js](https://github.com/open-telemetry/opentelemetry-js/blob/master/README.md) - [collector](https://github.com/open-telemetry/opentelemetry-collector)
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.
Nice, thanks!
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.
Looks very nice.
Just one comment about the link to the examples.
README.md
Outdated
<strong> | ||
<a href="CONTRIBUTING.md">Contributing<a/> | ||
• | ||
<a href="docs/examples/">Examples<a/> |
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.
Should this point to readthedocs? https://opentelemetry-python.readthedocs.io/en/latest/#examples?
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.
@codeboten want to apply this fix and we'll merge after?
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.
Thanks @mauriciovasquezbernal! applied your suggestion.
Co-authored-by: Mauricio Vásquez <mauricio@kinvolk.io>
* chore: 0.3.1 release proposal * chore: npm run bootstrap
This is making the readme consistent with some of the other SIG repos: