Docs: update o11y section #884
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Creates a new directory structure largely based on the planning document. Notably, the majority of the existin content was brought into the `built-in` subdirectory with a new how-to page stubbed out for exporting metrics (which I believe can only be done via self-hosting or Private DDN).
Updates the Basics page and audits existing pages. Much of what we have here is reference documentation and how-to guides or tutorials won't really fit. Paritosh did a great job of providing some learn-by-examples, especially for the `explain` API.
Removes exporting sections until better internal docs are developed. Right now, there's too much ambiguity around which otel image to use, how to configure Prometheus, and JSON snippets needed to help users develop a dashboard immediately. Ideally, the post-sales folks will turn their example — which is present only a branch of an internal repo — into a standalone repoistory with more helpful documentation around how to run this side-by-side to a DDN instance.
Redirects 🔀Hey, @robertjdominguez & @seanparkross — the following redirects will be needed for deployment: |
|
@robertjdominguez Thanks for your PR! I've assigned @robertjdominguez to review it. |
robertjdominguez
changed the title
Deploying ddn-docs with
|
| Latest commit: |
be3d702
|
| Status: | ⚡️ Build in progress... |
seanparkross
approved these changes
Feb 12, 2025
robertjdominguez
deleted the
robdominguez/doc-2261-update-o11y-section
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description 📝
This PR was mean to be more substantial and to include documentation for self-hosted users looking to attach their own APM. However, read the description here for why that's excluded from this PR.
Essentially, that means this is simply a reorganization of existing content with a bit of cleanup.
It should be rubber-stampable with more attention to be paid to it in the next sprint.
Quick Links 🚀
o11y