docs(flaky-tests): resync Test Collections and the migration guide - #362
Merged
Merged
Conversation
Collections now seed five monitors and quarantining, the setup checklist has five steps, monitors and ticketing connections can be brought across from a repository, and the repo-scoped settings routes close once an org is fully migrated. Refreshes openapi-v2.json, which was missing testCases.linkTicket and pullRequests.queueEntryHistoryBatch. Screenshots are outstanding — see TODO-SCREENSHOTS.md. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Corrects the quarantining default (seeded since 2026-09-16, no backfill for older collections, no org-status gate), makes the detection default state column collection-first, streamlines test-collections.mdx, reverts the alt text and the fully-migrated paragraph, and drops the screenshot TODO file. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Embeds the migrate-monitors screenshots, drops the repository note from the detection default-state column, and aligns the quarantining copy with trunk-io/trunk2#6197, which seeds quarantining on only for a fully migrated org. A migrating org's new collections start with it off, so the migration guide's quarantining step returns to enabling it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The earlier pair showed a group header count that did not match its rows. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Docs PR opened: #363 Added a weekly changelog entry summarizing Test Collections migration tools, onboarding polish, permissions changes, and two new v2 API endpoints. |
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.
A week of trunk2 changes (2026-09-14 → 09-21) left the Test Collections instructions and the migration guide stating things the product no longer does. This corrects them, and refreshes the published v2 OpenAPI spec.
Important
Blocked on trunk-io/trunk2#6197. The quarantining copy here describes the behaviour that PR introduces — seeded on only for a fully-migrated org. Merging this first would put the opposite claim in front of every migrating customer. Everything else in the diff is independent; say the word and I'll split the quarantining copy into a follow-up so the rest can ship now.
What was wrong
TICKETING_REVIEWEDjoined (#5907, #5965)Navigation that no longer resolves
Seven pages gave Settings → Repositories → [repository] → … as the only route to a setting. For an org that has fully migrated, the repository name on that page is plain text (#5961), so the route has no first click. The quarantining page, the audit-log section and the three ticketing integration pages now lead with the collection or organization path and keep the repository one as a parenthetical.
The three ticketing pages were the sharpest: none mentioned the organization path at all, while
automatic-ticketing.mdx— the page that documents it — sends readers to them for setup.v2 OpenAPI spec
Straight re-copy of the generated
ts/apps/public-api/openapi-v2.json, last refreshed 2026-09-16. AddstestCases.linkTicket(#6020) andpullRequests.queueEntryHistoryBatch(#6124), 21 missing schemas and 10 changed ones.linkTicketis added to the nav indocs.json.Screenshot
One new image, on the migrate-monitors section. Reviewing the first pair turned up a group header count that did not match its rows; that is fixed in the product and these are the corrected shots.
Getting Started
Step 2 never told a new organization to create a collection or get its ID, then Steps 3 and 4 both sent it to that collection's tabs. Step 4 also still said pass-on-retry was the only thing enabled by default.
Deliberately unchanged
flaky-tests/webhooks/index.mdx,automatic-ticketing.mdx,dashboard.mdx, the CLI reference, and the collection section ofquarantining/index.mdxwere all checked againstmainand are accurate.get-started/multiple-repositories.mdxstill documents the per-repository fork-upload identifier. trunk-io/trunk2#6188–6190 replace it with a per-collection opt-in keyed on the collection's own shortId, but they are drafts — this needs a rewrite when they land, not before.🤖 Generated with Claude Code