Skip to content

Restructure OpenTelemetry Documentation #21749

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

Merged
merged 28 commits into from
Feb 29, 2024
Merged

Conversation

brett0000FF
Copy link
Contributor

@brett0000FF brett0000FF commented Feb 8, 2024

What does this PR do? What is the motivation?

Restructure OpenTelemetry documentation into a more logical structure. This will make it easier for readers to find what they are looking for, and it will improve maintenance of these docs as we continue to add more content.

Jira: https://datadoghq.atlassian.net/browse/DOCS-6974
Brainstorming: FigJam.

Preview: https://docs-staging.datadoghq.com/brett0000FF/otel-reorg/opentelemetry/

  • Added Terms and Concepts page.
  • Split Set up Collector and Exporter into Deployment, Configuration, Management, and Integrations pages.
  • Added Schema and Semantics section that organizes related content.
  • Added Interoperability with Datadog section that organizes related content.
  • New Troubleshooting page.
  • Updated Guides to include resources as well (like the Registry).

Merge instructions

  • Please merge after reviewing

Additional notes

@brett0000FF brett0000FF added the WORK IN PROGRESS No review needed, it's a wip ;) label Feb 8, 2024
@brett0000FF brett0000FF requested review from a team as code owners February 8, 2024 23:37
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Feb 8, 2024
Copy link
Contributor

github-actions bot commented Feb 8, 2024

Preview links (active after the build_preview check completes)

New or renamed files

Removed or renamed files (these should redirect)

Renamed files

Modified Files

@julianocosta89
Copy link
Contributor

Hello @brett0000FF 👋🏽

I think this re-structure is a good start, IMO we are missing some pages in the docs, but we can definitely work on that after this initial PR.

Just one thing that I'd suggest, not sure if it is doable:

In the Data Collection section we go to the page, and we have 2 links to chose from.
Would it be possible to make this page as the final one?
I mean, the user clicks on the Data Collection and it is presented with the differences between the 2 options, focusing on the advantages of each one of them and then 2 tabs explaining each case:

  • OTel Collector
  • Datadog Agent

WDYT?

@brett0000FF
Copy link
Contributor Author

brett0000FF commented Feb 15, 2024

In the Data Collection section we go to the page, and we have 2 links to chose from. Would it be possible to make this page as the final one? I mean, the user clicks on the Data Collection and it is presented with the differences between the 2 options, focusing on the advantages of each one of them and then 2 tabs explaining each case:

  • OTel Collector
  • Datadog Agent

WDYT?

@julianocosta89 - Yeah, I definitely agree with that. I planned to expand on that content to explain the differences, rather than just a simple link. I met with Irene today about this structure, and she's going to suggest some other high-level structure changes. Once we get that sorted out, it'll become more clear where we need to fill in content gaps. Thanks for taking a look!

@github-actions github-actions bot added the Guide Content impacting a guide label Feb 22, 2024
@julianocosta89
Copy link
Contributor

@brett0000FF https://docs-staging.datadoghq.com/brett0000FF/otel-reorg/opentelemetry/interoperability/otlp_delta_temporality/ seems to be failing.

Also, I've mentioned you on the TOC Doc, where I said that we should move Datadog Exporter and OTLP Receiver to Configuration and leave the others in Integrations, as those 2 are not integrations.

@brett0000FF brett0000FF removed the WORK IN PROGRESS No review needed, it's a wip ;) label Feb 28, 2024
@brett0000FF brett0000FF requested a review from ancostas February 28, 2024 20:04
Copy link
Contributor

@julianocosta89 julianocosta89 left a comment

Choose a reason for hiding this comment

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

1 minor suggestion, but LGTM 🚀

Copy link
Contributor

@buraizu buraizu left a comment

Choose a reason for hiding this comment

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

Looks good, approving with some minor feedback!

@brett0000FF brett0000FF merged commit c880ae1 into master Feb 29, 2024
@brett0000FF brett0000FF deleted the brett0000FF/otel-reorg branch February 29, 2024 21:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend Guide Content impacting a guide
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants