-
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
Doc fix #4200
base: main
Are you sure you want to change the base?
Doc fix #4200
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.
Thanks for your suggestions! I've left some suggestions in-line to be addressed.
If you don't have time to finish these now that the outreachy period is over, let us know and we can take over.
@@ -39,24 +39,24 @@ multiple processes which might try to access the file at the same time. | |||
### PostgreSQL | |||
|
|||
We recommend using PostgreSQL for production if you are unsure whether to use | |||
MySQL or PostgreSQL or if you do not have a strong preference. There is | |||
MySQL or PostgreSQL or if you do not have a strong preference. This is because there is an |
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 isn't the reason, it's another (related) fact.
MySQL or PostgreSQL or if you do not have a strong preference. This is because there is an | |
MySQL or PostgreSQL or if you do not have a strong preference. There is |
@@ -9,7 +9,7 @@ The default database for JupyterHub is a [SQLite](https://sqlite.org) database. | |||
We have chosen SQLite as JupyterHub's default for its lightweight simplicity | |||
in certain uses such as testing, small deployments and workshops. | |||
|
|||
For production systems, SQLite has some disadvantages when used with JupyterHub: | |||
For production systems, SQLite has some disadvantages when used with JupyterHub which includes: |
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.
For production systems, SQLite has some disadvantages when used with JupyterHub which includes: | |
For production systems, SQLite has some disadvantages when used with JupyterHub, including: |
connections serverside if they've been idle for a while, and the connection | ||
from the hub will be idle for longer than most connections. This behavior | ||
will lead to frustrating 'the connection has gone away' errors from | ||
which depends on your MySQL setup. This is necessary since MySQL kills serverside |
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.
which depends on your MySQL setup. This is necessary since MySQL kills serverside | |
which depends on your MySQL setup. This is necessary since MySQL kills server-side |
sqlalchemy if `pool_recycle` is not set. | ||
- If you use `utf8mb4` collation with MySQL earlier than 5.7.7 or MariaDB | ||
earlier than 10.2.1 you may get an `1709, Index column size too large` error. | ||
To fix this you need to set `innodb_large_prefix` to enabled and | ||
`innodb_file_format` to `Barracuda` to allow for the index sizes jupyterhub | ||
uses. `row_format` will be set to `DYNAMIC` as long as those options are set | ||
uses, `row_format` will be set to `DYNAMIC` as long as those options are set |
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.
Ending a sentence here is correct:
uses, `row_format` will be set to `DYNAMIC` as long as those options are set | |
uses. `row_format` will be set to `DYNAMIC` as long as those options are set |
I rephrased the parts of the docs on database.