Skip to content

[TXP-65] Introduce integration-api-key-picker shortcode for Integration docs#35537

Merged
moreauowen merged 2 commits intomasterfrom
moreauowen/integration-api-key-picker-shortcode
Apr 2, 2026
Merged

[TXP-65] Introduce integration-api-key-picker shortcode for Integration docs#35537
moreauowen merged 2 commits intomasterfrom
moreauowen/integration-api-key-picker-shortcode

Conversation

@moreauowen
Copy link
Copy Markdown
Contributor

@moreauowen moreauowen commented Mar 24, 2026

What does this PR do? What is the motivation?

Right now, Integration modals for webhook integrations have custom Configuration tab implementations in web-ui rather than displaying the standard ## Setup configuration content from the integration docs. This leads to developers having to maintain the instructions in 2 places (integrations docs & web-ui).

We're introducing this shortcode to help 2 things specifically:

  • Web-ui tab content can be auto-generated from docs (shows slightly different content for this shortcode than what's shown on the docs site)
  • Stop instructions from becoming out-of-sync between the integration modal in the app and the content in the docs site

Merge instructions

Merge readiness:

  • Ready for merge

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

  • Used Claude Code for initial draft of this new shortcode

Additional notes

@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Mar 24, 2026
@moreauowen moreauowen changed the title Introduce integration-api-key-picker custom shortcode Introduce integration-api-key-picker shortcode for Integration docs Mar 24, 2026
@moreauowen moreauowen marked this pull request as ready for review March 26, 2026 15:52
@moreauowen moreauowen requested a review from a team as a code owner March 26, 2026 15:52
@moreauowen moreauowen force-pushed the moreauowen/integration-api-key-picker-shortcode branch from 9e45684 to 0f7c86e Compare April 1, 2026 20:18
@moreauowen moreauowen merged commit 2402eee into master Apr 2, 2026
16 checks passed
@moreauowen moreauowen deleted the moreauowen/integration-api-key-picker-shortcode branch April 2, 2026 15:54
@moreauowen moreauowen changed the title Introduce integration-api-key-picker shortcode for Integration docs [TXP-65] Introduce integration-api-key-picker shortcode for Integration docs Apr 2, 2026
StefonSimmons pushed a commit that referenced this pull request Apr 16, 2026
…#35537)

* Introduce integration-api-key-picker custom shortcode for Integration docs

* Use full domain in tile_url
genesor pushed a commit that referenced this pull request Apr 19, 2026
…#35537)

* Introduce integration-api-key-picker custom shortcode for Integration docs

* Use full domain in tile_url
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants