Realign limitations and out of scope template sections

[rnetser]

• The limitations section should logically be next to the feature details; moved to the 1st part of the STP.
  Provides clearer view not only on what the feature is about but also about what is not supported.
• Out of scope - added more example to the metadata section

Summary by CodeRabbit

• Documentation
  • Restructured Known Limitations section with detailed constraints, trade-offs, and examples
  • Added Out of Scope section defining test boundaries, exclusions, and stakeholder sign-off requirements
  • Enhanced clarity on test scope boundaries and responsibility assignments

[coderabbitai]

Walkthrough

The template documentation was restructured to reorganize the Known Limitations section from a standalone section 6 to an integrated section 2, and added a new Out of Scope (Testing Scope Exclusions) section under the Test Plan. Editorial adjustments were made to clarify test scope and boundaries.

Changes

Cohort / File(s)	Summary
Template Restructuring stps/stp-template/stp.md	Reorganized Known Limitations section from standalone section 6 to integrated section 2 with expanded content. Added new Out of Scope (Testing Scope Exclusions) subsection under Test Plan to explicitly document test boundaries and stakeholder sign-off requirements. Includes explanatory notes and example placeholders for limitations and constraints.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: reorganizing limitations and out of scope sections within the template document to improve clarity and structure.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-temlate-limitation

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[openshift-virtualization-qe-bot-5]

Report bugs in Issues

Welcome! 🎉

This pull request will be automatically processed with the following features:

🔄 Automatic Actions

• Reviewer Assignment: Reviewers are automatically assigned based on the OWNERS file in the repository root
• Size Labeling: PR size labels (XS, S, M, L, XL, XXL) are automatically applied based on changes
• Issue Creation: A tracking issue is created for this PR and will be closed when the PR is merged or closed
• Branch Labeling: Branch-specific labels are applied to track the target branch
• Auto-verification: Auto-verified users have their PRs automatically marked as verified
• Labels: Enabled categories: branch, can-be-merged, cherry-pick, has-conflicts, hold, needs-rebase, size, verified, wip

📋 Available Commands

PR Status Management

• /wip - Mark PR as work in progress (adds WIP: prefix to title)
• /wip cancel - Remove work in progress status
• /hold - Block PR merging (approvers only)
• /hold cancel - Unblock PR merging
• /verified - Mark PR as verified
• /verified cancel - Remove verification status
• /reprocess - Trigger complete PR workflow reprocessing (useful if webhook failed or configuration changed)
• /regenerate-welcome - Regenerate this welcome message

Review & Approval

• /lgtm - Approve changes (looks good to me)
• /approve - Approve PR (approvers only)
• /assign-reviewers - Assign reviewers based on OWNERS file
• /assign-reviewer @username - Assign specific reviewer
• /check-can-merge - Check if PR meets merge requirements

Testing & Validation

• /retest tox - Run Python test suite with tox
• /retest all - Run all available tests

Cherry-pick Operations

• /cherry-pick <branch> - Schedule cherry-pick to target branch when PR is merged
  • Multiple branches: /cherry-pick branch1 branch2 branch3

Label Management

• /<label-name> - Add a label to the PR
• /<label-name> cancel - Remove a label from the PR

✅ Merge Requirements

This PR will be automatically approved when the following conditions are met:

1. Approval: /approve from at least one approver
2. LGTM Count: Minimum 2 /lgtm from reviewers
3. Status Checks: All required status checks must pass
4. No Blockers: No WIP, hold, conflict labels
5. Verified: PR must be marked as verified (if verification is enabled)

📊 Review Process

Approvers and Reviewers

Approvers:

• rnetser

Reviewers:

• rnetser

Available Labels

• hold
• verified
• wip
• lgtm
• approve

💡 Tips

• WIP Status: Use /wip when your PR is not ready for review
• Verification: The verified label is automatically removed on each new commit
• Cherry-picking: Cherry-pick labels are processed when the PR is merged
• Permission Levels: Some commands require approver permissions
• Auto-verified Users: Certain users have automatic verification and merge privileges

For more information, please refer to the project documentation or contact the maintainers.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@stps/stp-template/stp.md`:
- Line 61: Fix the grammatical error in the sentence currently reading "The
feature is only supports YYY storage class" in the STP template (line containing
that phrase); replace it with a correct variant such as "The feature only
supports YYY storage class" or "The feature supports only the YYY storage class"
— update the text to one of these forms to correct subject-verb agreement and
word order.
- Line 148: Update the grammatical error in the sentence that currently reads
"This section define the test boundaries; for example: test coverage by other
teams, edge cases, low priority, etc." and change "define" to "defines" so the
sentence reads "This section defines the test boundaries; for example: test
coverage by other teams, edge cases, low priority, etc." to fix the subject-verb
agreement in the stp.md content.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: afda4f94-1dcf-4cff-a284-cc851a1621d7

📥 Commits

Reviewing files that changed from the base of the PR and between ae42e3c and fd13b73.

📒 Files selected for processing (1)

• stps/stp-template/stp.md

[EdDev]

Thank you.

[rnetser]

/approve