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

[docs] Clean up internal observability docs #10454

Merged
merged 12 commits into from
Jun 28, 2024

Conversation

tiffany76
Copy link
Contributor

@tiffany76 tiffany76 commented Jun 22, 2024

Description

Now that 4246, 4322, and 4529 have been merged, and the new Internal telemetry and Troubleshooting pages are live, it's time to clean up the underlying Collector repo docs so that the website is the single source of truth.

I've deleted any content that was moved to the website, and linked to the relevant sections where possible. I've consolidated what content remains in the observability.md file and left troubleshooting.md and monitoring.md as stubs that point to the website.

I also searched the Collector repo for cross-references to these files and adjusted links where appropriate.

Note that this PR is blocked by 4731. EDIT: #4731 is merged and no longer a blocker.

Link to tracking issue

Fixes #8886

@tiffany76 tiffany76 requested a review from a team as a code owner June 22, 2024 00:05
@tiffany76
Copy link
Contributor Author

FYI, @mx-psi.

This is my first PR in the Collector repo. Is a changelog entry necessary? Thanks.

Copy link

codecov bot commented Jun 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.40%. Comparing base (227fb82) to head (ff30543).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10454   +/-   ##
=======================================
  Coverage   92.40%   92.40%           
=======================================
  Files         393      393           
  Lines       18584    18584           
=======================================
  Hits        17173    17173           
  Misses       1056     1056           
  Partials      355      355           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tiffany76 tiffany76 changed the title Clean up internal observability docs [docs] Clean up internal observability docs Jun 22, 2024
@mx-psi mx-psi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jun 24, 2024
Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

Thanks!! cc @codeboten

Will wait until end of week before merging this

@mx-psi mx-psi merged commit 2a19d55 into open-telemetry:main Jun 28, 2024
50 checks passed
@github-actions github-actions bot added this to the next release milestone Jun 28, 2024
@tiffany76 tiffany76 deleted the internal-obs-cleanup branch June 28, 2024 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Unify internal observability documentation
2 participants