WSO2 MI Cluster Setup Guide with corrected links and formatting #1861
Conversation
WalkthroughTwo deployment documentation files are updated with improved clarity, grammar consistency, and URL modernization. Static HTML image tags are converted to Markdown syntax, relative URLs are replaced with external links, terminology is standardized, and workflow steps are expanded for better guidance. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (2)
en/docs/install-and-setup/setup/deployment/devant-deployment.md (2)
28-30: Maintain Markdown consistency in image references.Lines 28-30 contain inline HTML (
<a>tag) alongside Markdown image syntax. For consistency with the rest of the documentation and to align with the Markdown-first approach seen in the relateddeploying-wso2-mi.mdupdates, consider converting this to pure Markdown link syntax.Current:
<a href="https://wso2.com/devant/docs/assets/img/deploy/devant-deploy.gif"> <img src="https://wso2.com/devant/docs/assets/img/deploy/devant-deploy.gif" alt="Deploy on Devant" width="900"> </a>Consider refactoring to:
[](https://wso2.com/devant/docs/assets/img/deploy/devant-deploy.gif)Alternatively, if the documentation framework supports it, use a standard Markdown image with link attributes.
37-39: Refactor repetitive "Click" statements for better flow.Lines 37–39 contain three successive sentences beginning with "Click," which creates a repetitive reading experience. Consider varying the sentence structure to improve readability.
Current:
3. You will have a single resource available **GET /**. Click to expand the resource. 4. Click **Try it out**. 5. Click **Execute**. You will see the response from the backend service as JSON.Suggested refactor:
3. You will have a single resource available **GET /**. Expand it to see the operations. 4. Click **Try it out**. 5. Select **Execute** to trigger the request. You will see the response from the backend service as JSON.Or:
3. Expand the available **GET /** resource. 4. Click **Try it out**. 5. Click **Execute** to see the response from the backend service as JSON.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
en/docs/install-and-setup/setup/deployment/deploying-wso2-mi.md(3 hunks)en/docs/install-and-setup/setup/deployment/devant-deployment.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
en/docs/install-and-setup/setup/deployment/devant-deployment.md
[style] ~39-~39: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...e resource. 4. Click Try it out. 5. Click Execute. You will see the response ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
🔇 Additional comments (3)
en/docs/install-and-setup/setup/deployment/deploying-wso2-mi.md (2)
2-2: Documentation improvements look good.The rewrite to imperative form (line 2), pluralization and terminology consistency (lines 6, 43), and emphasis through formatting (line 130) all enhance clarity and readability. The wording changes from "the integration artifacts in your deployment are stateless" to "Most integration artifacts in your deployment are stateless and do not require coordination when there is more than one server instance running" better aligns with the intent by specifying which artifacts are affected.
Also applies to: 6-6, 43-43, 130-130
8-8: Confirm the image URL is not a placeholder—verify it resolves to a valid WSO2 resource.The Markdown image syntax is structurally correct with appropriate alt text. However, the URL uses
example.com, a reserved domain under RFC 2606 typically used for placeholder examples. If this is intentional (a literal external URL used by WSO2), no action is needed; if it's a placeholder awaiting the actual resource URL, it must be replaced with the correct WSO2-hosted image location.en/docs/install-and-setup/setup/deployment/devant-deployment.md (1)
1-1: Title update improves clarity.The change from "Deploy WSO2 Integrator: MI on Devant" to "Deploy WSO2 Micro Integrator (MI) on Devant" adds clarity by including the full product name with the acronym. This aligns with documentation best practices.
1 participant
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