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] Remove end-user content from security README #12002

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

tiffany76
Copy link
Contributor

Description

The end-user security documentation was moved to the OTel website in open-telemetry/opentelemetry.io#5209 and open-telemetry/opentelemetry.io#5729. This PR removes the end-user content from security-best-practices.md, leaving only the component developer documentation.

Link to tracking issue

Fixes open-telemetry/opentelemetry.io#3479

@tiffany76 tiffany76 requested a review from a team as a code owner January 1, 2025 15:45
@tiffany76 tiffany76 requested a review from evan-bradley January 1, 2025 15:45
Copy link

codecov bot commented Jan 1, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.67%. Comparing base (3dddfc6) to head (913f76e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #12002   +/-   ##
=======================================
  Coverage   91.67%   91.67%           
=======================================
  Files         455      455           
  Lines       24038    24038           
=======================================
  Hits        22037    22037           
  Misses       1629     1629           
  Partials      372      372           

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

[gRPC](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configgrpc)
and
[http](https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/confighttp)
helper functions.

### Safeguards against denial of service attacks
Copy link
Member

Choose a reason for hiding this comment

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

There are a lot of links to this section: https://github.com/search?q=-is%3Afork+https%3A%2F%2Fgithub.com%2Fopen-telemetry%2Fopentelemetry-collector%2Fblob%2Fmain%2Fdocs%2Fsecurity-best-practices.md%23safeguards-against-denial-of-service-attacks&type=code

To have a more graceful transition, I would suggest we keep the heading and just have the section say "see [link on opentelemetry.io] to learn how to safeguard against denial of service attacks".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add OTel Collector Security Best Practices to OTel Docs Site
3 participants