Skip to content
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

Merged
merged 1 commit into from
Nov 25, 2024

Conversation

imsayari404
Copy link
Contributor

@imsayari404 imsayari404 commented Nov 22, 2024

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

  • Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== NO RELEASE NOTE ==

@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Nov 22, 2024
@prestodb-ci prestodb-ci requested review from a team, anandamideShakyan and psnv03 and removed request for a team November 22, 2024 06:29
@github-actions github-actions bot added the docs label Nov 22, 2024
Copy link
Member

@imjalpreet imjalpreet left a 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

Copy link
Contributor

@steveburnett steveburnett left a 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.

@imsayari404
Copy link
Contributor Author

Hi @steveburnett, I’ve made the changes you requested. Please let me know if you get a chance to review them. Thank you!

Copy link
Contributor

@steveburnett steveburnett left a 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.

Copy link
Member

@imjalpreet imjalpreet left a 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?

@imjalpreet imjalpreet merged commit 461ae13 into prestodb:master Nov 25, 2024
58 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs from:IBM PR from IBM
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants