-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Documentation improvements - Internal Architecture Doc + Package level comments #10068
Documentation improvements - Internal Architecture Doc + Package level comments #10068
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #10068 +/- ##
==========================================
+ Coverage 91.55% 91.87% +0.31%
==========================================
Files 360 356 -4
Lines 16693 16865 +172
==========================================
+ Hits 15284 15495 +211
+ Misses 1073 1031 -42
- Partials 336 339 +3 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
#### Documentation I wrote comments on a bunch of important functions that helped me understand how the collector works. I also created some other documentation in #10068 - but split it up from this PR.
Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
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 for adding this, it's great to have docs like these. Overall looks good to me.
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.
Looks good, mostly just some minor nits 👍
b2f63fe
to
28dd01e
Compare
Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
28dd01e
to
e16f0fd
Compare
…y#10029) #### Documentation I wrote comments on a bunch of important functions that helped me understand how the collector works. I also created some other documentation in open-telemetry#10068 - but split it up from this PR.
…l comments (open-telemetry#10068) <!--Describe the documentation added.--> #### Documentation Creates an internal architecture file. In it is a diagram of the startup flow of the collector as well as links to key files / packages. I also added package level comments to some key packages. I wrote some other documentation in open-telemetry#10029 but split the PRs up. --------- Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
Documentation
Creates an internal architecture file. In it is a diagram of the startup flow of the collector as well as links to key files / packages. I also added package level comments to some key packages.
I wrote some other documentation in #10029 but split the PRs up.