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.

Sign up for GitHub

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 information about known backend warning to documentation #577

Merged
merged 1 commit into from
Dec 13, 2024
Merged

Add information about known backend warning to documentation #577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/docs/reference/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,16 @@ args: [
- [Install Hugo](https://gohugo.io/getting-started/quick-start/)
- Clone the website repository
- Run website: `hugo server`
=== Debugging
==== Known Warnings

When debugging the backend the following warning is shown:

```
WARNING in __init__: WebSocket transport not available. Install gevent-websocket for improved performance.
```

This only affects the backend when running in debug mode. This means it is not necessary to add it to `requirements.txt` for the project.


=== Debugging
Expand Down