Add Useful Resources and Example Build Instructions to CONTRIBUTING.md by HudsonHumphries · Pull Request #97 · open-telemetry/opentelemetry-cpp

HudsonHumphries · 2020-05-29T22:49:40Z

These are resources I found helpful as I was getting to learn about Open Telemetry and specifically the C++ repository. Adding these resources will help newcomers as they will have a central place to go to for resources. This Open Telemetry Onboarding Resources Guide was written by @HudsonHumphries, @ankit-bhargava and @Brandon-Kimberly

pyohannes

Thanks for putting this together!

I wonder about merging this with the CONTRIBUTING.md. There's quite a bit of information that is duplicated in both documents, so that makes it harder to maintain when things change. I think most parts of this guide could be added under a Useful resources section in the CONTRIBUTING.md.

Especially for newcomers, it would be great if we had a quick start guide similar to Java's, and links to relevant spec parts from there.

reyang · 2020-05-30T02:19:06Z

I wonder about merging this with the CONTRIBUTING.md.

+1

HudsonHumphries · 2020-06-02T22:22:55Z

Thanks for the feedback! I am working with Ankit who made PR 94 to move our documentation into CONTRIBUTING.md.

g-easy · 2020-06-03T06:09:52Z

docs/open-telemetry-onboarding-resource-guide.md

