Split deployment gates setup into JIT and preconfigured pages#37364
Split deployment gates setup into JIT and preconfigured pages#37364GabrielAnca wants to merge 2 commits into
Conversation
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
|
Preview links (active after the
|
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
/review |
|
Created a DOCS card for an editorial review. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
🤖 Automated review by Claude. AI-generated; verify before acting.
Nice restructure — the JIT vs preconfigured split is much clearer than a single page trying to cover both. A few specific notes inline: one typo in an example UUID, one style nit, and one minor consistency issue with an unpinned image tag.
Reviewed 110b0359fde269068efc09658f2fa241f326f19f — workflow run
|
|
||
| You can use different modes across different gates if needed. | ||
|
|
||
| If you're unsure where to start, or you want to get started quickly, use JIT. |
There was a problem hiding this comment.
Style: quickly is on the Vale filler-word list. The "unsure where to start" clause already conveys the same idea.
| If you're unsure where to start, or you want to get started quickly, use JIT. | |
| If you're unsure where to start, use JIT. |
| "attributes": { | ||
| "dry_run": false, | ||
| "evaluation_id": "e9d2f04f-4f4b-494b-86e5-52f03e10c8e9", | ||
| "evaluation_url": "https://app.datadoghq.com/ci/deployment-gates/evaluations?index=cdgates&query=level%3Agate+%40evaluation_id%3Ae9d2f14f-4f4b-494b-86e5-52f03e10c8e9", |
There was a problem hiding this comment.
Issue: The evaluation_id embedded in evaluation_url (e9d2f14f-...) does not match the evaluation_id field above it (e9d2f04f-...). Looks like a one-character typo in the example.
| "evaluation_url": "https://app.datadoghq.com/ci/deployment-gates/evaluations?index=cdgates&query=level%3Agate+%40evaluation_id%3Ae9d2f14f-4f4b-494b-86e5-52f03e10c8e9", | |
| "evaluation_url": "https://app.datadoghq.com/ci/deployment-gates/evaluations?index=cdgates&query=level%3Agate+%40evaluation_id%3Ae9d2f04f-4f4b-494b-86e5-52f03e10c8e9", |
| restartPolicy: Never | ||
| containers: | ||
| - name: datadog-check | ||
| image: datadog/ci:latest |
There was a problem hiding this comment.
Suggestion: The page tells readers to use a datadog-ci version that supports --config (line 202), but this example pins to datadog/ci:latest, which makes it ambiguous which version a reader actually runs. Pin to a specific tag known to support --config so the example stays consistent with the version guidance above.
2 participants
What does this PR do? What is the motivation?
Splits Deployment Gates setup into two dedicated pages — JIT and preconfigured — instead of mixing both modes on a single page. Each setup page describes only the workflow for its mode (creation steps, integration tabs, dry-run guidance), and the existing
/deployment_gates/setup/URL becomes a short landing page that helps readers choose between the two modes.The menu adds two children under Setup (JIT and Preconfigured); the existing setup URL is preserved.
This is an alternative to #37327, which keeps both modes on the same page with JIT-first ordering.
Merge instructions
Merge readiness:
Additional notes
TODO before merge — update version numbers once the supporting PRs land:
datadog-ci--configflag: Add config file support to deployment gate command datadog-ci#2339deployment-gate-github-actionconfiginput: Add config input to deployment gate action deployment-gate-github-action#14Once those merge, replace the placeholder version references in
content/en/deployment_gates/setup/jit.md(CLI release-notes link,datadog/ci:latestimage tag in the Argo example,deployment-gate-github-action@v1major-version pin) with concrete versions.