Documentation improvements - Internal Architecture Doc + Package level comments #10068
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
ankitpatel96
changed the title
mx-psi
reviewed
May 2, 2024
Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
codeboten
pushed a commit
that referenced
this pull request
May 2, 2024
#### 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.
mx-psi
reviewed
May 6, 2024
Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
mx-psi
reviewed
May 9, 2024
evan-bradley
reviewed
May 9, 2024
crobert-1
reviewed
May 9, 2024
mx-psi
reviewed
May 13, 2024
mx-psi
approved these changes
May 13, 2024
crobert-1
approved these changes
May 13, 2024
TylerHelmuth
approved these changes
May 13, 2024
evan-bradley
approved these changes
May 14, 2024
ankitpatel96
force-pushed
the
internal-architecture-doc
branch
from
b2f63fe
to
28dd01e
Compare
Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
ankitpatel96
force-pushed
the
internal-architecture-doc
branch
from
28dd01e
to
e16f0fd
Compare
6 tasks
andrzej-stencel
pushed a commit
to andrzej-stencel/opentelemetry-collector
that referenced
this pull request
May 27, 2024
…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.
andrzej-stencel
pushed a commit
to andrzej-stencel/opentelemetry-collector
that referenced
this pull request
May 27, 2024
…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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.