Skip to content

Fix step numbering and product names in ELK guides - #6239

Open
SihanUdayaratna03 wants to merge 2 commits into
wso2:masterfrom
SihanUdayaratna03:fix/elk-analytics-guides-clean
Open

Fix step numbering and product names in ELK guides#6239
SihanUdayaratna03 wants to merge 2 commits into
wso2:masterfrom
SihanUdayaratna03:fix/elk-analytics-guides-clean

Conversation

@SihanUdayaratna03

Copy link
Copy Markdown
Contributor

Purpose

This PR fixes formatting and consistency issues across the ELK Analytics deployment guides:

  1. Fixed out-of-order and duplicated step numbers in both guides so they flow sequentially.
  2. Corrected product name capitalization ("Identity server" -> "Identity Server") and replaced hardcoded product names with the {{product_name}} template variable for consistency.

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

📝 Walkthrough

Walkthrough

Changes

The documentation updates refine ELK-based adaptive authentication setup, add an explicit save step, use the product template variable in installation instructions, and reorder Kibana dashboard configuration steps.

ELK Analytics Documentation

Layer / File(s) Summary
Adaptive authentication configuration steps
en/identity-server/7.1.0/docs/deploy/elk-analytics-for-adaptive-authentication.md
Adds instructions for opening the ELK-Risk-Based template settings, configuring properties, clicking Update, and normalizes Identity Server wording.
ELK installation and dashboard steps
en/identity-server/7.1.0/docs/deploy/elk-analytics-installation-guide.md
Replaces hardcoded product text with {{product_name}} and renumbers Kibana index-pattern cleanup, artifact import, and dashboard navigation steps.

Suggested labels: Team/Identity Server Core

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main documentation changes: step numbering fixes and product name normalization in the ELK guides.
Description check ✅ Passed The description matches the required 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.

@pavinduLakshan pavinduLakshan left a comment

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.

Could you please run the doc site locally and add a screenshot of how your change looks? I'm particularly concerned about that product_name placeholder. just wanted to confirm that it renders properly. Thanks in advance!

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In
`@en/identity-server/7.1.0/docs/deploy/elk-analytics-for-adaptive-authentication.md`:
- Line 66: Add a restart step immediately after the existing **Update** step in
the deployment instructions, directing users to restart the relevant server so
the ELK risk-based settings take effect.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: b1974350-9376-4cb4-98ab-fad0d38a0685

📥 Commits

Reviewing files that changed from the base of the PR and between 3637dc9 and 74ac78f.

📒 Files selected for processing (2)
  • en/identity-server/7.1.0/docs/deploy/elk-analytics-for-adaptive-authentication.md
  • en/identity-server/7.1.0/docs/deploy/elk-analytics-installation-guide.md

@SihanUdayaratna03

Copy link
Copy Markdown
Contributor Author
image

Hi @pavinduLakshan,

I ran the doc site locally and attached the screenshots. As shown, the {{product_name}} placeholder renders correctly as "WSO2 Identity Server".

I also fixed the trailing whitespace issue that was causing the Markdown Lint check to fail.

Please let me know if anything else needs to be updated. Thanks!

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.

2 participants