Fix image loading issue in MTLS doc #117
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the WalkthroughA single documentation file received updates correcting relative image asset paths from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md(4 hunks)
🔇 Additional comments (1)
en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md (1)
49-49: Inline style attributes are consistently applied with appropriate widths.All image embeds now include explicit width constraints using valid Kramdown syntax
{: style="width:XXXpx"}. The width distribution is sensible: 300px for dialog/compact UI elements (lines 49, 77) and 500px for larger detailed views (lines 55, 59, 83, 87, 100). This ensures predictable rendering across different screen sizes.Also applies to: 55-55, 59-59, 77-77, 83-83, 87-87, 100-100
| Mutual TLS authentication involves both the client and server validating each other’s certificates before establishing a connection. The following diagram depicts this scenario: | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
🧩 Analysis chain
Verify the corrected relative path is accurate.
The asset path was updated from ../assets/ to ../../assets/. Given the file's depth at en/docs/develop-api-proxy/authentication-and-authorization/, verify that ../../assets/ correctly resolves to the project's image assets directory.
🏁 Script executed:
#!/bin/bash
# Description: Verify the asset path structure and confirm the corrected path resolves correctly.
# Check if assets directory exists at the expected location
fd -t d "^assets$" en/docs/ --max-depth 1
# List sample image files from the target directory to confirm accessibility
fd "mutual-ssl-authentication" en/docs/
# Show the directory structure around the assets folder
tree -L 2 en/docs/ 2>/dev/null || find en/docs/ -maxdepth 2 -type d | head -20Length of output: 1822
I need to inspect the complete file to verify all the changes mentioned in the review comment, particularly the inline style additions and text anomalies.
---
🏁 Script executed:
```shell
#!/bin/bash
# Retrieve the full file to verify all changes
cat en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md
Length of output: 8426
Fix double-space typo on line 85.
The relative path correction to ../../assets/ is correct and resolves to the proper image directory. The Kramdown inline style syntax is valid. However, line 85 contains a formatting error: "This opens the certificate" has an extra space between "the" and "certificate"—should be "This opens the certificate".
🤖 Prompt for AI Agents
en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md
line 85: remove the extra space between "the" and "certificate" so the sentence
reads "This opens the certificate" (update the markdown file to correct the
typo).
There was a problem hiding this comment.
Is it possible to remove the term Choreo Gateway here and have Gateway or Bijira Gateway?
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for "Choreo Gateway" in the repository
echo "=== Searching for 'Choreo Gateway' occurrences ==="
rg -n "Choreo Gateway" --type=md
echo -e "\n=== Searching for 'Choreo' (case-sensitive) ==="
rg -n "\bChoreo\b" --type=md
Length of output: 2057
@pubudu538 Based on my search of the repository, there are no occurrences of "Choreo Gateway" in the codebase. The file under review (secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md) already consistently uses "Bijira Gateway" throughout the document.
I did find some references to "Choreo" in other contexts across the documentation:
- References to WSO2 Choreo as a product/platform
- Role names like "Choreo Platform Engineer" and "Choreo DevOps"
- "Choreo Developer Portal" in some files
However, none of these are using "Choreo Gateway" - they're all using "Bijira Gateway" where gateway terminology is needed.
Is there a specific instance of "Choreo Gateway" you'd like me to locate and update? Or are you looking to establish this as a general documentation standard? If you can point me to a specific file or location, I can help update it.
There was a problem hiding this comment.
Updated the image
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
| {: style="width:500px"} | ||
| This opens the certificate for you to view and download. | ||
| This opens the certificate for you to view and download. |
There was a problem hiding this comment.
🧩 Analysis chain
Minor text formatting anomaly.
Line 85 contains "the certificate" with an extra space. Confirm whether this is intentional or an unintended artifact from the editing process.
🏁 Script executed:
#!/bin/bash
# Description: Check for double spaces and other formatting anomalies in the updated file.
# Search for double spaces in the file
grep -n " " "en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md" | head -10Length of output: 1332
I need to verify the exact content at line 85 to confirm the double space issue.
---
🏁 Script executed:
```shell
#!/bin/bash
# Display line 85 specifically
sed -n '85p' "en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md"
Length of output: 64
Fix double space in line 85.
Line 85 contains "the certificate" with an extra space. Update to "the certificate".
🤖 Prompt for AI Agents
In
en/docs/develop-api-proxy/authentication-and-authorization/secure-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md
around line 85, there is a double space in the phrase "the certificate"; edit
that line to remove the extra space so it reads "the certificate" (i.e., replace
the two spaces with a single space).
3 participants
Purpose
Goals
Approach
User stories
Release note
Documentation
Training
Certification
Marketing
Automation tests
Security checks
Samples
Related PRs
Migrations (if applicable)
Test environment
Learning
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.