+* Read through the [Open Telemetry Collector](https://github.com/open-telemetry/opentelemetry-collector) GitHub repository
+    * This repository has a lot of good information surrounding the Open Telemetry ecosystem. At the top of the **[readme](https://github.com/open-telemetry/opentelemetry-collector/blob/master/README.md)**, there are multiple links that give newcomers a good idea of what the project is about and how to get involved in it.
+* Read through the Open Telemetry Python documentation for its [API](https://opentelemetry-python.readthedocs.io/en/stable/api/api.html) and [SDK](https://opentelemetry-python.readthedocs.io/en/stable/sdk/sdk.html)
+    * The [API](https://github.com/open-telemetry/opentelemetry-java/blob/master/QUICKSTART.md) and [SDK](https://github.com/open-telemetry/opentelemetry-java/blob/master/QUICKSTART.md) documentation provides a lot of information on what the classes and their functions are used for. Since there is currently minimal documentation for C++, use the Python repository’s extensive documentation to learn more about how the API and SDK work.


Link is to Java but no mention of Java in the text?

I believe those should be linking to the API and SDK documentation for Python, thanks for catching that. Will fix it

HudsonHumphries · 2020-06-03T21:43:11Z

As Ankit mentioned in his PR, we moved build instructions for examples into this PR. I also moved the resources into CONTRIBUTING.md and fixed bad links.

reyang · 2020-06-05T21:03:18Z

CONTRIBUTING.md

+* Take a look at this [Java SDK example.](https://github.com/open-telemetry/opentelemetry-java/tree/master/examples/sdk-usage) This shows a good use case of the SDK using stdout exporter.
+* Take a look at the [Java Jaeger example.](https://github.com/open-telemetry/opentelemetry-java/tree/master/examples/jaeger) This provides a brief introduction to the Jaeger exporter, its interface, and how to interact with the service.
+
+Please contribute! You’re welcome to add more information if you come across any helpful resources


nit: missing an end period.

reyang · 2020-06-05T21:05:33Z

CONTRIBUTING.md


 Any Approver / Maintainer can merge the PR once it is **ready to merge**.
+
+## Build and Run Code Examples


I would suggest putting this section under Development (above How to Send Pull Requests).

reyang

Nice improvements! LGTM assuming the comments are addressed.

linux-foundation-easycla · 2020-06-05T22:01:23Z

The committers are authorized under a signed CLA.

✅ Hudson Humphries (b2cdca6, 2e4ba15, 7d82c82)

pyohannes · 2020-06-05T23:44:23Z

CONTRIBUTING.md

+
+### Code Examples
+
+* Follow the [simple trace example](https://github.com/open-telemetry/opentelemetry-cpp/pull/92) for an introduction to basic Open Telemetry functionality in C++.  Currently the example can be found in [PR #94](https://github.com/open-telemetry/opentelemetry-cpp/pull/94)


When this is merged, can you submit an issue that reminds us of updating this document before we do a first release? Once we have our own examples and exporters in place, many of the examples here should be switched out.

Yes, I'll get that issue up once this PR this merged

reyang · 2020-06-08T23:55:35Z

@pyohannes mentioned that he is okay to merge this PR during the community meeting.
Please rebase, thanks.

HudsonHumphries · 2020-06-09T17:09:44Z

Rebased @reyang

merged from upstream

Open Telemetry Onboarding Resource Guide for newcomers

b2cdca6

HudsonHumphries requested review from g-easy, jmacd, maxgolov, reyang, rnburn and tigrannajaryan as code owners May 29, 2020 22:49

pyohannes reviewed May 30, 2020

View reviewed changes

g-easy reviewed Jun 3, 2020

View reviewed changes

Moved resources and added building instructions to CONTRIBUTING.md

2e4ba15

ankit-bhargava mentioned this pull request Jun 3, 2020

Enhancements to PR #86 Add minimal tracer example #94

Merged

HudsonHumphries requested a review from g-easy June 3, 2020 21:43

HudsonHumphries changed the title ~~Open Telemetry Onboarding Resource Guide for newcomers~~ Add Useful Resources and Example Build Instructions to CONTRIBUTING.md Jun 3, 2020

reyang reviewed Jun 5, 2020

View reviewed changes

reyang approved these changes Jun 5, 2020

View reviewed changes

Moved Build Examples to Development and fixed a period

7d82c82

pyohannes reviewed Jun 5, 2020

View reviewed changes

pyohannes approved these changes Jun 9, 2020

View reviewed changes

Merge branch 'master' into master

9177167

reyang merged commit 9e5924c into open-telemetry:master Jun 9, 2020

This was referenced Jun 9, 2020

Update CONTRIBUTING.md with internal examples #101

Closed

REQUEST: New membership for HudsonHumphries open-telemetry/community#385

Closed

GerHobbelt pushed a commit to GerHobbelt/opentelemetry-cpp that referenced this pull request Jun 17, 2025

Merge pull request open-telemetry#97 from open-telemetry/main

e91954c

merged from upstream


		Any Approver / Maintainer can merge the PR once it is ready to merge.

		## Build and Run Code Examples


		### Code Examples

		* Follow the [simple trace example](https://github.com/open-telemetry/opentelemetry-cpp/pull/92) for an introduction to basic Open Telemetry functionality in C++. Currently the example can be found in [PR #94](https://github.com/open-telemetry/opentelemetry-cpp/pull/94)

Conversation

HudsonHumphries commented May 29, 2020

Uh oh!

pyohannes left a comment

Choose a reason for hiding this comment

Uh oh!

reyang commented May 30, 2020

Uh oh!

HudsonHumphries commented Jun 2, 2020

Uh oh!

g-easy Jun 3, 2020

Choose a reason for hiding this comment

Uh oh!

HudsonHumphries Jun 3, 2020

Choose a reason for hiding this comment

Uh oh!

HudsonHumphries commented Jun 3, 2020

Uh oh!

reyang Jun 5, 2020

Choose a reason for hiding this comment

Uh oh!

reyang Jun 5, 2020

Choose a reason for hiding this comment

Uh oh!

reyang left a comment

Choose a reason for hiding this comment

Uh oh!

linux-foundation-easycla bot commented Jun 5, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pyohannes Jun 5, 2020

Choose a reason for hiding this comment

Uh oh!

HudsonHumphries Jun 5, 2020

Choose a reason for hiding this comment

Uh oh!

reyang commented Jun 8, 2020

Uh oh!

HudsonHumphries commented Jun 9, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

linux-foundation-easycla bot commented Jun 5, 2020 •

edited

Loading