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

Added note warning about using sqlite 3.26.0 in development #5491

Merged
merged 2 commits into from Mar 22, 2019

Conversation

@rshrc
Copy link
Contributor

@rshrc rshrc commented Mar 19, 2019

Added a note in the developer guide which asks the developer to use python version 3.6.7 instead of python 3.6.8 which would use a higher version of sqlite3 giving rise to issur #5477

Added a note in the developer guide which asks the developer to use python version 3.6.7 instead of python 3.6.8 which would use a higher version of sqlite3 giving rise to issur readthedocs#5477
Copy link
Member

@humitos humitos left a comment

I would put on the note to be aware that there's an issue with the sqlite version >= 3.26.0 but not refer to the python version probably

I agree with @raulcd on this.

My idea with adding a note here is to give the quick solution to the user if they hit this problem. How we can guide the user in this direction? I mean, what the user should do if they are in the situation described by @raulcd in the previous example?

docs/install.rst Outdated
@@ -11,6 +11,12 @@ First, obtain `Python 3.6`_ and virtualenv_ if you do not already have them.
Using a virtual environment is strongly recommended,
since it will help you to avoid clutter in your system-wide libraries.

.. note::
Copy link
Member

@humitos humitos Mar 19, 2019

This should probably be a warning instead.

Copy link
Member

@ericholscher ericholscher Mar 19, 2019

I'd really like to keep these edge cases out of the default flow for the install guide, otherwise it just gets messy. We should add them to a troubleshooting section at the bottom of the guide, with the error that they fix.

Copy link
Member

@humitos humitos Mar 19, 2019

The thing is that it's not an edge case.

All users installing Python 3.6 with an up to date system will hit this problem. The issue is fixed on Django 2.x but we are using 1.11.x. So, all new contributors will hit it until we upgrade our django version.

Copy link
Member

@ericholscher ericholscher Mar 22, 2019

OK, thanks sense then.

Copy link
Member

@ericholscher ericholscher Mar 22, 2019

OK, thanks sense then.

@ericholscher ericholscher merged commit 5b8320b into readthedocs:master Mar 22, 2019
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants