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



Copy link

@astrojuanlu astrojuanlu commented Apr 19, 2021

  • Force Python 3.6 on tox, for those using it (to avoid installation issues of dependencies and also to match the version we are currently using)
  • Add more detail to MinIO instructions (do not assume that the user knows how MinIO works)
  • Add post-install, verification steps

This should be ready to go, but at the moment I am not able to complete the steps because of a local error: (Edit: Figured it out, fix to follow)

@@ -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

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!

@astrojuanlu astrojuanlu merged commit c7e1f18 into readthedocs:master Apr 19, 2021
3 checks passed
Copy link
Contributor Author

Thanks @humitos and @cocobennett for having a look! 🙌🏽

@astrojuanlu astrojuanlu deleted the improve-contributing-docs-take-2 branch April 19, 2021 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

None yet

3 participants