Skip to content

Fix typos, grammar, and outdated references in deployment guides#6240

Open
SihanUdayaratna03 wants to merge 1 commit into
wso2:masterfrom
SihanUdayaratna03:fix/deployment-config-typos
Open

Fix typos, grammar, and outdated references in deployment guides#6240
SihanUdayaratna03 wants to merge 1 commit into
wso2:masterfrom
SihanUdayaratna03:fix/deployment-config-typos

Conversation

@SihanUdayaratna03

Copy link
Copy Markdown

Purpose

This PR fixes several minor typos, grammar issues, and outdated references across the deployment and configuration guides:

  1. configure-hazelcast.md: Corrected description to say log4j2 to match the actual configuration block.
  2. configure-tls-termination.md: Removed incorrect hyphen from "no longer".
  3. front-with-the-nginx-load-balancer.md: Removed a stray > character that was making a URL malformed.
  4. token-persistence.md: Removed an outdated version reference ("5.9.0 onwards") from the 7.1.0 documentation.
  5. backup-and-recovery-recommendations.md: Fixed product name capitalization and grammar.

Related PRs

None

Test environment

N/A (Documentation change only)

Security checks

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 18fb7a2b-b52c-4ea6-9b29-8b0cd88bd5d7

📥 Commits

Reviewing files that changed from the base of the PR and between 4865946 and 059ff60.

📒 Files selected for processing (5)
  • en/identity-server/7.1.0/docs/deploy/backup-and-recovery-recommendations.md
  • en/identity-server/7.1.0/docs/deploy/configure-hazelcast.md
  • en/identity-server/7.1.0/docs/deploy/configure-tls-termination.md
  • en/identity-server/7.1.0/docs/deploy/front-with-the-nginx-load-balancer.md
  • en/identity-server/7.1.0/docs/deploy/token-persistence.md

📝 Walkthrough

Walkthrough

This PR applies small documentation corrections across five WSO2 Identity Server 7.1.0 deployment guides, including phrasing/capitalization fixes, an updated Hazelcast logging reference (log4j to log4j2), an "Important" note formatting addition, a wording fix, and a URL syntax correction.

Changes

Documentation Fixes

Layer / File(s) Summary
Wording and phrasing corrections
en/identity-server/7.1.0/docs/deploy/backup-and-recovery-recommendations.md, en/identity-server/7.1.0/docs/deploy/configure-tls-termination.md, en/identity-server/7.1.0/docs/deploy/token-persistence.md
Corrected sentence phrasing, capitalization, and added an "Important" note format along with minor wording fix ("no-longer" to "no longer").
Configuration reference and URL corrections
en/identity-server/7.1.0/docs/deploy/configure-hazelcast.md, en/identity-server/7.1.0/docs/deploy/front-with-the-nginx-load-balancer.md
Updated Hazelcast logging reference from log4j to log4j2 with an added clarifying statement, and fixed an extraneous character in an example Nginx URL.

Suggested labels: Team/Identity Server Core

Suggested reviewers: pavinduLakshan, Malith-19

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the PR’s main change: typo, grammar, and outdated reference fixes in deployment guides.
Description check ✅ Passed The description follows the template and includes purpose, related PRs, test environment, and security checks.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Warning

⚠️ This pull request shows signs of AI-generated slop (description_diff_mismatch). It has been flagged by CodeRabbit slop detection and should be reviewed carefully.


!!! note "Synchronous token persistence configurations"
By default synchronous token persistence is enabled in WSO2 Identity Server 5.9.0 onwards. To indicate the number of times to retry in the event of a `CONN_APP_KEY` violation when storing the access token, navigate to file `<IS_HOME>/repository/conf/deployment.toml` and add the following configuration.
By default, synchronous token persistence is enabled in WSO2 Identity Server. To indicate the number of times to retry in the event of a `CONN_APP_KEY` violation when storing the access token, navigate to file `<IS_HOME>/repository/conf/deployment.toml` and add the following configuration.

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.

why did we remove the IS version here?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Thanks for pointing that out @pavinduLakshan, I've restored the "5.9.0 onwards" reference and kept just the comma fix. Please take another look when you get a chance

@Malith-19

Copy link
Copy Markdown
Contributor

Hi @SihanUdayaratna03,
Don't we have similar docs you modified in other IS versions as well. Shall we check as well?

@SihanUdayaratna03

Copy link
Copy Markdown
Author

@Malith-19 Sure, I'll check the other IS versions and raise separate PRs for those

@Malith-19

Copy link
Copy Markdown
Contributor

Hi @SihanUdayaratna03,

Thanks, meanwhile let's fix the lint failures as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants