docs: complete authenticator and authorizer documentation#290
docs: complete authenticator and authorizer documentation#290GaneshPatil7517 wants to merge 9 commits intoapache:mainfrom
Conversation
- community.adoc: Update to use GitHub Discussions instead of Nabble - forums.adoc: Restructure and add GitHub Discussions section - issues.adoc: Update from Jira to GitHub Issues for issue tracking
993f570 to
c911576
Compare
There was a problem hiding this comment.
Pull request overview
This PR completes the documentation for two core Apache Shiro components (Authenticator and Authorizer) that were previously marked as TODO placeholders. The documentation explains how these components fit into Shiro's architecture, their interaction with Realms, and configuration options. Additionally, the PR modernizes community support references by migrating from JIRA to GitHub Issues and adding GitHub Discussions.
Changes:
- Added comprehensive documentation for the Authenticator component, explaining its role in verifying user identity and coordinating with Realms during authentication
- Added comprehensive documentation for the Authorizer component, explaining its role in access control decisions and permission evaluation
- Updated community support pages to reference GitHub Issues instead of JIRA and added GitHub Discussions as a support channel
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/site/content/authenticator.adoc | Complete documentation replacing TODO placeholder, covering Authenticator's role, ModularRealmAuthenticator, authentication strategies, and Realm interaction |
| src/site/content/authorizer.adoc | Complete documentation replacing TODO placeholder, covering Authorizer's role, ModularRealmAuthorizer, permission/role checks, and multi-realm authorization |
| src/site/content/issues.adoc | Updated to reference GitHub Issues as the primary issue tracking system, with JIRA marked as legacy/archival |
| src/site/content/forums.adoc | Restructured to emphasize mailing lists per ASF guidelines and added GitHub Discussions as a community forum option |
| src/site/content/community.adoc | Updated forum and issue tracker references to GitHub Discussions and GitHub Issues |
| src/site/content/mailing-lists.adoc | Simplified reference from "Shiro Issues/JIRA List" to "Shiro Issues List" |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
lprimak
left a comment
There was a problem hiding this comment.
Great job!
One change needed... the new guides are not linked anywhere on the site
|
ok ill work on that give me some time... |
This PR replaces placeholder TODO pages with complete documentation for the Authenticator and Authorizer components in Apache Shiro.
These are core Shiro components responsible for:
The documentation explains their roles in the SecurityManager architecture, how they coordinate with Realms, configuration options, and their purpose in the overall Shiro security framework.
Resolves #283