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 docs/design.md #8889

Closed
mx-psi opened this issue Nov 14, 2023 · 10 comments · Fixed by #9797
Closed

[docs] Remove docs/design.md #8889

mx-psi opened this issue Nov 14, 2023 · 10 comments · Fixed by #9797
Assignees
Labels
area:documentation help wanted Good issue for contributors to OpenTelemetry Service to pick up

Comments

@mx-psi
Copy link
Member

mx-psi commented Nov 14, 2023

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.

@mx-psi mx-psi added help wanted Good issue for contributors to OpenTelemetry Service to pick up area:documentation labels Nov 14, 2023
@mx-psi
Copy link
Member Author

mx-psi commented Nov 14, 2023

cc @bogdandrutu @tigrannajaryan @songy23 since you were involved in creating this doc, in case you think it's worth keeping in some form

@svrnm
Copy link
Member

svrnm commented Nov 14, 2023

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

@mhausenblas
Copy link
Member

Agreed with @svrnm!

@tigrannajaryan
Copy link
Member

but some details / diagrams could make the existing docs better.

+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.

@mx-psi
Copy link
Member Author

mx-psi commented Nov 15, 2023

Filed open-telemetry/opentelemetry.io/issues/3547 to move the diagrams

@theletterf
Copy link
Member

Agree with moving this documentation. Do we support Mermaid diagrams or similar in OpenTelemetry.io? I'm tempted to add it to Docsy otherwise.

@svrnm
Copy link
Member

svrnm commented Nov 15, 2023

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

@cartermp
Copy link
Contributor

Specifically, I think this can be a top-level doc under the collector folder, perhaps just called architecture. We can then merge in/remove content either as a part of that PR or later.

@mhausenblas
Copy link
Member

Specifically, I think this can be a top-level doc under the collector folder, perhaps just called architecture. We can then merge in/remove content either as a part of that PR or later.

+1 to docs/collector/architecture and maybe (in terms of left-hand side menu) right before "Building a custom collector"? Also, we should set clear expectations who the target audience is.

@lavishpal
Copy link
Contributor

Could you assign this issue to me ?

mx-psi pushed a commit that referenced this issue Apr 1, 2024
**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
codeboten pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this issue Apr 4, 2024
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation help wanted Good issue for contributors to OpenTelemetry Service to pick up
Projects
None yet
7 participants