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

Add a visualization to "Library Instrumentation" page #5355

Closed
svrnm opened this issue Oct 9, 2024 · 6 comments
Closed

Add a visualization to "Library Instrumentation" page #5355

svrnm opened this issue Oct 9, 2024 · 6 comments
Labels
outreachy Issues for Outreachy Participants ux

Comments

@svrnm
Copy link
Member

svrnm commented Oct 9, 2024

It would be great to have a visualization for the Libraries concept page, that talks about natively instrumenting your application (vs instrumentation libraries). The visualization should demonstrate the difference between the two, i.e. while the instrumentation library is something that needs to be added to an application using the instrumented library as an additional dependency, a natively instrumented application encapsulates the opentelemetry api.

Visually it should be aligned existing visualizations, e.g.
opentelemetry.io/img/otel-diagram.svg
opentelemetry.io/docs/collector/img/otel-collector.svg

Special Note for Outreachy Contributors: if you want to work on this issue, please make sure that you have completed the small steps and at least one assigned issue as outlined here: #5290

@svrnm svrnm added good first issue Good for newcomers ux labels Oct 9, 2024
@svrnm svrnm added outreachy Issues for Outreachy Participants and removed good first issue Good for newcomers labels Oct 9, 2024
@DIANAAJAMBO
Copy link
Contributor

@svrnm Can this issue be assigned to me? I did work on something and would love to submit it.

@svrnm
Copy link
Member Author

svrnm commented Oct 22, 2024

@svrnm Can this issue be assigned to me? I did work on something and would love to submit it.

sure, please go ahead and provide a PR for it

@DIANAAJAMBO
Copy link
Contributor

Hello @svrnm,
I tried to create a PR but failed and noticed it is the same PR with #5421. Kindly review it and let me know of any changes. Thank you so much.

@svrnm
Copy link
Member Author

svrnm commented Oct 24, 2024

Hello @svrnm, I tried to create a PR but failed and noticed it is the same PR with #5421. Kindly review it and let me know of any changes. Thank you so much.

We need 2 separate PRs otherwise I can not accept the work on one PR without also merging the work of the other PR. What you need to do for that is the following:

  • Remove the image from the other PR, e.g. move the file out of your working directory and commit that change back
  • Then switch back to the main branch of git (git checkout main) and create a new branch from main (git checkout -B )
  • Add that file into the branch with the new name and create a new PR

@DIANAAJAMBO
Copy link
Contributor

@svrnm I have removed the image and "libraries page" edits from this PR #5421 and created another PR for this issue. #5480

@cartermp
Copy link
Contributor

cartermp commented Nov 3, 2024

Closing as completed by #5480

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
outreachy Issues for Outreachy Participants ux
Projects
Status: Done
Development

No branches or pull requests

3 participants