Merge pull request #19739 from ktoso/wip-cleanup-docs-add-webSocket-note-ktoso

Explain WebSocket name change and remove obsolete docs part
This commit is contained in:
drewhk 2016-02-11 13:29:07 +01:00
commit 25c558c5bd
3 changed files with 9 additions and 27 deletions

View file

@ -1,26 +0,0 @@
.. _http-module:
Incomplete List of HTTP Frameworks
##################################
Play
====
The `Play framework <http://www.playframework.com>`_ is built using Akka, and is well suited for building both full web applications as well as REST services.
Spray
=====
The `Spray toolkit <http://spray.io>`_ is built using Akka, and is a minimalistic HTTP/REST layer.
Akka Mist
=========
If you are using Akka Mist (Akka's old HTTP/REST module) with Akka 1.x and wish to upgrade to 2.x
there is now a port of Akka Mist to Akka 2.x. You can find it `here <https://github.com/thenewmotion/akka-http>`_.
Other Alternatives
==================
There are a bunch of other alternatives for using Akka with HTTP/REST. You can find some of them
among the `Community Projects <http://akka.io/community>`_.

View file

@ -8,4 +8,3 @@ Additional Information
books books
language-bindings language-bindings
osgi osgi
http

View file

@ -146,3 +146,12 @@ Please consult the :class:`GraphStage` documentation (:ref:`graphstage-scala`) a
on migrating from :class:`AsyncStage` to :class:`GraphStage`. on migrating from :class:`AsyncStage` to :class:`GraphStage`.
.. _`previous migration guide`: http://doc.akka.io/docs/akka-stream-and-http-experimental/2.0.2/scala/migration-guide-1.0-2.x-scala.html#AsyncStage_has_been_replaced_by_GraphStage .. _`previous migration guide`: http://doc.akka.io/docs/akka-stream-and-http-experimental/2.0.2/scala/migration-guide-1.0-2.x-scala.html#AsyncStage_has_been_replaced_by_GraphStage
Websocket now consistently named WebSocket
------------------------------------------
Previously we had a mix of methods and classes called ``websocket`` or ``Websocket``, which was in contradiction with
how the word is spelled in the spec and some other places of Akka HTTP.
Methods and classes using the word WebSocket now consistently use it as ``WebSocket``, so updating is as simple as
find-and-replacing the lower-case ``s`` to an upper-case ``S`` wherever the word WebSocket appeared.