[SDCI-2079] Document automatic job retries (Preview) - inline approach#36148
[SDCI-2079] Document automatic job retries (Preview) - inline approach#36148
Conversation
Adds customer-facing documentation for the automatic job retries feature on GitHub Actions and GitLab. The feature is documented inline on each provider's setup page, with a row in the supported features matrix on the pipelines index.
- Replace "hiccups" colloquialism with "failures". - Split long em-dashed sentence in Overview into two sentences. - Replace passive "the retry outcome is reflected" with active. - Replace "configurable maximum" with "maximum number of attempts" since the limit is not customer-tunable today. - Replace "when the failure is determined retriable" with "when the failure is identified as retriable". - Replace quoted "rerun failed jobs" with plain prose (GitHub API call). - Replace awkward "compute minutes consumed by your pipelines" with "GitHub Actions compute usage". - Add missing "as" in "aren't classified retriable" (GitLab section). - Replace em dash with period in access-gating sentence.
Editorial review (post-fix round)The shared prose fixes look good. Remaining issues below; one must-fix is specific to this inline approach. Higher-level
Must fix
Suggestions
Prefer:
Or simply: Compatibility cell prefix — flag rather than fix. Ask docs team for convention. No row in either provider's compatibility table currently uses a status prefix like Link verification
VerdictComment — two must-fix items (Requirements list structure on each provider page), plus polish suggestions. Previous round of fixes addressed the bigger issues well. |
- Collapse Requirements bullet 3 in both sections; redirect readers to
the banner instead of repeating access-request instructions.
- Replace "Genuine code defects are left alone" with "not retried" in
both sections.
- GitLab section: split step 3 into two sentences ("as soon as the job
fails"; retries are dispatched per job).
- GitLab section: split Requirements bullet 2 to separate the SCI
configuration requirement from the GitLab instance support statement,
and drop the redundant second "with".
|
Closing in favor of approach A (hybrid) — #36147. Thanks to everyone who weighed in. |
What does this PR do? What is the motivation?
Fixes SDCI-2079
Adds customer-facing documentation for the automatic job retries feature on GitHub Actions and GitLab. The feature is in Preview.
Approach B — Inline on each provider page. This is one of three variant PRs opened to compare documentation structures.
Changes:
github.md— new inline## Automatic job retriessection with GitHub-specific behavior, and a new row in the Compatibility table linking to the anchor.gitlab.md— new inline## Automatic job retriessection with GitLab smart-retry behavior, and a new row in the Compatibility table linking to the anchor.pipelines/_index.md— new row in the Supported features matrix (no cross-page link; section lives on each provider page).Other approaches in review:
Merge instructions
Merge readiness:
Additional notes
Tone is Preview / private beta; access is gated via Datadog account team. Internal implementation details are intentionally excluded.