-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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 docs/design.md #8889
Comments
cc @bogdandrutu @tigrannajaryan @songy23 since you were involved in creating this doc, in case you think it's worth keeping in some form |
I am all in for having this on the website, since those are mostly end-user specific information. We have some of that on the website already, but some details / diagrams could make the existing docs better. @mhausenblas @theletterf please take a look as well |
Agreed with @svrnm! |
+1 to this. The docs/design.md has diagrams that https://opentelemetry.io/docs/collector/configuration does not. I find the diagrams helpful for understanding. |
Filed open-telemetry/opentelemetry.io/issues/3547 to move the diagrams |
Agree with moving this documentation. Do we support Mermaid diagrams or similar in OpenTelemetry.io? I'm tempted to add it to Docsy otherwise. |
Mermaid is supported on opentelemetry.io yes, e.g. https://github.com/open-telemetry/opentelemetry.io/blob/main/content/en/docs/demo/architecture.md |
Specifically, I think this can be a top-level doc under the collector folder, perhaps just called |
+1 to |
Could you assign this issue to me ? |
**Description:**searched both the core and contrib Collector repositories and found that the images are only used in this file. So I think it's safe to remove them as well. **Link to tracking Issue:** fixes #8889
This document was removed by open-telemetry/opentelemetry-collector#8889. A recent [check links run](https://github.com/open-telemetry/opentelemetry-collector-contrib/actions/runs/8558431956/job/23453029359?pr=32172) failed on this link. If we think it would be helpful, we could add links to [configuration](https://opentelemetry.io/docs/collector/configuration/) and [deployment](https://opentelemetry.io/docs/collector/deployment/) documentation, which is some of what this document originally had, from what I understand. However, those pages are easily visible from the `Getting Started` link that's already in this document.
I think we should remove docs/design.md in favor of the docs in opentelemetry.io.
The document is outdated in some regards (connectors), does not receive a lot of traffic (the only page within the top 10 pages by traffic in this repo within
docs/
is the troubleshooting page) and information in this document is already covered on https://opentelemetry.io/docs/collector/configuration and https://opentelemetry.io/docs/collector/deployment.I would like @open-telemetry/docs-approvers to chime in here and give us their opinion.
The text was updated successfully, but these errors were encountered: