Skip to content

docs: add onboarding guides with diagrams for QE engineers#4902

Draft
rnetser wants to merge 1 commit into
RedHatQE:mainfrom
rnetser:docs/onboarding-guides
Draft

docs: add onboarding guides with diagrams for QE engineers#4902
rnetser wants to merge 1 commit into
RedHatQE:mainfrom
rnetser:docs/onboarding-guides

Conversation

@rnetser
Copy link
Copy Markdown
Collaborator

@rnetser rnetser commented May 18, 2026

What this PR does / why we need it:

Adds four onboarding documentation guides for new QE engineers joining the team:

  • ONBOARDING.md — Getting started from zero to running first test
  • HOW_IT_WORKS.md — Visual guide to repo architecture with Mermaid diagrams
  • REPO_MAP.md — Directory map, fixture dependency tree, key files reference
  • WRITING_TESTS.md — Step-by-step test writing guide following project conventions

All docs use Mermaid flowcharts that render natively on GitHub.

Which issue(s) this PR fixes:
Special notes for reviewer:

Draft — reviewing for accuracy and completeness. Known items to fix:

  • ONBOARDING.md references non-existent `test_vm_lifecycle.py` path
  • HOW_IT_WORKS.md incorrectly places `VirtualMachineForTests` in `libs/vm/vm.py`
  • HOW_IT_WORKS.md test domains diagram missing `data_protection/`
  • REPO_MAP.md hardcoded line counts will go stale
  • REPO_MAP.md references `.flake8` but project also uses ruff
jira-ticket:

Assisted-by: Claude noreply@anthropic.com

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 7f0f5317-7bbd-45a7-b6f7-439b82b5cdc3

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

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

@codecov
Copy link
Copy Markdown

codecov Bot commented May 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.67%. Comparing base (9b6c72f) to head (fad0791).
⚠️ Report is 45 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #4902   +/-   ##
=======================================
  Coverage   98.67%   98.67%           
=======================================
  Files          25       25           
  Lines        2485     2487    +2     
=======================================
+ Hits         2452     2454    +2     
  Misses         33       33           
Flag Coverage Δ
utilities 98.67% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@openshift-virtualization-qe-bot
Copy link
Copy Markdown

D/S test tox -e verify-tc-requirement-polarion failed: cnv-tests-tox-executor/28090

Add 4 diagram-heavy docs for QE engineers new to the repo:
- ONBOARDING.md: start here, pytest basics, first test run
- HOW_IT_WORKS.md: architecture, fixtures, golden image pattern
- WRITING_TESTS.md: step-by-step cookbook with templates
- REPO_MAP.md: visual guide to find anything in the repo

Assisted-by: Claude <noreply@anthropic.com>
Signed-off-by: rnetser <rnetser@redhat.com>
@openshift-virtualization-qe-bot
Copy link
Copy Markdown

D/S test tox -e verify-tc-requirement-polarion failed: cnv-tests-tox-executor/28091

@rnetser
Copy link
Copy Markdown
Collaborator Author

rnetser commented May 18, 2026

/retest tox

2 similar comments
@rnetser
Copy link
Copy Markdown
Collaborator Author

rnetser commented May 18, 2026

/retest tox

@rnetser
Copy link
Copy Markdown
Collaborator Author

rnetser commented May 18, 2026

/retest tox

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants