[ZEPPELIN-6223] Improve grammar and clarity in SECURITY-README.md for Shiro authentication #4959
+29
−17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… Shiro authentication
tbonelee
approved these changes
Jul 12, 2025
pan3793
reviewed
Jul 13, 2025
SECURITY-README.md
Outdated
| ## What Are We Securing? | ||
|
|
||
| Zeppelin is essentially a web application that spawns remote interpreters to run commands and return HTML fragments to be displayed in the user's browser. | ||
| The scope of this pull request is to require user credentials to access Zeppelin. To achieve this, we use Apache Shiro. |
There was a problem hiding this comment.
the words of this line are strange, this is user-facing docs, not a PR description
There was a problem hiding this comment.
@pan3793
Thanks for the feedback! I've updated the sentence to better fit a user-facing documentation tone. Let me know if you have any further suggestions.
…authentication description
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this PR for?
This PR improves the grammar, clarity, and structure of SECURITY-README.md, which explains how Shiro authentication works in Apache Zeppelin.
It fixes typos, updates awkward or outdated phrases, and improves the consistency of terminology and punctuation. The documentation link has also been updated to point to the stable 0.12.0 release.
These changes make the document easier to read and maintain, while providing clearer guidance to users setting up security in Zeppelin.
What type of PR is it?
Documentation
Todos
What is the Jira issue?
How should this be tested?
Screenshots (if appropriate)
N/A
Questions: