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

Provide usage examples #692

Closed
arminru opened this issue Dec 10, 2019 · 4 comments
Closed

Provide usage examples #692

arminru opened this issue Dec 10, 2019 · 4 comments
Assignees

Comments

@arminru
Copy link
Member

arminru commented Dec 10, 2019

We should add samples for using OpenTelemetry Java to make it easier for beginners to get a feeling of how to use the API properly.
OpenCensus had examples included right in the repo and so do OTel Python, JS, Go and .NET.

@arminru arminru assigned arminru and unassigned arminru Dec 10, 2019
@thisthat
Copy link
Member

I can take care of it!

@arminru
Copy link
Member Author

arminru commented Dec 10, 2019

Should we make the examples a subproject which breaks the build if the API is changed without updating the examples accordingly?

Having the examples as standalone projects which reference OTel via Maven makes more sense for users looking at them but this way they're more likely to get outdated if no one cares to update them regularly.

This was referenced Dec 12, 2019
@carlosalberto
Copy link
Contributor

Should we make the examples a subproject which breaks the build if the API is changed without updating the examples accordingly?

I personally like this, as otherwise it would be very easy to forget about them ;)

@bogdandrutu
Copy link
Member

I think we have the first set of examples, we should file more granular issues if we need more examples.

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

No branches or pull requests

4 participants