Skip to content

Docs link#311

Merged
paigerube14 merged 1 commit intokrkn-chaos:mainfrom
paigerube14:docs_link
Feb 26, 2026
Merged

Docs link#311
paigerube14 merged 1 commit intokrkn-chaos:mainfrom
paigerube14:docs_link

Conversation

@paigerube14
Copy link
Collaborator

@paigerube14 paigerube14 commented Feb 26, 2026

User description

Description

Adding proper links for each scenario to the krkn-chaos.dev webstie scenario view

Documentation

  • Is documentation needed for this update?

If checked, a documentation PR must be created and merged in the website repository.

Related Documentation PR (if applicable)


PR Type

Documentation


Description

  • Update documentation links across all scenario README files

  • Replace relative paths and GitHub links with krkn-chaos.dev URLs

  • Add tab anchors (#tab-krkn-hub) to scenario documentation links

  • Standardize documentation reference format across 23 scenario directories


Diagram Walkthrough

flowchart LR
  A["Old Links<br/>GitHub & Relative Paths"] -- "Replace with" --> B["New Links<br/>krkn-chaos.dev URLs"]
  B -- "Add tab anchors" --> C["Standardized<br/>Documentation References"]
Loading

File Walkthrough

Relevant files
Documentation
22 files
README.md
Update application outage doc link                                             
+1/-1     
README.md
Update cerberus documentation link                                             
+1/-1     
README.md
Update chaos recommender doc link                                               
+1/-1     
README.md
Update container scenario doc link                                             
+1/-1     
README.md
Add tab anchor to kubevirt link                                                   
+1/-1     
README.md
Update network chaos doc link                                                       
+1/-1     
README.md
Update CPU hog scenario doc link                                                 
+1/-1     
README.md
Update IO hog scenario doc link                                                   
+1/-1     
README.md
Update memory hog scenario doc link                                           
+1/-1     
README.md
Update node network filter doc link                                           
+1/-1     
README.md
Update bare metal node scenario link                                         
+1/-1     
README.md
Update node scenario doc link                                                       
+1/-1     
README.md
Update pod network chaos doc link                                               
+1/-1     
README.md
Update pod network filter doc link                                             
+1/-1     
README.md
Update pod scenario doc link                                                         
+1/-1     
README.md
Update power outage scenario link                                               
+1/-1     
README.md
Update PVC scenario doc link                                                         
+1/-1     
README.md
Update service disruption doc link                                             
+1/-1     
README.md
Update service hijacking doc link                                               
+1/-1     
README.md
Update SYN flood scenario doc link                                             
+1/-1     
README.md
Update time scenario doc link                                                       
+1/-1     
README.md
Update zone outage scenario link                                                 
+1/-1     

Signed-off-by: Paige Patton <prubenda@redhat.com>
@qodo-code-review
Copy link

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
🟢
Generic: Comprehensive Audit Trails

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Meaningful Naming and Self-Documenting Code

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Robust Error Handling and Edge Case Management

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Error Handling

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Secure Logging Practices

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Generic: Security-First Input Validation and Data Handling

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-code-review
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
High-level
Review inconsistent URL patterns across scenarios

The updated documentation links have inconsistent URL patterns. Some links, like
for 'cerberus' and 'chaos-recommender', are missing the '/scenarios/' path and
'#tab-krkn-hub' anchor, unlike most others. This should be verified to ensure
all links are correct.

Examples:

cerberus/README.md [3]
See [doc](https://krkn-chaos.dev/docs/cerberus/) for how to run and all the variables listed
chaos-recommender/README.md [3]
See [doc](https://krkn-chaos.dev/docs/chaos-recommender/) for how to run and all the variables listed

Solution Walkthrough:

Before:

// In cerberus/README.md
See [doc](https://krkn-chaos.dev/docs/cerberus/) for how to run...

// In chaos-recommender/README.md
See [doc](https://krkn-chaos.dev/docs/chaos-recommender/) for how to run...

// In most other files, e.g., application-outages/README.md
See [doc](https://krkn-chaos.dev/docs/scenarios/application-outage/#tab-krkn-hub) for how to run...

After:

// In cerberus/README.md (example fix)
See [doc](https://krkn-chaos.dev/docs/scenarios/cerberus/#tab-krkn-hub) for how to run...

// In chaos-recommender/README.md (example fix)
See [doc](https://krkn-chaos.dev/docs/scenarios/chaos-recommender/#tab-krkn-hub) for how to run...

// In all other files
// Links should consistently follow the pattern:
// https://krkn-chaos.dev/docs/scenarios/<scenario-name>/#tab-krkn-hub
Suggestion importance[1-10]: 9

__

Why: The suggestion correctly identifies a critical inconsistency in URL patterns across multiple files, which undermines the PR's primary goal of standardization and may result in broken documentation links.

High
  • More

Copy link
Collaborator

@shahsahil264 shahsahil264 left a comment

Choose a reason for hiding this comment

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

/lgtm

@paigerube14 paigerube14 merged commit b97b494 into krkn-chaos:main Feb 26, 2026
3 checks passed
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.

2 participants