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

Improve contributing docs, take 2 #8113

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 17 additions & 6 deletions docs/development/install.rst
Expand Up @@ -62,15 +62,26 @@ 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``)
* click "..." next to the ``static`` bucket name and then "Edit Policy"
Copy link
Contributor

Choose a reason for hiding this comment

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

These new instructions are very helpful! Thank you for doing this!

* 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

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

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

#. 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
Expand Down
2 changes: 2 additions & 0 deletions tox.ini
Expand Up @@ -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; \
Expand Down