Skip to content

docs: fix Tip typo and broken sample-scenario link in service-hijacking#536

Open
StrikerEureka34 wants to merge 2 commits into
krkn-chaos:mainfrom
StrikerEureka34:fix/service-hijacking-docs
Open

docs: fix Tip typo and broken sample-scenario link in service-hijacking#536
StrikerEureka34 wants to merge 2 commits into
krkn-chaos:mainfrom
StrikerEureka34:fix/service-hijacking-docs

Conversation

@StrikerEureka34

@StrikerEureka34 StrikerEureka34 commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Documentation Update

Related Feature:

N/A - this is a standalone documentation fix on the existing service-hijacking
scenario page (a typo and a broken internal link).

Changes:

Two small fixes on the service-hijacking scenario docs:

  • Krkn-hub "Tip" callout typo: ecauseBecause.
  • Broken "sample scenario file" link in the Krkn-hub and Krknctl tabs. It originally pointed to a non-existent service-hijacking-scenarios-krkn.md and rendered as a dead .md link.

What changed after the recent commit:-

  • That was first patched to an on-page #sample-scenario anchor, but each tab renders as a separate hidden pane (Docsy tabpane), so the anchor still couldn't activate the Krkn tab from the Krkn-hub or Krknctl tab, and the target content stayed hidden.
  • The link now just points readers to the Krkn tab by name, where the "Sample Scenario" section actually lives.

@netlify

netlify Bot commented Jun 21, 2026

Copy link
Copy Markdown

Deploy Preview for krkn-chaos ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit e8bd381
🔍 Latest deploy log https://app.netlify.com/projects/krkn-chaos/deploys/6a54aa220c1c710008f68171
😎 Deploy Preview https://deploy-preview-536--krkn-chaos.netlify.app
📱 Preview on mobile
Toggle QR Code...

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

Copy link
Copy Markdown

PR Summary by Qodo

Docs: fix typo and sample-scenario link in service-hijacking docs
📝 Documentation 🕐 Less than 5 minutes

Grey Divider

Description

• Fix typo in krkn-hub “Tip” callout for service-hijacking scenario.
• Repair broken “sample scenario file” link in krkn-hub and krknctl tabs.
High-Level Assessment

The following are alternative approaches to this PR:

1. Use Hugo/MkDocs ref-style link helpers (e.g., relref/ref)
  • ➕ Avoids fragile hardcoded paths/filenames when docs are moved/renamed
  • ➕ Typically validated by the docs build pipeline (depending on tooling)
  • ➖ May require adopting/standardizing link helper usage across docs
  • ➖ Still needs correct anchor/heading targeting to avoid drift
2. Restore/create the previously linked file path
  • ➕ Keeps the original link structure intact
  • ➕ Can be useful if multiple pages were intended to share that sample
  • ➖ Adds/maintains an extra doc artifact solely to satisfy a link
  • ➖ Higher ongoing maintenance than linking to the canonical section

