Remove inconsistency in the Action Cable README #23968
Conversation
|
Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @matthewd (or someone else) soon. If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes. Please see the contribution instructions for more information. |
| @@ -412,7 +412,7 @@ The above will start a cable server on port 28080. | |||
|
|
|||
| ### In app | |||
|
|
|||
| If you are using a threaded server like Puma or Thin, the current implementation of Action Cable can run side-along with your Rails application. For example, to listen for WebSocket requests on `/cable`, mount the server at that path: | |||
| If you are using a server that supports the [Rack socket hijacking API](http://old.blog.phusion.nl/2013/01/23/the-new-rack-socket-hijacking-api/), Action Cable can run side-along with your Rails application. For example, to listen for WebSocket requests on `/cable`, mount the server at that path: | |||
There was a problem hiding this comment.
Can we link to the spec? http://www.rubydoc.info/github/rack/rack/file/SPEC#Hijacking
|
👍 Please address @rafaelfranca's comment, and then this can be merged. :) |
|
Done, I also changed the link to the same blogpost a bit down |
| @@ -412,7 +412,7 @@ The above will start a cable server on port 28080. | |||
|
|
|||
| ### In app | |||
|
|
|||
| If you are using a threaded server like Puma or Thin, the current implementation of Action Cable can run side-along with your Rails application. For example, to listen for WebSocket requests on `/cable`, mount the server at that path: | |||
| If you are using a server that supports the [Rack socket hijacking API](http://www.rubydoc.info/github/rack/rack/file/SPEC#Hijacking), Action Cable can run side-along with your Rails application. For example, to listen for WebSocket requests on `/cable`, mount the server at that path: | |||
There was a problem hiding this comment.
"side-along" --> "along side"
|
One more small grammar nitpick. Also, please add |
|
Seems the correct one is alongside so I've changed it to that 👍 |
Remove inconsistency in the Action Cable README
There is an inconsistency in the Action Cable docs where one part implies you need a threaded server, while another says you don't. This change removes this inconsistency.
I also removed the part about Action Cable needing to run in its own server process, which also seems to not be true anymore. It could also be changed to say that it's recommended.
Fixes #23950
For review @maclover7 @FooBarWidget