-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Add resources section to the documentation #2081
Add resources section to the documentation #2081
Conversation
I see four lines are too long. I'll fix the issue right away. |
8230a33
to
78f9b0f
Compare
The CI failed due to a spell check.
I see no point in adding this word to |
This commit adds a new section to the documentation, "Resources", which provides a curated list of tutorials and talks. Issue django-commons#2070
78f9b0f
to
e86a2cf
Compare
If you look at the test runs you can see that we have unrelated failures because of a CSP related change. Maybe the package has been upgraded and our tests aren't compatible yet? You could try running the tests locally using tox, maybe while regenerating the vent so that you get new versions of all dependencies. And maybe find a django-csp version which still works, and we can fix the underlying issue later? |
@matthiask thanks for the feedback and pointers for investigating. The error message in the test failures suggests our tests fail due to the middleware order. The tests passed a few days ago with version See the commit that added the error message we see raised in our tests, as well as the related issue and discussion. # csp/middleware.py
@staticmethod
def _csp_nonce_post_response() -> None:
raise CSPNonceError(
"The 'csp_nonce' attribute is not available after the CSP header has been written. Consider adjusting your MIDDLEWARE order."
) In our tests, we append the CSPMiddleware to the end of the list. For example: @override_settings(
MIDDLEWARE=settings.MIDDLEWARE + ["csp.middleware.CSPMiddleware"]
)
def test_exists(self):
... That's as far as I've gotten. I will resume investigating later and may attempt to tweak the middleware order in our tests after researching further. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I really like what you have here! This is excellent work. I've got thoughts on some things we may want to do differently. If you disagree, please let me know.
- Favor conference site links and DjangoTV over YouTube - Make the invitation to contribute more inviting - Remove the criteria for inclusion and contributing sections django-commons#2070
I'll try to take a closer look at this over the weekend. I suspect there's a doc building error in this though. I think you might be able to reproduce it with I'm also going to add https://djangotv.com/videos/djangocon-us/2015/djangocon-us-2015-but-why-is-the-admin-slow-by-jacinda-shelly/ to the list of content. While it is a bit old, it looks like it covers a core aspect of how to use the toolbar as a debugging tool. |
Never mind on |
Yes, I built the docs locally to check that everything rendered correctly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀 Thank you @dr-rompecabezas!
This adds a new section to the documentation, "Resources", which provides a curated list of tutorials and talks. - Favor conference site links and DjangoTV over YouTube - Make the invitation to contribute more inviting - Remove the criteria for inclusion and contributing sections
Description
This PR adds a new "Resources" section to the documentation that provides a curated list of tutorials and talks about Django Debug Toolbar.
Closes #2070
Checklist:
docs/changes.rst
.