-
Notifications
You must be signed in to change notification settings - Fork 2k
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
updated websecurity.md #4083
updated websecurity.md #4083
Conversation
I have the grammatical errors written on the page such as improving the abbreviated words with apostrophes and other typos
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 PR! I've left some suggestions for how to improve the changes.
docs/source/reference/websecurity.md
Outdated
|
||
This overview also helps you obtain a deeper understanding of how JupyterHub | ||
works. | ||
|
||
## Semi-trusted and untrusted users | ||
## Semi-trusted and Untrusted Users |
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.
Let's keep sentence case in headings for consistency (if you see any Title Case, feel free to fix them to Sentence case)
docs/source/reference/websecurity.md
Outdated
|
||
JupyterHub is designed to be a _simple multi-user server for modestly sized | ||
groups_ of **semi-trusted** users. While the design reflects serving semi-trusted | ||
users, JupyterHub is not necessarily unsuitable for serving **untrusted** users. | ||
|
||
Using JupyterHub with **untrusted** users does mean more work by the | ||
Using JupyterHub with **untrusted** users entails more work by the |
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.
I think "does mean" hits this point better than "entails"
docs/source/reference/websecurity.md
Outdated
@@ -41,7 +41,7 @@ To protect all users from each other, JupyterHub administrators must | |||
ensure that: | |||
|
|||
- A user **does not have permission** to modify their single-user notebook server, | |||
including: | |||
as well as: |
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.
This is not "in addition to," it is examples of what "does not have permission to modify their single-user notebook server" means, specifically.
@@ -129,7 +129,7 @@ A handy website for testing your deployment is | |||
|
|||
## Vulnerability reporting | |||
|
|||
If you believe you’ve found a security vulnerability in JupyterHub, or any | |||
If you believe you have found a security vulnerability in JupyterHub, or any |
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.
👍
I resolved my previous commit as suggested
Thank you! |
I improved the grammatical errors written on the page such as improving the abbreviated words with apostrophes and other typos