From 161c9dc76ab85656498ada3f1e1e8d29f03ae2be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Luis=20Cano=20Rodr=C3=ADguez?= Date: Mon, 19 Apr 2021 16:50:09 +0200 Subject: [PATCH 1/3] Enforce Python 3.6 in tox --- tox.ini | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tox.ini b/tox.ini index 239aec5625c..2545d59fdcd 100644 --- a/tox.ini +++ b/tox.ini @@ -14,6 +14,8 @@ setenv = passenv = CI TRAVIS TRAVIS_* deps = -r{toxinidir}/requirements/testing.txt changedir = {toxinidir}/readthedocs +basepython = + python3.6 commands = /bin/sh -c '\ export DJANGO_SETTINGS_MODULE=readthedocs.settings.test; \ From 8660ed98dc1278eb747914c19025931f779a9a77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Luis=20Cano=20Rodr=C3=ADguez?= Date: Mon, 19 Apr 2021 16:50:48 +0200 Subject: [PATCH 2/3] Clarify MinIO instructions Fix #8090. --- docs/development/install.rst | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/development/install.rst b/docs/development/install.rst index c3fb8ec5eeb..6657218b6c3 100644 --- a/docs/development/install.rst +++ b/docs/development/install.rst @@ -62,13 +62,10 @@ Set up your environment * go to http://localhost:9000/ (MinIO S3 storage backend) * login as ``admin`` / ``password`` - * click "..." next to the bucket name and then "Edit Policy" - * give "Read Only" access on all the buckets (``static`` and ``media``) - - .. note:: - - ``media`` bucket may be created after the first build is finished. - You will need to repeat this step after that. + * click "..." next to the ``static`` bucket name and then "Edit Policy" + * leave "prefix" empty and click "Add" to give "Read Only" access on the ``static`` bucket + * click on the "+" icon on the bottom-right corner, then "Create bucket" with the name ``media``, + hit Enter on the keyboard, and repeat the operation above to give "Read Only" access to it #. go to http://community.dev.readthedocs.io to access your local instance of Read the Docs. From a773f0a3ecb69ec1821c61d4c9c203966480400c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Luis=20Cano=20Rodr=C3=ADguez?= Date: Mon, 19 Apr 2021 18:10:42 +0200 Subject: [PATCH 3/3] Add post-installation steps --- docs/development/install.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/development/install.rst b/docs/development/install.rst index 6657218b6c3..27aa8b074f2 100644 --- a/docs/development/install.rst +++ b/docs/development/install.rst @@ -70,6 +70,20 @@ Set up your environment #. go to http://community.dev.readthedocs.io to access your local instance of Read the Docs. +Check that everything works +--------------------------- + +#. go to http://community.dev.readthedocs.io and check that the appearance and style looks correct + (otherwise the MinIO buckets might be misconfigured, see above) + +#. login as ``admin`` / ``admin`` and verify that the project list appears + +#. go to the "Read the Docs" project, click on the "Build version" button to build ``latest``, + and wait until it finishes + +#. click on the "View docs" button to browse the documentation, and verify that it works + + Working with Docker Compose ---------------------------