Skip to content

docs(flaky-tests): document collection-level quarantining settings#563

Draft
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/flaky-tests-collection-quarantine-settings
Draft

docs(flaky-tests): document collection-level quarantining settings#563
samgutentag wants to merge 1 commit intomainfrom
sam-gutentag/flaky-tests-collection-quarantine-settings

Conversation

@samgutentag
Copy link
Copy Markdown
Member

Summary

  • Adds a "Collection-level quarantining settings" subsection to flaky-tests/quarantining.md
  • Documents that Test Collections have their own quarantine settings page that overrides repo-level settings
  • Covers both toggles (Enable Quarantining, Auto-Quarantine), admin-only restriction, and auto-quarantine disable behavior on collection quarantine off

Source

Test plan

  • Preview in GitBook

Test Collections now have their own quarantining settings page that overrides
repo-level quarantine behavior for uploads routed to that collection.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@trunk-staging-io
Copy link
Copy Markdown

Merging to main in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

After your PR is submitted to the merge queue, this comment will be automatically updated with its status. If the PR fails, failure details will also be posted here

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Apr 22, 2026

Claude finished @samgutentag's task in 54s —— View job


Review: Collection-level quarantining settings

  • Read CLAUDE.md (none found)
  • Read changed file and diff
  • Review for typos, grammar, formatting, and documentation best practices

The new subsection is well-written and follows the existing documentation patterns. Here are my findings:

No blocking issues. The content is accurate, clear, and consistently formatted.

Minor observations

  1. Navigation path placeholder formatting (flaky-tests/quarantining.md, line 58):

    navigate to **Flaky Tests** > **Collections** > collection name > **Settings** > **Quarantining**
    

    collection name is the only item in the nav path that isn't bolded. Since it represents a dynamic/variable element, it could be italicized (_collection name_) to visually distinguish it as a placeholder — consistent with how placeholders are typically styled in docs. Very minor. Fix this →

  2. Pre-existing issue (not introduced by this PR): The repo-level settings table (line 52) has a trailing empty row <tr><td></td><td></td></tr>. The new collection-level table correctly omits this — good catch.

What looks good

  • Heading level (####) is consistent with the sibling #### Quarantining settings section
  • The {% hint style="info" %} block is appropriately used for the admin-only restriction callout
  • The disable behavior note at the end is clear and actionable
  • Bold formatting on UI navigation elements is consistent throughout
  • The em dash () in the final paragraph is used correctly

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto-approved: Claude code review passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants