Fix typo in throttle_decision_endpoints - change 'Tall' to 'all'#10719
Fix typo in throttle_decision_endpoints - change 'Tall' to 'all'#10719Siddiha wants to merge 1 commit intowso2:master-backupfrom
Conversation
WalkthroughA documentation file was updated with a hostname typo correction ("Tall-in-one-2-host" to "all-in-one-2-host") in the throttle decision endpoints configuration and code block fence formatting adjustments from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. 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
🤖 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/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-simple-scalable-setup.md`:
- Around line 755-757: The fenced code block using ```bash contains Windows .bat
commands (cd <UNIVERSAL-GW_HOME>\bin\ and gateway.bat --run); update those
fences to a Windows-appropriate label (e.g., ```bat or ```cmd) for both
occurrences (the block with "cd <UNIVERSAL-GW_HOME>\bin\" and "gateway.bat
--run" and the similar block at the later occurrence) so syntax highlighting and
reader expectations match the .bat commands.
- Line 764: Update the heading text that currently reads "Linux/Mac OS" to use
correct capitalization and style by replacing it with "Linux/macOS" (locate the
heading string "Linux/Mac OS" in the document and change it to "Linux/macOS").
- Line 104: Remove the inline "🔥 FIXED: Changed from ..." comment from the TOML
snippet so the throttle_decision_endpoints line contains only the valid TOML
value (i.e., throttle_decision_endpoints = ["tcp://all-in-one-1-host:5672",
"tcp://all-in-one-2-host:5672"]); then move the explanatory note into the
surrounding prose (near the snippet) explaining the corrected host name to avoid
contaminating config examples and breaking strict parsers. Reference the
throttle_decision_endpoints key in the doc when adding the explanatory sentence.
| # Traffic Manager configurations | ||
| [apim.throttling] | ||
| throttle_decision_endpoints = ["tcp://all-in-one-1-host:5672", "tcp://Tall-in-one-2-host:5672"] | ||
| throttle_decision_endpoints = ["tcp://all-in-one-1-host:5672", "tcp://all-in-one-2-host:5672"] # 🔥 FIXED: Changed from "Tall-in-one-2-host" to "all-in-one-2-host" |
There was a problem hiding this comment.
Remove the inline “🔥 FIXED” note from the TOML snippet.
That comment is likely to be copied into real configs and can cause confusion or validation failures in strict parsers. Consider moving the explanation to surrounding prose instead.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/docs/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-simple-scalable-setup.md`
at line 104, Remove the inline "🔥 FIXED: Changed from ..." comment from the
TOML snippet so the throttle_decision_endpoints line contains only the valid
TOML value (i.e., throttle_decision_endpoints = ["tcp://all-in-one-1-host:5672",
"tcp://all-in-one-2-host:5672"]); then move the explanatory note into the
surrounding prose (near the snippet) explaining the corrected host name to avoid
contaminating config examples and breaking strict parsers. Reference the
throttle_decision_endpoints key in the doc when adding the explanatory sentence.
| ```bash | ||
| cd <UNIVERSAL-GW_HOME>\bin\ | ||
| gateway.bat --run |
There was a problem hiding this comment.
Use a Windows-appropriate fence or label for .bat commands.
These blocks are Windows commands but fenced as bash, which is misleading for readers and syntax highlighting. Consider bat, cmd, or powershell fences.
Also applies to: 771-773
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/docs/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-simple-scalable-setup.md`
around lines 755 - 757, The fenced code block using ```bash contains Windows
.bat commands (cd <UNIVERSAL-GW_HOME>\bin\ and gateway.bat --run); update those
fences to a Windows-appropriate label (e.g., ```bat or ```cmd) for both
occurrences (the block with "cd <UNIVERSAL-GW_HOME>\bin\" and "gateway.bat
--run" and the similar block at the later occurrence) so syntax highlighting and
reader expectations match the .bat commands.
|
|
||
| Open a terminal, navigate to the `<APIM_HOME>/bin` folder, and execute the following command: | ||
|
|
||
| === "Linux/Mac OS" |
There was a problem hiding this comment.
Use “macOS” capitalization.
Prefer “Linux/macOS” instead of “Linux/Mac OS”.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~764-~764: The operating system from Apple is written “macOS”
Context: ... the following command: === "Linux/Mac OS" ```bash cd <APIM_HOME>...
(MAC_OS)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/docs/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-simple-scalable-setup.md`
at line 764, Update the heading text that currently reads "Linux/Mac OS" to use
correct capitalization and style by replacing it with "Linux/macOS" (locate the
heading string "Linux/Mac OS" in the document and change it to "Linux/macOS").
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