Skip to content

Commit c7e1f18

Browse files
authored
Merge pull request #8113 from astrojuanlu/improve-contributing-docs-take-2
Improve contributing docs, take 2
2 parents b673130 + a773f0a commit c7e1f18

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

docs/development/install.rst

+17-6
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,26 @@ Set up your environment
6262

6363
* go to http://localhost:9000/ (MinIO S3 storage backend)
6464
* login as ``admin`` / ``password``
65-
* click "..." next to the bucket name and then "Edit Policy"
66-
* give "Read Only" access on all the buckets (``static`` and ``media``)
65+
* click "..." next to the ``static`` bucket name and then "Edit Policy"
66+
* leave "prefix" empty and click "Add" to give "Read Only" access on the ``static`` bucket
67+
* click on the "+" icon on the bottom-right corner, then "Create bucket" with the name ``media``,
68+
hit Enter on the keyboard, and repeat the operation above to give "Read Only" access to it
6769

68-
.. note::
70+
#. go to http://community.dev.readthedocs.io to access your local instance of Read the Docs.
6971

70-
``media`` bucket may be created after the first build is finished.
71-
You will need to repeat this step after that.
7272

73-
#. go to http://community.dev.readthedocs.io to access your local instance of Read the Docs.
73+
Check that everything works
74+
---------------------------
75+
76+
#. go to http://community.dev.readthedocs.io and check that the appearance and style looks correct
77+
(otherwise the MinIO buckets might be misconfigured, see above)
78+
79+
#. login as ``admin`` / ``admin`` and verify that the project list appears
80+
81+
#. go to the "Read the Docs" project, click on the "Build version" button to build ``latest``,
82+
and wait until it finishes
83+
84+
#. click on the "View docs" button to browse the documentation, and verify that it works
7485

7586

7687
Working with Docker Compose

tox.ini

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ setenv =
1414
passenv = CI TRAVIS TRAVIS_*
1515
deps = -r{toxinidir}/requirements/testing.txt
1616
changedir = {toxinidir}/readthedocs
17+
basepython =
18+
python3.6
1719
commands =
1820
/bin/sh -c '\
1921
export DJANGO_SETTINGS_MODULE=readthedocs.settings.test; \

0 commit comments

Comments
 (0)