docs: clarify pod scenarios using krknctl - docs/pod-scenarios

[hudazaan]

Documentation Update

Related Feature: Pod Scenarios using krknctl

Please include the branch name where you have made changes or added new features/scenario that we need on the website (e.g., krkn/new_scenario) in the title of this PR.

Changes:

• Clarified the krknctl run pod-scenarios command
• Documented the pod-scenario flags shown in the krknctl tab
• Kept the wording aligned with the existing Pod Scenarios docs structure

Fixes issue #84

[netlify]

✅ Deploy Preview for krkn-chaos ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	3293ff9
🔍 Latest deploy log	https://app.netlify.com/projects/krkn-chaos/deploys/6a09df2751ef1000083531ac
😎 Deploy Preview	https://deploy-preview-474--krkn-chaos.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[qodo-code-review]

Review Summary by Qodo

Clarify pod scenarios documentation and improve krknctl command reference

📝 Documentation

Walkthroughs

Description

• Clarified pod scenario command documentation with improved wording
• Reformatted parameter table for better readability and consistency
• Enhanced behavior notes with clearer execution flow explanation
• Created new dedicated page for krknctl pod scenarios documentation

Diagram

flowchart LR
  A["Pod Scenarios Docs"] -->|"Restructure & Clarify"| B["Updated _tab-krknctl.md"]
  A -->|"Create New Page"| C["pod-scenarios-krknctl.md"]
  B -->|"Improved Table Format"| D["Better Parameter Reference"]
  B -->|"Enhanced Behavior Notes"| E["Clearer Execution Flow"]

Loading

File Changes

1. content/en/docs/scenarios/pod-scenario/_tab-krknctl.md 📝 Documentation +16/-16

Clarify and reformat pod scenario parameters table

• Rewrote introductory text to clarify command purpose and parameter usage
• Reformatted parameter table with improved alignment and consistency
• Simplified and clarified parameter descriptions with better examples
• Updated behavior notes to explain pod selection order and failure conditions
• Improved formatting of code examples and help command reference

content/en/docs/scenarios/pod-scenario/_tab-krknctl.md

---

2. content/en/docs/scenarios/pod-scenario/pod-scenarios-krknctl.md 📝 Documentation +14/-0

Create new krknctl pod scenarios documentation page

• Created new documentation page for krknctl pod scenarios
• Added page metadata with title, description, and weight
• Included overview section explaining page purpose
• Added reference link to main Pod Scenarios documentation
• Embedded krknctl tab content using readfile shortcode

content/en/docs/scenarios/pod-scenario/pod-scenarios-krknctl.md

---

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

1. Flag syntax missing colon ✓ Resolved 📎 Requirement gap ≡ Correctness

Description

The usage line documents pod-scenario flags as [--<parameter> <value>], which does not match the
required --<parameter>:<value> format. This can mislead users about the correct flag syntax for
targeting pods and controlling disruption behavior.

Code

content/en/docs/scenarios/pod-scenario/_tab-krknctl.md[2]

krknctl run pod-scenarios [--<parameter> <value>]

Evidence

PR Compliance ID 542697 requires documenting pod-scenario flags using the --<parameter>:<value>
format. The updated usage line in the tab content shows [--<parameter> <value>] (space-separated,
no colon), which violates the required format.

Clarify purpose of --<parameter>:<value> flags for pod scenario targeting and disruption behavior
content/en/docs/scenarios/pod-scenario/_tab-krknctl.md[2-2]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The docs show the optional pod-scenario flags as `[--<parameter> <value>]`, but compliance requires documenting flags in the `--<parameter>:<value>` format.

## Issue Context
This rule exists to keep flag formatting consistent and avoid confusing spacing or value-passing conventions in scenario docs.

## Fix Focus Areas
- content/en/docs/scenarios/pod-scenario/_tab-krknctl.md[1-5]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

[paigerube14]

we can use a space here or colon I think. Think the space is easier to use so lets keep this line as is

[paigerube14]

the pod scenarios documentation for krknctl should be in the tabbed page, I don't think we need a separate page for this here as it seems duplicated

[paigerube14]

lets keep this comment here

[paigerube14]

can we keep the way the recovery monitoring details are worded. I think it helps clarify there could be multiple pods not all ready/running