Add Solance event integration use case documentation#246
Open
Sachindu-Nethmin wants to merge 10 commits intowso2:mainfrom
Open
Add Solance event integration use case documentation#246Sachindu-Nethmin wants to merge 10 commits intowso2:mainfrom
Sachindu-Nethmin wants to merge 10 commits intowso2:mainfrom
Conversation
…ith Solace event integration.
Sachindu-Nethmin
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughAdds a new comprehensive guide documenting how to build an e-commerce order notification service using Solace Event Integration with WSO2 Integrator, and adds a navigation entry in the mkdocs configuration to surface the guide. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 11
🤖 Fix all issues with AI agents
In
`@en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`:
- Around line 131-136: The doc uses quoted UI labels; replace the quoted labels
with bold formatting and remove the quotes — update "Access Control", "Client
Usernames", "+ Client Username", "Change Password", and "Apply" to **Access
Control**, **Client Usernames**, **+ Client Username**, **Change Password**, and
**Apply** respectively in the step list (look for these exact strings in the
step block and swap quoting for bold per the guideline).
- Line 82: Replace the non-descriptive link text "here" with a descriptive
phrase like "Message VPNs documentation" in the markdown list item that mentions
Message VPN (the line containing "**Message VPN:** `ecommerce-vpn`" and the
inline link). Update the link target so the markdown reads something like
"(Learn more about message VPNs in the Message VPNs documentation)" or similar,
keeping the existing URL but replacing the link text to be descriptive.
- Around line 40-41: Replace the raw URLs on the two lines with descriptive
Markdown link text: convert
"https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm"
to a link labeled like "Solace Broker container setup" and convert
"https://console.solace.cloud/" to a link labeled like "Solace PubSub+ Cloud
(free tier)"; update the text in the same sentences so readers see descriptive
labels instead of bare URLs (target the lines containing the two raw URLs shown
in the diff).
- Around line 91-92: Update the UI labels on lines referencing "Change Vpn" and
"+ Message VPN": change "Change Vpn" to use the all‑caps acronym "VPN" and wrap
both UI labels/button names in bold formatting (i.e., replace Change Vpn with
**Change VPN** and + Message VPN with **+ Message VPN**) so they follow the
documentation guideline of bolding UI labels.
- Line 111: The document contains a broken reference-style image tag
`![][image3]` with no `[image3]: ...` definition; fix it by either replacing
`![][image3]` with an inline image markdown `` pointing to the correct
screenshot file, or add a reference definition near the bottom of the document
like `[image3]: /assets/path/actual-filename.png` and ensure the filename/path
matches the repository asset name.
- Around line 480-485: The JSON example in the statusDetails object uses the
string "null" for carrier and trackingNumber which is misleading; change
"carrier": "null" and "trackingNumber": "null" to real JSON null values
(carrier: null, trackingNumber: null) inside the statusDetails example, or if
the string values are intentional because they mirror an upstream format, add a
brief inline note next to the statusDetails example stating that those fields
are literal strings from the upstream system rather than JSON nulls so readers
aren’t confused.
- Line 457: The documentation uses special symbols for equality/inequality in
the example sentence that reads about consuming from `fulfillment.orders.status`
and publishing to `fulfillment.orders.notification` (it currently shows
`previousStatus` (`ORDER_CONFIRMED`) ≠ `newStatus` (`ORDER_SHIPPED`) and
elsewhere a bare `=`); update these occurrences to plain English (e.g.,
"previousStatus (ORDER_CONFIRMED) is not equal to newStatus (ORDER_SHIPPED)" and
"previousStatus equals newStatus") so the text avoids decorative/special symbols
while preserving the original meaning and identifiers.
- Around line 76-89: The document uses h4 (####) for all step headings under the
h2 sections "Part 1: Configuring the Solace broker", "Part 2", and "Part 3",
which breaks heading hierarchy and accessibility; update each step heading such
as "Step 1: Create a message VPN" and other sub-headings currently using "####"
to "###" so they are proper children of the h2 Part headings, and additionally
change any "Test case" sub-headings currently using "#####" to "####" under Part
3 to restore correct nesting.
- Line 1: The directory name "solance-event-integration" is misspelled—rename
the folder to "solace-event-integration" (both content and assets directories),
update any references in navigation configuration (en/mkdocs.yml nav entries
pointing to en/docs/integration-guides/usecases/solance-event-integration) and
fix all asset links inside the markdown file (references to
en/docs/assets/integration-guides/usecases/solance-event-integration) to the
corrected "solace-event-integration" path so URLs and asset paths remain
consistent.
In `@en/mkdocs.yml`:
- Around line 292-293: The base_path was changed from the production value to a
local dev URL; revert the change by restoring base_path:
https://wso2.github.io/docs-bi (uncomment the original production line) and
remove or keep the http://localhost:8000 entry only in a local/dev-only config,
ensuring the mkdocs.yml base_path points to the production URL (reference the
base_path key in mkdocs.yml).
- Line 113: Update the nav entry in mkdocs.yml that currently references
"integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md"
to use the corrected directory name "solace-event-integration" so the path
becomes
"integration-guides/usecases/solace-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md";
ensure this string exactly matches the corrected directory name used in the
documentation files (update any other nav entries if they contain the same
"solance" typo).
🧹 Nitpick comments (1)
en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md (1)
32-32: Docker port mapping mismatch: host55554maps to container55555.The command maps
-p 55554:55555, meaning the host port is 55554 but the container's SMF port is 55555. Later in the doc,smf://localhost:55554is used consistently, which is correct given this mapping. However, the non-standard host port choice (differing from the container port) could confuse readers. Consider adding a brief inline note explaining why the host port differs, or simply map-p 55555:55555and use port55555throughout for consistency.
Comment on lines
+40
to
+41
| * For detailed setup instructions, see: [https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm) | ||
| * Alternatively, if you prefer not to deploy Solace locally, you can use Solace PubSub+ Cloud (free tier): [https://console.solace.cloud/](https://console.solace.cloud/) |
Contributor
There was a problem hiding this comment.
Use descriptive link text instead of raw URLs.
Per the coding guidelines, raw URLs should be wrapped with descriptive link text. Lines 40 and 41 expose bare URLs.
Proposed fix
-* For detailed setup instructions, see: [https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm)
-* Alternatively, if you prefer not to deploy Solace locally, you can use Solace PubSub+ Cloud (free tier): [https://console.solace.cloud/](https://console.solace.cloud/)
+* For detailed setup instructions, see the [Solace container image setup guide](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm).
+* Alternatively, if you prefer not to deploy Solace locally, you can use [Solace PubSub+ Cloud (free tier)](https://console.solace.cloud/).As per coding guidelines, "Use descriptive link text instead of raw URLs (for example, Azure portal instead of https://portal.azure.com) in documentation".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| * For detailed setup instructions, see: [https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm) | |
| * Alternatively, if you prefer not to deploy Solace locally, you can use Solace PubSub+ Cloud (free tier): [https://console.solace.cloud/](https://console.solace.cloud/) | |
| * For detailed setup instructions, see the [Solace container image setup guide](https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm). | |
| * Alternatively, if you prefer not to deploy Solace locally, you can use [Solace PubSub+ Cloud (free tier)](https://console.solace.cloud/). |
🤖 Prompt for AI Agents
In
`@en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`
around lines 40 - 41, Replace the raw URLs on the two lines with descriptive
Markdown link text: convert
"https://docs.solace.com/Software-Broker/SW-Broker-Set-Up/Containers/Set-Up-Container-Image.htm"
to a link labeled like "Solace Broker container setup" and convert
"https://console.solace.cloud/" to a link labeled like "Solace PubSub+ Cloud
(free tier)"; update the text in the same sentences so readers see descriptive
labels instead of bare URLs (target the lines containing the two raw URLs shown
in the diff).
Comment on lines
+76
to
+89
| ## Part 1: Configuring the Solace broker | ||
|
|
||
| In this section, we'll set up the Solace broker infrastructure needed for our e-commerce order notification service. We'll create a Message VPN to isolate our messaging environment, set up a queue to store order status events, and configure a topic subscription to route messages to that queue. | ||
|
|
||
| #### What we're setting up: | ||
|
|
||
| * **Message VPN:** `ecommerce-vpn` \- isolated messaging environment for our application (Learn more about message VPNs [here](https://docs.solace.com/Get-Started/message-vpn.htm)) | ||
| * **Queue:** `fulfillment.orders.status` \- stores incoming order events. | ||
| * **Topic subscription:** `ecommerce/orders/*/status` \- routes events to the queue | ||
| * **User credentials:** for secure access to the broker | ||
|
|
||
| Access the Web UI of Solace Software Event Broker, usually available at [http://localhost:8080](http://localhost:8080), and then follow these steps to configure your broker. | ||
|
|
||
| #### Step 1: Create a message VPN |
Contributor
There was a problem hiding this comment.
Heading levels skip from ## (h2) to #### (h4), violating heading hierarchy.
All sub-headings under "Part 1" (lines 80, 89, 113, 129, 148, 164, 180) use #### (h4) but should be ### (h3) since their parent is ## (h2). The same pattern applies under "Part 2" (line 216+) and "Part 3" (line 351+). This also breaks accessibility for screen readers navigating by heading level.
Proposed fix (apply throughout the file)
-#### What we're setting up:
+### What we're setting up
-#### Step 1: Create a message VPN
+### Step 1: Create a message VPNApply the same #### → ### change to all step headings under each ## Part section, and ##### → #### for "Test case" sub-headings under Part 3.
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 80-80: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
[warning] 82-82: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In
`@en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`
around lines 76 - 89, The document uses h4 (####) for all step headings under
the h2 sections "Part 1: Configuring the Solace broker", "Part 2", and "Part 3",
which breaks heading hierarchy and accessibility; update each step heading such
as "Step 1: Create a message VPN" and other sub-headings currently using "####"
to "###" so they are proper children of the h2 Part headings, and additionally
change any "Test case" sub-headings currently using "#####" to "####" under Part
3 to restore correct nesting.
|
|
||
| #### What we're setting up: | ||
|
|
||
| * **Message VPN:** `ecommerce-vpn` \- isolated messaging environment for our application (Learn more about message VPNs [here](https://docs.solace.com/Get-Started/message-vpn.htm)) |
Contributor
There was a problem hiding this comment.
Non-descriptive link text "here".
Proposed fix
-* **Message VPN:** `ecommerce-vpn` \- isolated messaging environment for our application (Learn more about message VPNs [here](https://docs.solace.com/Get-Started/message-vpn.htm))
+* **Message VPN:** `ecommerce-vpn` \- isolated messaging environment for our application. Learn more about [Solace message VPNs](https://docs.solace.com/Get-Started/message-vpn.htm).As per coding guidelines, "Use descriptive link text instead of raw URLs".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| * **Message VPN:** `ecommerce-vpn` \- isolated messaging environment for our application (Learn more about message VPNs [here](https://docs.solace.com/Get-Started/message-vpn.htm)) | |
| * **Message VPN:** `ecommerce-vpn` \- isolated messaging environment for our application. Learn more about [Solace message VPNs](https://docs.solace.com/Get-Started/message-vpn.htm). |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 82-82: Link text should be descriptive
(MD059, descriptive-link-text)
🤖 Prompt for AI Agents
In
`@en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`
at line 82, Replace the non-descriptive link text "here" with a descriptive
phrase like "Message VPNs documentation" in the markdown list item that mentions
Message VPN (the line containing "**Message VPN:** `ecommerce-vpn`" and the
inline link). Update the link target so the markdown reads something like
"(Learn more about message VPNs in the Message VPNs documentation)" or similar,
keeping the existing URL but replacing the link text to be descriptive.
Comment on lines
+91
to
+92
| 1. Click Change Vpn from the side panel. | ||
| 2. Click \+ Message VPN. |
Contributor
There was a problem hiding this comment.
Bold UI labels for consistency.
Per the guidelines, UI labels and button names should be in bold. "Change Vpn" and "+ Message VPN" on lines 91–92 are not bolded. Additionally, "Vpn" should likely be "VPN" (all caps acronym).
Proposed fix
-1. Click Change Vpn from the side panel.
-2. Click \+ Message VPN.
+1. Click **Change VPN** from the side panel.
+2. Click **+ Message VPN**.As per coding guidelines, "Enclose UI labels and button names in bold (for example, Create) in documentation".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| 1. Click Change Vpn from the side panel. | |
| 2. Click \+ Message VPN. | |
| 1. Click **Change VPN** from the side panel. | |
| 2. Click **+ Message VPN**. |
🤖 Prompt for AI Agents
In
`@en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`
around lines 91 - 92, Update the UI labels on lines referencing "Change Vpn" and
"+ Message VPN": change "Change Vpn" to use the all‑caps acronym "VPN" and wrap
both UI labels/button names in bold formatting (i.e., replace Change Vpn with
**Change VPN** and + Message VPN with **+ Message VPN**) so they follow the
documentation guideline of bolding UI labels.
| 3. Maximum Message Spool Usage: 100MB | ||
| 4. Enabled: On | ||
|
|
||
| ![][image3] |
Contributor
There was a problem hiding this comment.
Broken image reference: ![][image3] is undefined.
This reference-style image link has no corresponding [image3]: ... definition anywhere in the document, so it will render as literal text or a broken image. Either define the reference or replace it with an inline image tag pointing to the correct asset.
-![][image3]
+<div style="text-align: center;">
+ <a href="{{base_path}}/assets/integration-guides/usecases/solance-event-integration/configure-message-vpn.png">
+ <img
+ src="{{base_path}}/assets/integration-guides/usecases/solance-event-integration/configure-message-vpn.png"
+ alt="Message VPN configuration settings"
+ width="80%"
+ />
+ </a>
+</div>Replace the src/href with the actual filename of the missing screenshot.
🤖 Prompt for AI Agents
In
`@en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`
at line 111, The document contains a broken reference-style image tag
`![][image3]` with no `[image3]: ...` definition; fix it by either replacing
`![][image3]` with an inline image markdown `` pointing to the correct
screenshot file, or add a reference definition near the bottom of the document
like `[image3]: /assets/path/actual-filename.png` and ensure the filename/path
matches the repository asset name.
Comment on lines
+131
to
+136
| 1. Navigate to "Access Control" in the VPN settings. | ||
| 2. Click “Client Usernames” in the top bar. | ||
| 3. Click “+ Client Username” and create a new Client Username: `fulfillment-service`. | ||
| 4. Enable the created Client Username. | ||
| 5. Click “Change Password” and set the password to: `fulfillment-pass`. | ||
| 6. Click Apply. |
Contributor
There was a problem hiding this comment.
Wrap UI labels in bold and avoid quoting them.
Navigation items and button labels like "Access Control", "Client Usernames", "+ Client Username", "Change Password", and "Apply" should use bold formatting rather than quotes.
Proposed fix
-1. Navigate to "Access Control" in the VPN settings.
-2. Click "Client Usernames" in the top bar.
-3. Click "+ Client Username" and create a new Client Username: `fulfillment-service`.
-4. Enable the created Client Username.
-5. Click "Change Password" and set the password to: `fulfillment-pass`.
-6. Click Apply.
+1. Navigate to **Access Control** in the VPN settings.
+2. Click **Client Usernames** in the top bar.
+3. Click **+ Client Username** and create a new client username: `fulfillment-service`.
+4. Enable the created client username.
+5. Click **Change Password** and set the password to: `fulfillment-pass`.
+6. Click **Apply**.As per coding guidelines, "Enclose UI labels and button names in bold (for example, Create) in documentation".
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| 1. Navigate to "Access Control" in the VPN settings. | |
| 2. Click “Client Usernames” in the top bar. | |
| 3. Click “+ Client Username” and create a new Client Username: `fulfillment-service`. | |
| 4. Enable the created Client Username. | |
| 5. Click “Change Password” and set the password to: `fulfillment-pass`. | |
| 6. Click Apply. | |
| 1. Navigate to **Access Control** in the VPN settings. | |
| 2. Click **Client Usernames** in the top bar. | |
| 3. Click **+ Client Username** and create a new client username: `fulfillment-service`. | |
| 4. Enable the created client username. | |
| 5. Click **Change Password** and set the password to: `fulfillment-pass`. | |
| 6. Click **Apply**. |
🤖 Prompt for AI Agents
In
`@en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`
around lines 131 - 136, The doc uses quoted UI labels; replace the quoted labels
with bold formatting and remove the quotes — update "Access Control", "Client
Usernames", "+ Client Username", "Change Password", and "Apply" to **Access
Control**, **Client Usernames**, **+ Client Username**, **Change Password**, and
**Apply** respectively in the step list (look for these exact strings in the
step block and swap quoting for bold per the guideline).
| } | ||
| ``` | ||
|
|
||
| **Expected Result:** The message should be consumed from `fulfillment.orders.status` and then published to `fulfillment.orders.notification` because `previousStatus` (`ORDER_CONFIRMED`) ≠ `newStatus` (`ORDER_SHIPPED`). |
Contributor
There was a problem hiding this comment.
Avoid special symbols (≠, =) in body text.
Lines 457 and 489 use ≠ and a bare = to denote inequality/equality. Replace with plain English for clarity and guideline compliance.
Proposed fix
-**Expected Result:** The message should be consumed from `fulfillment.orders.status` and then published to `fulfillment.orders.notification` because `previousStatus` (`ORDER_CONFIRMED`) ≠ `newStatus` (`ORDER_SHIPPED`).
+**Expected Result:** The message should be consumed from `fulfillment.orders.status` and then published to `fulfillment.orders.notification` because `previousStatus` (`ORDER_CONFIRMED`) is not equal to `newStatus` (`ORDER_SHIPPED`).-**Expected Result:** The message should be consumed from `fulfillment.orders.status` but will NOT be published to `fulfillment.orders.notification` because `previousStatus` (`ORDER_CONFIRMED`) \= `newStatus` (`ORDER_CONFIRMED`). The If condition will evaluate to false, and the message producer will not be triggered.
+**Expected Result:** The message should be consumed from `fulfillment.orders.status` but will NOT be published to `fulfillment.orders.notification` because `previousStatus` (`ORDER_CONFIRMED`) equals `newStatus` (`ORDER_CONFIRMED`). The If condition evaluates to false, and the message producer is not triggered.As per coding guidelines, "Do NOT use decorative or special symbols (like ¶, →, ») in headings or text in documentation".
🤖 Prompt for AI Agents
In
`@en/docs/integration-guides/usecases/solance-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`
at line 457, The documentation uses special symbols for equality/inequality in
the example sentence that reads about consuming from `fulfillment.orders.status`
and publishing to `fulfillment.orders.notification` (it currently shows
`previousStatus` (`ORDER_CONFIRMED`) ≠ `newStatus` (`ORDER_SHIPPED`) and
elsewhere a bare `=`); update these occurrences to plain English (e.g.,
"previousStatus (ORDER_CONFIRMED) is not equal to newStatus (ORDER_SHIPPED)" and
"previousStatus equals newStatus") so the text avoids decorative/special symbols
while preserving the original meaning and identifiers.
en/docs/integration-guides/usecases/solace-event-integration/solace-event-integration.md
Show resolved
Hide resolved
- Rename directory 'solance-event-integration' to 'solace-event-integration' to fix typo. - Rename assets directory from 'solance-event-integration' to 'solace-event-integration'. - Update all image and file references in 'building-a-e-commerce-order-notification-service-with-solace-event-integration.md' to use the correct path. - Update navigation link in 'en/mkdocs.yml' to point to the corrected directory.
…vent-integration
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@en/docs/integration-guides/usecases/solace-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`:
- Around line 38-41: The documentation uses raw URLs as visible link text (e.g.,
"http://localhost:8080") which reduces readability and accessibility; update the
three occurrences referenced (the PubSub+ Manager link at the block containing
"http://localhost:8080", the "Solace Broker container setup" link, and the
"Solace PubSub+ Cloud (free tier)" link) to use descriptive link text such as
"Access PubSub+ Manager", "Solace Broker container setup guide", and "Solace
PubSub+ Cloud (free tier)" respectively so the markdown link target remains the
same but the visible text is descriptive and accessible.
- Line 1: Update all document headings to sentence case: for the title "Building
an E-commerce Order Notification Service with Solace Event Integration" and the
other headings noted in the review (the headings at the three flagged
locations), change them from title case to sentence case (capitalize only the
first word and any proper nouns, e.g., "Building an e-commerce order
notification service with Solace event integration"). Ensure every heading
throughout the file follows this rule so capitalization is consistent.
- Around line 113-114: Update the documentation to format all UI labels and
button names in bold (e.g., change plain/inline code tokens like Create, Message
VPNs, ecommerce-vpn, Queues, Subscriptions, Connect, Save to **Create**,
**Message VPNs**, **ecommerce-vpn**, **Queues**, **Subscriptions**, **Connect**,
**Save**). Search the file for these UI tokens and the ranges noted (around the
occurrences at lines referenced) and replace plain text or backticked tokens
with bolded tokens so all UI controls are consistently styled across the
document.
- Around line 76-80: The "What we're setting up:" heading under "Part 1:
Configuring the Solace broker" drops from a level-2 (##) to level-4 (####),
violating heading hierarchy (MD001); change that subheading to level-3 (### What
we're setting up:) so it sits directly under "Part 1: Configuring the Solace
broker" and preserves proper document structure per the Microsoft Style Guide.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (20)
en/docs/assets/integration-guides/usecases/solace-event-integration/add-conditional-logic.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/add-log-info-node.pngis excluded by!**/*.pngen/docs/assets/integration-guides/usecases/solace-event-integration/add-onmessage-handler.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/add-solace-event-artifact.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/add-topic-subscription.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/configure-solace-listener.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/create-client-username.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/create-fulfillment-orders-queue.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/create-integration-project.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/create-message-vpn.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/create-notification-queue.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/create-solace-producer.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/final-business-logic-test.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/map-payload.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/publish-test-event-try-me.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/run-test-integration.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/save-solace-integration.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/set-default-user-password.gifis excluded by!**/*.gifen/docs/assets/integration-guides/usecases/solace-event-integration/solace-event-integration-architecture.pngis excluded by!**/*.pngen/docs/assets/integration-guides/usecases/solace-event-integration/verify-queued-message.gifis excluded by!**/*.gif
📒 Files selected for processing (2)
en/docs/integration-guides/usecases/solace-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.mden/mkdocs.yml
🚧 Files skipped from review as they are similar to previous changes (1)
- en/mkdocs.yml
| @@ -0,0 +1,513 @@ | |||
| # Building an E-commerce Order Notification Service with Solace Event Integration | |||
Contributor
There was a problem hiding this comment.
Normalize headings to sentence case.
Several headings are title-cased instead of sentence case (for example, Lines 1, 89, 110, 126).
Suggested fix
-# Building an E-commerce Order Notification Service with Solace Event Integration
+# Building an e-commerce order notification service with Solace Event Integration
-### Step 1: Create a message VPN
+### Step 1: Create a message VPN
-### Step 2: Configure default user password
+### Step 2: Configure default user passwordAs per coding guidelines, use sentence case for all headings (capitalize only the first word and proper nouns) in documentation.
Also applies to: 89-89, 110-110, 126-126
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/docs/integration-guides/usecases/solace-event-integration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md`
at line 1, Update all document headings to sentence case: for the title
"Building an E-commerce Order Notification Service with Solace Event
Integration" and the other headings noted in the review (the headings at the
three flagged locations), change them from title case to sentence case
(capitalize only the first word and any proper nouns, e.g., "Building an
e-commerce order notification service with Solace event integration"). Ensure
every heading throughout the file follows this rule so capitalization is
consistent.
en/docs/integration-guides/usecases/solace-event-integration/solace-event-integration.md
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
anupama-pathirage
requested changes
Mar 3, 2026
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
...ntegration/building-a-e-commerce-order-notification-service-with-solace-event-integration.md
Outdated
Show resolved
Hide resolved
anupama-pathirage
requested changes
Mar 3, 2026
Co-authored-by: Anupama Pathirage <anupama@wso2.com>
- Remove bold formatting from non-UI elements (labels, keys, notes) for better readability. - Update UI element references (buttons, tabs, fields) to use bold formatting instead of double quotes, following standard style conventions. - Add link to the official Solace website.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
This PR introduces a new end-to-end integration use case for Solace Event Integration. It provides developers with a step-by-step tutorial on building event-driven notification services using Solace brokers and WSO2 Integrator:BI.
Goals
Approach
The implementation is structured into three logical phases:
Release note
Added a new integration guide: "Building an E-commerce Order Notification Service with Solace Event Integration," covering listener configuration and conditional message production.
Documentation
docs/integration-guides/usecases/solace-event-integration.mdassets/integration-guides/usecases/solance-event-integration/(GIFs and Screenshots)Automation tests
Security checks
Samples
ORDER_SHIPPEDJSON payload included in the guide.Test environment
Learning
Researched Solace SMF protocol connectivity and internal database authentication for client usernames.
Summary by CodeRabbit