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.

Sign up for GitHub

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

Jump to bottom

[cart] document instrumentation #390

Merged
merged 9 commits into from
Oct 5, 2022
Merged

[cart] document instrumentation #390

merged 9 commits into from
Oct 5, 2022

Conversation

puckpuck
Copy link
Contributor

Adds documentation for cart service, focused on instrumentation code.

@puckpuck puckpuck requested a review from a team September 28, 2022 16:20
mic-max
mic-max approved these changes Sep 28, 2022
View reviewed changes
docs/services/cartservice.md Outdated Show resolved Hide resolved
docs/services/cartservice.md Outdated Show resolved Hide resolved
docs/services/cartservice.md Outdated Show resolved Hide resolved
@cartersocha
Copy link
Contributor

@puckpuck what are your thoughts on adding language to the file names / titles?

I feel like a user would prefer to see a language and go directly there rather than consult our architecture for direction

@mviitane
Copy link
Member

I feel like a user would prefer to see a language and go directly there rather than consult our architecture for direction

Seems like a great idea! The language could also be mentioned in the top section of each doc, for example, next to the source code link.

mviitane
mviitane approved these changes Sep 29, 2022
View reviewed changes
Copy link
Member

@mviitane mviitane left a comment

Choose a reason for hiding this comment

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

LGTM

@puckpuck
Copy link
Contributor Author

@puckpuck what are your thoughts on adding language to the file names / titles?

I feel like a user would prefer to see a language and go directly there rather than consult our architecture for direction

I think this is a great idea.

<servicename>_<language>.md make sense for the file names?

I will also add it to the title for each one also. I need to make a few small changes to this PR so will do that here, and submit another one to clean up all the other docs we wrote thus far.

@cartersocha
Copy link
Contributor

Awesome!

cijothomas
cijothomas approved these changes Sep 29, 2022
View reviewed changes
Copy link
Member

@cijothomas cijothomas left a comment

Choose a reason for hiding this comment

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

LGTM. Please do replace auto-instrumentation with instrumentation library.

@cartersocha
Copy link
Contributor

LGTM. Please do replace auto-instrumentation with instrumentation library.

We'll want to update this in all service docs but can wait until we finish adding them

@puckpuck puckpuck merged commit f6ae2d7 into open-telemetry:main Oct 5, 2022
@puckpuck puckpuck deleted the docs-cart branch October 5, 2022 23:54
jmichalak9 pushed a commit to jmichalak9/opentelemetry-demo that referenced this pull request Mar 22, 2024
@puckpuck @cartersocha
[cart] document instrumentation (open-telemetry#390)
3d240bf 
* cart service doc details

* clean up docs

Co-authored-by: Carter Socha <43380952+cartersocha@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mviitane mviitane mviitane approved these changes

@mic-max mic-max mic-max approved these changes

@cijothomas cijothomas cijothomas approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@puckpuck @cartersocha @mviitane @cijothomas @mic-max