Jen.gilbert/api copy button#37245
Open
jhgilbert wants to merge 6 commits into
Open
Conversation
This comment has been minimized.
This comment has been minimized.
brett0000FF
reviewed
Jun 4, 2026
Contributor
brett0000FF
left a comment
There was a problem hiding this comment.
Thanks for adding this! I think that this should go at the h1 level, right-aligned to the content. When it appears directly under the title, it breaks up the page content and feels more like part of the article body than a page-level utility. Also +1 to shortening the label to Copy page.
Category page:
Endpoint page:
(The endpoint page is a little trickier because the version already occupies that top-right area, but I think placing Copy page near the version is still preferable to placing it under the H1.)
Out of scope for this PR, but longer term it might be nice to align this with our non-API reference pages, where page utilities live in the right rail:
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
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.
What does this PR do? What is the motivation?
Adds a copy button to the generated API docs.
Note that you'll see a CORS error in the network console if you try to use the copy button, and the text copied to the clipboard will be the failover scrape from the HTML, not the actual
.mdtext available atdocs.datadoghq.com. This is expected behavior in staging, because staging doesn't have a plaintext build yet. But you can see that the correct URL is being called, and see that it does exist in prod.Merge instructions
Merge readiness:
For Datadog employees:
Your branch name MUST follow the
<name>/<description>convention and include the forward slash (/). Without this format, your pull request will not pass CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.If your branch doesn't follow this format, rename it or create a new branch and PR.
[6/5/2025] Merge queue has been disabled on the documentation repo. If you have write access to the repo, the PR has been reviewed by a Documentation team member, and all of the required checks have passed, you can use the Squash and Merge button to merge the PR. If you don't have write access, or you need help, reach out in the #documentation channel in Slack.
AI assistance
Additional notes