Recommendation: The PR’s approach (linking directly to the on-page #sample-scenario anchor) is the most maintainable for a single canonical example. If the docs toolchain supports it, consider using ref/relref-style helpers for cross-page links to reduce future breakage when pages move.

Files changed (2) +3 / -3

Documentation (2) +3 / -3
_tab-krkn-hub.mdFix Tip callout typo and point sample link to on-page anchor +2/-2

Fix Tip callout typo and point sample link to on-page anchor

• Corrects a typo in the “Tip” alert text ("ecause" → "Because"). Updates the sample scenario link to target the local “Sample Scenario” section via #sample-scenario instead of a non-existent markdown file.

content/en/docs/scenarios/service-hijacking-scenario/_tab-krkn-hub.md

_tab-krknctl.mdFix broken sample scenario link to use #sample-scenario +1/-1

Fix broken sample scenario link to use #sample-scenario

• Updates the “sample scenario file” link to point to the on-page #sample-scenario anchor rather than a missing service-hijacking-scenarios-krkn.md file.

content/en/docs/scenarios/service-hijacking-scenario/_tab-krknctl.md

@qodo-code-review

qodo-code-review Bot commented Jun 21, 2026

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📜 Skill insights (0)

Context used
✅ Compliance rules (platform): 24 rules

Grey Divider


Remediation recommended

1. Hub sample link hidden ✓ Resolved 🐞 Bug ≡ Correctness
Description
_tab-krkn-hub.md and _tab-krknctl.md now link to #sample-scenario, but the only `Sample
Scenario` heading is inside the Krkn tab pane, so clicking those links from the Krkn-hub or Krknctl
tabs won’t activate the Krkn tab and the target content may remain hidden.
Code

content/en/docs/scenarios/service-hijacking-scenario/_tab-krkn-hub.md[67]

+A sample scenario file can be found [here](#sample-scenario), you'll need to customize it based on your wanted response codes for API calls
Evidence
Both the Krkn-hub and Krknctl tab content include links to #sample-scenario, but the `Sample
Scenario heading (### Sample Scenario) is defined only in the Krkn tab file (_tab-krkn.md`) and
is rendered inside the Krkn tab pane via _index.md. Because the site’s tab activation JavaScript
only switches tabs when the URL hash matches #tab-*/#tabpane-*, navigating to #sample-scenario
does not trigger a tab change, leaving the referenced section potentially unreachable/hidden when
clicked from non-Krkn tabs.

content/en/docs/scenarios/service-hijacking-scenario/_tab-krkn-hub.md[62-69]
content/en/docs/scenarios/service-hijacking-scenario/_tab-krkn.md[1-6]
content/en/docs/scenarios/service-hijacking-scenario/_index.md[44-58]
layouts/partials/hooks/body-end.html[4-46]
content/en/docs/scenarios/service-hijacking-scenario/_tab-krknctl.md[9-17]

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 Krkn-hub and Krknctl tabs link to `#sample-scenario`, but the `Sample Scenario` section exists under the Krkn tab content; since tab switching is hash-driven only for `#tab-*`/`#tabpane-*` patterns, clicking these links from other tabs won’t activate the Krkn tab and users may not be taken to visible content.

## Issue Context
The service-hijacking scenario page is rendered as a tabpane with three tabs (Krkn / Krkn-hub / Krknctl). The `Sample Scenario` heading lives in `_tab-krkn.md` (rendered within the Krkn tab pane via `_index.md`), while the links to `#sample-scenario` are present in `_tab-krkn-hub.md` and `_tab-krknctl.md`.

## Fix Focus Areas
- content/en/docs/scenarios/service-hijacking-scenario/_tab-krkn-hub.md[67-67]
- content/en/docs/scenarios/service-hijacking-scenario/_tab-krknctl.md[15-15]

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


Grey Divider

Qodo Logo

@StrikerEureka34

StrikerEureka34 commented Jul 7, 2026

Copy link
Copy Markdown
Contributor Author

Addressed the bug, can this be reviewed whenever you have a moment.
Thanks! @paigerube14 @ddjain

Note:- Please check the updated issue description for more details.

@github-actions github-actions Bot added the needs-dco Commits are missing a Signed-off-by line label Jul 8, 2026
Signed-off-by: Ayush kumar <nayush2001@gmail.com>
@StrikerEureka34 StrikerEureka34 force-pushed the fix/service-hijacking-docs branch from 8c83bdc to 7f28743 Compare July 8, 2026 16:40
@github-actions github-actions Bot removed the needs-dco Commits are missing a Signed-off-by line label Jul 8, 2026
@github-actions

Copy link
Copy Markdown

Hi @StrikerEureka34! 👋 One or more commits in this PR are missing a Signed-off-by line, which is required by our DCO policy.

Unsigned commits:

  • e8bd381: Merge branch 'main' into fix/service-hijacking-docs

To fix, rebase and sign off all commits:

git rebase HEAD~1 --signoff
git push --force-with-lease

Or, to sign off every commit in this PR at once:

git rebase origin/main --signoff
git push --force-with-lease

Tip: Add -s to future git commit commands (e.g. git commit -s -m "...") to sign off automatically.

Note: Please make sure your PR contains only 1 commit before signing off. If you have multiple commits, squash them first:

git checkout <my-working-branch>
git rebase -i HEAD~<num_of_commits_to_merge>
   -OR-
git rebase -i <commit_id_of_first_change_commit>

In the interactive rebase screen, set the first commit to pick and all others to squash. Then push your rebased commits:

git push origin <my-working-branch> --force-with-lease

See the Squash Commits guide for more details.

The needs-dco label and this comment will be removed automatically once all commits are signed off.

@github-actions github-actions Bot added the needs-dco Commits are missing a Signed-off-by line label Jul 13, 2026

@ddjain ddjain left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

/LGTM

@ddjain

ddjain commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

can you fix the CI ?

@StrikerEureka34

Copy link
Copy Markdown
Contributor Author

can you fix the CI ?

I didn't get which one are you referring to.
CI for the DCO?

@ddjain

ddjain commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Yes, CI for the DCO. I think you need to squash all commit and push forcefully.

`--scenario-file-path` | The absolute path of the scenario file compiled following the documentation |file_base64 | Yes |


A sample scenario file can be found [here](service-hijacking-scenarios-krkn.md#sample-scenario), you'll need to customize it based on your wanted response codes for API calls

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

instead of taking out this link would be good to fix the link to point to here or say see krkn page

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

Labels

needs-dco Commits are missing a Signed-off-by line

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants