Skip to content

Fix broken image links in API Keys doc (4.7.0)#11575

Open
Thilina2468 wants to merge 1 commit into
wso2:4.7.0from
Thilina2468:fix-11557-4.7.0
Open

Fix broken image links in API Keys doc (4.7.0)#11575
Thilina2468 wants to merge 1 commit into
wso2:4.7.0from
Thilina2468:fix-11557-4.7.0

Conversation

@Thilina2468

Copy link
Copy Markdown

Purpose

Resolves #11557 (reported against version 4.7.0). Images on the API Keys documentation page are broken.

Goals

Restore the images on that page without breaking the same content when it is transcluded into secure-apis-using-api-keys.md.

Approach

en/docs/includes/design/generate-api-key.md is built as a standalone mkdocs page (only wip/* is excluded via the exclude plugin in en/mkdocs.yml), in addition to being transcluded into secure-apis-using-api-keys.md via {!includes/design/generate-api-key.md!}. The file hardcoded image links as ../../../../assets/img/... (4 levels up), which is only correct for the transcluded context (built 4 levels deep) and breaks on the standalone page (built 3 levels deep).

Replaced all 8 occurrences with the {{base_path}}/assets/img/... convention already used throughout the rest of the docs, which resolves correctly regardless of nesting depth.

User stories

N/A

Release note

Fixed broken image links on the API Keys documentation page.

Documentation

This PR is the documentation fix itself.

Training

N/A

Certification

N/A - no impact on certification exams.

Marketing

N/A

Automation tests

  • Unit tests: N/A (documentation content change)
  • Integration tests: N/A

Security checks

  • Followed secure coding standards: yes
  • Ran FindSecurityBugs plugin and verified report: N/A (markdown-only change, no code)
  • Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets: yes

Samples

N/A

Related PRs

Companion PR targeting the master branch (same fix).

Migrations (if applicable)

N/A

Test environment

Verified all 8 referenced image files exist under en/docs/assets/img/learn/ on the 4.7.0 branch and that the {{base_path}} pattern is the established convention elsewhere in this repo.

Learning

Traced the mkdocs build config (en/mkdocs.yml) to confirm the includes/ directory is not excluded from the build, which is why this file is served as two separate pages at different depths.

Resolves wso2#11557

The includes/design/generate-api-key.md file is built as a standalone
mkdocs page (only wip/* is excluded in mkdocs.yml) in addition to being
transcluded into secure-apis-using-api-keys.md at a different nesting
depth. Hardcoded ../../../../assets/img/... relative paths only resolve
correctly for the transcluded (deeper) context, breaking the images on
the standalone page. Switched to the {{base_path}}/assets/img/...
convention already used throughout the rest of the docs, which resolves
correctly regardless of nesting depth.
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai

coderabbitai Bot commented Jul 10, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d6822822-67e8-485e-8c4e-b6f0ef595ea5

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants