Skip to content

Conversation

@wso2-engineering-bot
Copy link

@wso2-engineering-bot wso2-engineering-bot commented Nov 12, 2025

This PR was automatically generated by Claude AI.

  • Issue: Doc Feedback: Misleading instructions in IS custom layout docs product-is#16460
  • Type: Documentation - Incorrect file paths
  • Summary: Fixed misleading instructions in custom layout documentation by correcting the file paths in steps 3.b and 3.c. The paths now correctly reference java/components/login-portal-layouts/layouts and java/apps/authentication-portal/src/main/webapp/extensions/layouts/custom instead of the incorrect paths.
  • Affected Versions: 6.0.0, 6.1.0
  • Verification: mkdocs build completed successfully (strict mode has pre-existing unrelated warnings in the repository)

Changes Made

Version 6.0.0 and 6.1.0

Updated en/identity-server/{version}/docs/references/extend/rebranding/customizable-login-portal.md:

Step 3.a (now 3.1):

  • Changed: <IDENTITY-APPS-HOME>/components/login-portal-layouts/layouts
  • To: <IDENTITY-APPS-HOME>/java/components/login-portal-layouts/layouts

Step 3.b (now 3.2):

  • Changed: Navigate to <IDENTITY-APPS-HOME>/components/login-portal-layouts directory
  • To: Navigate to <IDENTITY-APPS-HOME> directory

Step 3.c (now 3.3):

  • Changed: <IDENTITY-APPS-HOME>/apps/authentication-portal/src/main/webapp/extensions/layouts/custom
  • To: <IDENTITY-APPS-HOME>/java/apps/authentication-portal/src/main/webapp/extensions/layouts/custom

Summary by CodeRabbit

  • Documentation
    • Updated customizable login portal setup instructions to reflect current file paths and build procedures for Identity Server 6.0.0 and 6.1.0, ensuring users follow the correct directory structure when configuring their login portals.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai
Copy link

coderabbitai bot commented Nov 12, 2025

Walkthrough

Documentation updates for Identity Server 6.0.0 and 6.1.0 customize login portal instructions. File paths redirected from non-Java components to Java-based component structure. Build working directory and deployment paths updated to align with new directory layout.

Changes

Cohort / File(s) Summary
Customizable Login Portal Documentation
en/identity-server/6.0.0/docs/references/extend/rebranding/customizable-login-portal.md, en/identity-server/6.1.0/docs/references/extend/rebranding/customizable-login-portal.md
Updated copy source path from <IS_HOME>/repository/.../authenticationendpoint/extensions/layouts/custom to <IDENTITY-APPS-HOME>/java/components/login-portal-layouts/layouts. Build step now runs from identity home root instead of components subdirectory. Compiled layout source path changed from apps/authentication-portal/... to java/apps/authentication-portal/....

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Straightforward documentation path updates applied consistently across two version files
  • Changes follow a clear, repetitive pattern with no logic modifications
  • File references and build instructions easily verifiable against expected Java-based directory structure

Poem

🐰 Hoppity-hop, the paths now align,
Java components shine so fine,
No more confusion, just clean refrain,
Layouts compile through the proper lane!
Documentation hops with joy,

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: correcting file paths in custom layout documentation for two product versions, and references the related issue.
Description check ✅ Passed The description provides purpose, issue links, and detailed changes. However, required sections like 'Test environment' and 'Security checks' are not completed as per the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fixing-product-is-issue-16460-1762914778

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
en/identity-server/6.1.0/docs/references/extend/rebranding/customizable-login-portal.md (1)

124-128: Path corrections align with Java-based structure; minor grammar refinement needed.

The path updates correctly reflect the migration to Java-based project layout. However, line 126 has a grammar issue: "Build should be succeeded" is awkward phrasing.

Apply this diff to improve clarity:

-    2. Navigate to `<IDENTITY-APPS-HOME>` directory and build the source code using `mvn clean install` command (Build should be succeeded for further steps).
+    2. Navigate to `<IDENTITY-APPS-HOME>` directory and build the source code using `mvn clean install` command. The build must succeed to proceed to the next step.

This rephrasing clarifies the requirement more naturally while maintaining the same intent.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 27071f8 and 23904bb.

📒 Files selected for processing (2)
  • en/identity-server/6.0.0/docs/references/extend/rebranding/customizable-login-portal.md (1 hunks)
  • en/identity-server/6.1.0/docs/references/extend/rebranding/customizable-login-portal.md (1 hunks)
🔇 Additional comments (1)
en/identity-server/6.0.0/docs/references/extend/rebranding/customizable-login-portal.md (1)

124-128: Path corrections align with Java-based project structure.

The updates to lines 124, 126, and 128 correctly reflect the migration to Java-based component paths. The three-step sequence is logically sound:

  1. Copy custom layout from deployment → source (line 124)
  2. Build from repository root (line 126)
  3. Deploy compiled output back to deployment directory (line 128)

The path consistency (both lines 124 and 128 now include /java/) and the move of the build step to the root directory align with standard Maven multi-module project practices.

To ensure the documented paths match the actual repository structure, please verify that:

  • The directory <IDENTITY-APPS-HOME>/java/components/login-portal-layouts/layouts exists
  • The directory <IDENTITY-APPS-HOME>/java/apps/authentication-portal/src/main/webapp/extensions/layouts/custom exists
  • The mvn clean install command from <IDENTITY-APPS-HOME> root produces artifacts in the path specified on line 128

Since the PR indicates mkdocs build succeeded, these paths are likely correct, but manual verification would confirm they align with the actual Identity Server 6.0.0 source structure.

@JayaShakthi97
Copy link
Contributor

Path updates done via this PR are invalid.

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.

4 participants