Skip to content

Fix formatting and typos in deployment documentation#10720

Open
Siddiha wants to merge 335 commits intowso2:masterfrom
Siddiha:patch-2
Open

Fix formatting and typos in deployment documentation#10720
Siddiha wants to merge 335 commits intowso2:masterfrom
Siddiha:patch-2

Conversation

@Siddiha
Copy link
Copy Markdown

@Siddiha Siddiha commented Feb 17, 2026

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation
    • Fixed incorrect endpoint configuration in the All-in-One Gateway High Availability setup guide.
    • Improved formatting and clarity of deployment command instructions across Linux, macOS, and Windows sections for better readability.

ranuka-laksika and others added 30 commits September 11, 2025 09:12
Fix: HTTP Verb and URL Pattern mapping in API Policies documentation [master]
Fix: Remove extra period in remote_tracer.port configuration for Zipkin[master]
…ster

Fix: Broken link in design API overview [master]
…ster

Fix: Correct cURL command for change API provider operation [master]
Fix: Update VCS SET CONFIG PATH documentation example[master]
…nt_update

Update AI Agent to send PR to default branch of the repository and add suggestion fixing capability
…ster-v2

Fix: typos and incorrect instructions in HashiCorp Vault integration …
Fix: Correct local entries configuration syntax [master]
Add a note to clarify behaviour with api level CORS
…ster-v2

Fix: Clarify accepted tokenType values in DevPortal REST API documentation [master]
AayeshaF and others added 23 commits January 19, 2026 00:04
Corrected capitalization of the words "macOS" and "URL" and added a missing comma for readability.
Docs: Fix capitalization and minor grammar in Quick Start guide
…0955645

Fix: Update documentation regarding password prompt behavior when starting API Manager via YAJSW wrapper on Windows [master]
Fix: Update broken OpenSearch artifacts link with relative path
Add Display Name to API Product documentation
Add detailed instructions for role-based API visibility restriction
…ambda-api-doc

Add AWS Lambda connection pooling related configurations
Docs: Add note recommending WSO2 Identity Server (IS) for user management
Update Azure AD configuration doc with notes for synchronization delays
…1905488

Fix: Add warning about removing custom OAuth2 grant types [master]
Improve grammar and clarity in API Manager overview documentation
…-master

Fix: Remove duplicate word in Kubernetes Pattern-0 docs [master]
Prepare docs for API-M 4.7.0 release
Revert "Prepare docs for API-M 4.7.0 release"
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Feb 17, 2026

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 17, 2026

No actionable comments were generated in the recent review. 🎉


Walkthrough

Documentation update correcting a typo in throttle endpoint configuration, updating operating system section headers, and adjusting code block language tags from java to bash/batch for proper syntax highlighting across Linux/macOS and Windows deployment guides.

Changes

Cohort / File(s) Summary
Documentation - Deployment Guide
en/docs/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-simple-scalable-setup.md
Corrected typo in throttle_decision_endpoints config (Tall-in-one-2-host → all-in-one-2-host), updated "Linux/Mac OS" header to "Linux/macOS", changed code block language tags from java to bash/batch for gateway and API Manager start commands, and improved indentation alignment for command blocks across all operating systems.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A typo lurked in the config deep,
With headers needing syntax tweaks to keep,
Bash and batch now shine so bright,
Documentation's format polished just right! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is entirely a template with no actual content filled in by the author - all sections contain only template placeholders and guidance text. Complete the description by filling in at least the critical sections: Purpose, Goals, Approach, and Documentation with relevant details about the formatting and typo fixes made.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: fixing formatting issues (code block language tags, indentation) and correcting a typo in the deployment documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

cd <UNIVERSAL-GW_HOME>\bin\
gateway.bat --run
```
```batch
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
```batch
```bash

@tharikaGitHub
Copy link
Copy Markdown
Member

tharikaGitHub commented Feb 19, 2026

Hi @Siddiha let's open this PR in master branch. Not master-backup. I have changed the base to master. Will you be able to resolve the conflicts and update the PR?

@tharikaGitHub tharikaGitHub changed the base branch from master-backup to master February 19, 2026 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.