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

Remove concept page 'Data Collection' #2761

Merged
merged 5 commits into from
Jun 8, 2023

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented May 22, 2023

I think that we should remove the following page:

https://opentelemetry.io/docs/concepts/data-collection/

It mostly holds redundant and outdated information:

  • the collector is mentioned in the "Components" page within the concepts
  • Deployment section is not in alignment anymore with Deployment
  • Components is outdated because Connectors are missing, they are explained at other places as well (we might consider moving that to https://opentelemetry.io/docs/concepts/components/#collector)
  • The repo section is not relevant for end users (and also incomplete since we have -releases)

@open-telemetry/collector-approvers PTAL as well


Preview: https://deploy-preview-2761--opentelemetry.netlify.app/docs/

Redirect test:

@svrnm svrnm requested a review from a team as a code owner May 22, 2023 13:10
@svrnm svrnm requested review from a team and jpkrohling and removed request for a team May 22, 2023 13:11
@cartermp
Copy link
Contributor

Yes, I agree it should probably be removed. As a note, it did get ~14k hits last month: https://play.honeycomb.io/opentelemetry-web/datasets/opentelemetry.io/result/H3QyLkcPGYu?useStackedGraphs

So we should set up an appropriate redirect.

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

+1

+1 to the redirect -- either as an alias in the new target file, or a redirect rule
(and the three broken links will need to be addressed)

@svrnm
Copy link
Member Author

svrnm commented May 23, 2023

Redirection is a good point, what would be a good target? https://opentelemetry.io/docs/collector/?

@cartermp
Copy link
Contributor

Yeah, that's about what I'd expect.

@svrnm svrnm requested a review from a team as a code owner June 7, 2023 13:09
@svrnm
Copy link
Member Author

svrnm commented Jun 7, 2023

@chalin @cartermp fixed the redirects, please take another look

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

@svrnm - I'm wondering if it would make more sense to redirect /docs/concepts/data-collection/ to /docs/concepts/components/#collector instead, that way it stays within the Concepts section.

@@ -11,7 +11,7 @@ support multiple [signals](../signals). The reference implementation of
OpenTelemetry is available as:

- [Language-specific instrumentation libraries](../instrumenting)
- [A Collector binary](../data-collection)
- [A Collector binary](/docs/collector)
Copy link
Contributor

Choose a reason for hiding this comment

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

Use canonical path (with trailing /):

Suggested change
- [A Collector binary](/docs/collector)
- [A Collector binary](/docs/collector/)

Copy link
Member

@dmitryax dmitryax left a comment

Choose a reason for hiding this comment

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

LGTM

@cartermp cartermp merged commit e0a8552 into open-telemetry:main Jun 8, 2023
8 checks passed
@chalin
Copy link
Contributor

chalin commented Jun 8, 2023

@svrnm @cartermp - not sure if you missed this comment (#2761 (review)):

@svrnm - I'm wondering if it would make more sense to redirect /docs/concepts/data-collection/ to /docs/concepts/components/#collector instead, that way it stays within the Concepts section.

WDYT?

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.

None yet

4 participants