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

Reorganize OTel Documentation #27331

Merged
merged 46 commits into from
Mar 12, 2025
Merged

Reorganize OTel Documentation #27331

merged 46 commits into from
Mar 12, 2025

Conversation

brett0000FF
Copy link
Contributor

@brett0000FF brett0000FF commented Jan 28, 2025

What does this PR do? What is the motivation?

  • More Action-Oriented Top-Level Categories: The new structure organizes content around key user tasks and goals rather than technical concepts. For example, "Send Data to Datadog" and "Instrument Your Applications" replace more abstract categories like "Interoperability with Datadog."
  • Clearer Flow: The content follows a more logical flow, with key setup paths more clearly defined.
  • Better Separation of Core vs Advanced Topics: The structure more clearly separates fundamental setup tasks from advanced features and customizations, helping users focus on essential setup steps before diving into advanced capabilities.
  • More Intuitive Grouping: Related topics are grouped together more logically. For example, all correlation-related content (Logs-Traces, RUM-Traces) is now under "Correlate Data."

FIgJam: https://www.figma.com/board/wW2cAzPkZ5dZ8QcaS8stF1/OpenTelemetry-Docs-Restructure?node-id=2002-104&t=AzCjZzN3F6S30Y6w-1

TODO

  • Include page shortcode for content on /tracing/other_telemetry/connect_logs_and_traces/opentelemetry/
  • Landing page content draft
  • Overview page content drafts
  • Add migration guides section
  • Add new graphics (maybe in a follow up PR). Brand Design is working on new graphics (ETA 2/21).
  • Finalize redirects

Merge instructions

Merge readiness:

  • Ready for merge

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@github-actions github-actions bot added Architecture Everything related to the Doc backend Guide Content impacting a guide labels Jan 28, 2025
Copy link
Contributor

github-actions bot commented Jan 28, 2025

Preview links (active after the build_preview check completes)

New or renamed files

Removed or renamed files (these should redirect)

Renamed files

Modified Files

@github-actions github-actions bot added the Images Images are added/removed with this PR label Feb 21, 2025
Copy link
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

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

Beautiful 🤌

@brett0000FF
Copy link
Contributor Author

Approved by Anna offline.

@brett0000FF
Copy link
Contributor Author

/merge -p urgent

@dd-devflow
Copy link

dd-devflow bot commented Mar 12, 2025

View all feedbacks in Devflow UI.
2025-03-12 17:21:46 UTC ℹ️ Start processing command /merge -p urgent


2025-03-12 17:21:55 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 9m (p90).


2025-03-12 17:22:09 UTCMergeQueue: This merge request is not mergeable, blocked by github

PR can't be merged according to github policy

@brett0000FF brett0000FF merged commit 7615b09 into master Mar 12, 2025
16 of 19 checks passed
@brett0000FF brett0000FF deleted the brett.blue/reorg-otel branch March 12, 2025 17:34
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 editorial review Waiting on a more in-depth review Guide Content impacting a guide Images Images are added/removed with this PR mergequeue-status: rejected
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants