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

Doc fix #4200

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Doc fix #4200

wants to merge 1 commit into from

Conversation

lumenCodes
Copy link
Contributor

I rephrased the parts of the docs on database.

@consideRatio consideRatio added documentation outreachy-dec22 Issues and tasks related to the Dec 22 cohort of Outreachy labels Nov 9, 2022
Copy link
Member

@minrk minrk 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 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
Copy link
Member

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.

Suggested change
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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Member

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:

Suggested change
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation outreachy-dec22 Issues and tasks related to the Dec 22 cohort of Outreachy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants