Skip to content

Fix image loading issue in MTLS doc #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DivyaPremanantha wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix image loading issue in MTLS doc #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5651ae3
Fix image issues in MTLS doc
DivyaPremanantha Nov 20, 2025
ab3bc0d
Update choreo gateway to bijira gateway
DivyaPremanantha Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified en/docs/assets/img/authentication-and-authorization/mutual-ssl-authentication.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 9 additions & 9 deletions ...re-communication-between-the-bijira-gateway-and-your-backend-with-mutual-tls.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To establish secure communication between the Bijira Gateway and your backend, y

Mutual TLS authentication involves both the client and server validating each other’s certificates before establishing a connection. The following diagram depicts this scenario:

![Mutual TLS authentication](../assets/img/authentication-and-authorization/mutual-ssl-authentication.png)
![Mutual TLS authentication](../../assets/img/authentication-and-authorization/mutual-ssl-authentication.png)
Copy link

@coderabbitai coderabbitai bot Nov 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 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 -20

Length 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).

Copy link
Contributor

@pubudu538 pubudu538 Nov 21, 2025

Choose a reason for hiding this comment

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

Is it possible to remove the term Choreo Gateway here and have Gateway or Bijira Gateway?

Copy link

@coderabbitai coderabbitai bot Nov 21, 2025

Choose a reason for hiding this comment

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

🧩 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.

Copy link
Contributor Author

@DivyaPremanantha DivyaPremanantha Nov 21, 2025

Choose a reason for hiding this comment

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

Updated the image

Copy link

@coderabbitai coderabbitai bot Nov 21, 2025

Choose a reason for hiding this comment

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

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!


## Configure mutual TLS to establish secure connectivity

Expand Down Expand Up @@ -46,17 +46,17 @@ Follow the step-by-step instructions below depending on how you want to establis
7. Click **Add Client Certificate**.
8. In the **Add Client Certificate Pair** dialog, select **Generate new key pair** and specify a value as the common name for the certificate pair. This value will be used to identify the certificate.

![Generate new key pair](../assets/img/authentication-and-authorization/generate-new-key-pair.png)
![Generate new key pair](../../assets/img/authentication-and-authorization/generate-new-key-pair.png){: style="width:300px"}

9. Optionally, click **Show advanced options** to expand the section and specify appropriate values for each of the fields.
10. Click **Generate**. This generates the certificate and lists it under **Existing Certificates**.
11. Click the more options icon corresponding to the certificate and then click **View and Download**.

![View and download certificate](../assets/img/authentication-and-authorization/view-and-download.png)
![View and download certificate](../../assets/img/authentication-and-authorization/view-and-download.png){: style="width:500px"}

This opens the certificate for you to view and download.

![Certificate details](../assets/img/authentication-and-authorization/certificate-details.png)
![Certificate details](../../assets/img/authentication-and-authorization/certificate-details.png){: style="width:500px"}

12. To download the certificate in PEM format, click **Download**. You can add this certificate as a trusted certificate in the API backend server.

Expand All @@ -74,17 +74,17 @@ Follow the step-by-step instructions below depending on how you want to establis
7. Click **Add Client Certificate**.
8. In the **Add Client Certificate Pair** dialog, select **Use my own key pair**.

![Use own key pair](../assets/img/authentication-and-authorization/use-own-key-pair.png)
![Use own key pair](../../assets/img/authentication-and-authorization/use-own-key-pair.png){: style="width:300px"}

9. Upload the private key and public certificate in PEM format or copy and paste the content of the private key and public certificate.
10. Click **Add**. This generates the certificate and lists it under **Existing Certificates**.
11. Click the more options icon corresponding to the certificate and then click **View and Download**.

![View and download certificate](../assets/img/authentication-and-authorization/view-and-download.png)
![View and download certificate](../../assets/img/authentication-and-authorization/view-and-download.png){: style="width:500px"}

This opens the certificate for you to view and download.
This opens the certificate for you to view and download.
Copy link

@coderabbitai coderabbitai bot Nov 20, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 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 -10

Length 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).


![Certificate details](../assets/img/authentication-and-authorization/certificate-details.png)
![Certificate details](../../assets/img/authentication-and-authorization/certificate-details.png){: style="width:500px"}

12. To download the certificate in PEM format, click **Download**. You can add this certificate as a trusted certificate in the API backend server.

Expand All @@ -97,7 +97,7 @@ To associate a certificate with the API, follow the steps given below:
1. On the **Endpoints** page, go to the **Existing Certificates** section.
2. Select the certificate you want to associate with the API.

![Associate certificate](../assets/img/authentication-and-authorization/associate-certificate.png)
![Associate certificate](../../assets/img/authentication-and-authorization/associate-certificate.png){: style="width:500px"}

3. Click **Save**.

Expand Down