better documentation for "Clients must be authorized to join private or presence channels.
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 8
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
Currently we're running into the Clients must be authorized to join private or presence channels. exception in our Rails application.
The message is linking to the authorizing users documentation, which is great. 👍
However, can you clarify in the documentation whether Pusher will (re-)tackle these cases (i.e. whether a retry will happen).
Right now we assume that the exception message might be misleading when connection issues appear so it would surely be helpful if the docs would help.
PS: Furthermore the This authenticates every user. Don't do this in production! comment is used inconsistently.
In the top examples of the documentation all of them contain the warning and if you're landing directly at the JSONP examples it is missing and people might not see this.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the authorizing-users documentation linked in the issue, especially the JSONP section, and compare its warning with the examples above it. Clarify whether authorization failures caused by connection issues are retried, and make the production warning consistent across the examples; the issue is done when both points are addressed in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, rails
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100