celluloid / reel

UNMAINTAINED: See celluloid/celluloid#779 - Celluloid::IO-powered web server
https://celluloid.io
MIT License
595 stars 87 forks source link

Refactor the Wiki for a post-#121 incarnation of `Server` with multiple protocols. #126

Closed digitalextremist closed 10 years ago

digitalextremist commented 10 years ago

Right now in the Wiki, before #121, all previous implementations of Reel were done directly through Reel::Server which was implied to be HTTP but now must explicitly be Server::HTTP. This will break every use of Reel in the wild, as Reel transforms into being multiprotocol by design.

Now we have Server::HTTP, Server::SSL, and as of #123 there is Server::UNIX ... a natural fourth protocol ought to be a directly usable implementation of the a la carte websocket handler, as a Server::WebSocket option I believe, but that is a separate issue. That could alternatively be Server::SSL::WebSocket and Server::HTTP::WebSocket, so discussion is needed on how to package that. Again, separate issue.

The Wiki needs to be refactored to reflect the state of Reel::Server, and backward-facing documentation ought to be written to address the change to Reel::HTTP until the previous way is out of memory and Server::HTTP is widely known in the existing coders depending on Reel.

digitalextremist commented 10 years ago

HTTPS also needs more information about recently added options refactored in #124

digitalextremist commented 10 years ago

Did rapid-fire Wiki updates. Yardocs seem to be dynamically generated.

@tarcieri are you cool with me drafting and posting FAQ and Mailing List content here?

tarcieri commented 10 years ago

Sure

digitalextremist commented 10 years ago

@tarcieri I just put the FAQ text directly in since you can change it directly as you see fit. I think the FAQ text can probably be posted to the mailing list. I kept it brief, simply, and calm rather than causing fear and trepidation about it.

digitalextremist commented 10 years ago

@tarcieri you should probably post to the mailing list so people actually read it sooner than later. I figure the FAQ text is enough, after your edits if you have any, then that can be checked off and this can be closed... and then we're all done, allowing #123, #124, and #125 to gracefully come in, when ready.

digitalextremist commented 10 years ago

For now, at least the Wiki is correct.

digitalextremist commented 10 years ago

Posted to the mailing list: https://groups.google.com/d/msg/celluloid-ruby/uKKuZbRNwR4/jsPFY13eghEJ