-
Notifications
You must be signed in to change notification settings - Fork 5.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix Password Authenticator Documentation #24116
Fix Password Authenticator Documentation #24116
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@imsayari404 thanks for the fix! One minor request, can you also update Line 40 to password-authenticator.name=custom-password-authenticator
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the doc! A nit of formatting the code example in the last line, everything else looks good.
Hi @steveburnett, I’ve made the changes you requested. Please let me know if you get a chance to review them. Thank you! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! (docs)
Pull updated branch, new local docs build, looks good.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@imsayari404 thanks, LGTM. Can you please squash the commits into one?
cb010b0
to
71f6bcb
Compare
Description
Documentation modified for password-authenticator.rst
Motivation and Context
Updated the property name from access-control.name to password-authenticator.name to align with the declaration in the code: private static final String NAME_PROPERTY = "password-authenticator.name";.
Impact
This change ensures that the configuration aligns correctly with the expected property name in the code (password-authenticator.name). It prevents potential misconfigurations and runtime errors caused by mismatched property names, thereby improving reliability and clarity in the authentication setup process.
Contributor checklist
Release Notes
Please follow release notes guidelines and fill in the release notes below.