-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[Demo] Add info about React Native app #5704
base: main
Are you sure you want to change the base?
[Demo] Add info about React Native app #5704
Conversation
registering trace context propagators, and registering auto-instrumentation of | ||
network requests. | ||
|
||
[Instrumentation source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/reactnativeapp/hooks/useTracer.ts) |
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.
modelled from the Browser Instrumentation section in content/en/docs/demo/services/frontend.md, in that file a code snippet is included directly but given the TODOs in https://github.com/open-telemetry/opentelemetry-demo/blob/b4dc87ebeac93353106ebdbc7d29eb402e49eca8/src/reactnativeapp/hooks/useTracer.ts I thought it might be better to link out here instead, thoughts?
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.
Personally I don't like doc pages that link to code snippets.
But this is my opinion, I'd love to hear what the @open-telemetry/docs-approvers have to say.
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.
Yes, let's not link out, especially to blob/main
which may break at some point because the file was renamed.
Let's have it like on the other pages and keep the source code, we (docs and demo maintainers) can discuss if we can make use of code-excerpts (See https://github.com/open-telemetry/opentelemetry.io/tree/main/tools) for demo source code as well to keep them in sync
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.
sounds good, updated here to include the snippet: e41e5ea
registering trace context propagators, and registering auto-instrumentation of | ||
network requests. | ||
|
||
[Instrumentation source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/reactnativeapp/hooks/useTracer.ts) |
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.
Personally I don't like doc pages that link to code snippets.
But this is my opinion, I'd love to hear what the @open-telemetry/docs-approvers have to say.
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, looks good overall, a few comments
registering trace context propagators, and registering auto-instrumentation of | ||
network requests. | ||
|
||
[Instrumentation source](https://github.com/open-telemetry/opentelemetry-demo/blob/main/src/reactnativeapp/hooks/useTracer.ts) |
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.
Yes, let's not link out, especially to blob/main
which may break at some point because the file was renamed.
Let's have it like on the other pages and keep the source code, we (docs and demo maintainers) can discuss if we can make use of code-excerpts (See https://github.com/open-telemetry/opentelemetry.io/tree/main/tools) for demo source code as well to keep them in sync
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.
As a general comment, I don't think that the app should be documented as a part of the demo/services
. Even the entry in the index page reads, "React Native mobile application that provides a UI on top of the shopping services."
How does it relate to the Collector?
Maybe we need a new Demo top-level entry?
This updates the demo documentation to include the React Native example app that is being added here: open-telemetry/opentelemetry-demo#1781
Keeping in Draft for now as we should hold merging this until those changes are accepted
Preview: https://deploy-preview-5704--opentelemetry.netlify.app/docs/demo/services/react-native-app/