#32065 working on docs #20
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the technical documentation related to SAML by adding package documentation and updating the README with detailed SAML flow information.
- Added package-info.java files to document internal, implementation, handler, and external packages.
- Updated README.md to describe SAML’s role in dotCMS and include a flow diagram.
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/main/java/com/dotcms/saml/service/internal/package-info.java | Added package documentation for SAML internal utility classes. |
| src/main/java/com/dotcms/saml/service/impl/package-info.java | Documented the facade and proxy implementations for SAML. |
| src/main/java/com/dotcms/saml/service/handler/package-info.java | Added documentation for assertion, authentication, and logout. |
| src/main/java/com/dotcms/saml/service/external/package-info.java | Documented external model objects and exceptions for SAML. |
| README.md | Expanded SAML documentation with detailed flow and explanations. |
| @@ -0,0 +1,7 @@ | |||
| /** | |||
| * This package contains some utils classes for encryption, XML and some saml stuff | |||
There was a problem hiding this comment.
[nitpick] Consider refining the description to use more formal language, e.g., replace 'utils classes' with 'utility classes' and 'saml stuff' with 'SAML functionalities' for clarity.
| * This package contains some utils classes for encryption, XML and some saml stuff | |
| * This package contains some utility classes for encryption, XML, and SAML functionalities |
|
|
||
| ### What is SAML and how it works in dotCMS? | ||
|
|
||
| - SAML is a protocol based on XML (Security Assertion Markup Language), do to SSO (Single Sign On) |
There was a problem hiding this comment.
Review the phrase 'do to SSO' for a likely typo; consider replacing it with 'for SSO' to improve clarity.
| - SAML is a protocol based on XML (Security Assertion Markup Language), do to SSO (Single Sign On) | |
| - SAML is a protocol based on XML (Security Assertion Markup Language), for SSO (Single Sign On) |
| - Users authenticate once and gain access to multiple applications without re-entering credentials. | ||
| - May handle roles and authorizations. | ||
|
|
||
| . |
There was a problem hiding this comment.
[nitpick] The standalone period appears unnecessary; remove it to improve document clarity.
| . |
1 participant
Effort to add more tech doc to SAML