From dc0c827ecfefcc848d51f54fceb39b90b752400a Mon Sep 17 00:00:00 2001 From: Roland Kuhn Date: Sat, 20 Dec 2014 14:27:48 +0100 Subject: [PATCH] =htp move docs and create TOC structure --- akka-docs-dev/rst/experimental/index.rst | 21 ----------- akka-docs-dev/rst/java.rst | 7 ++-- akka-docs-dev/rst/scala/http-core/index.rst | 10 ----- .../rst/scala/http-testkit/testkit.rst | 2 - .../rst/scala/{http-core => http}/client.rst | 0 .../rst/scala/{http-core => http}/https.rst | 0 .../rst/scala/http/index-client-server.rst | 12 ++++++ .../rst/scala/http/index-routing.rst | 18 +++++++++ .../rst/scala/http/index-testkit.rst | 8 ++++ akka-docs-dev/rst/scala/http/index.rst | 37 ++++++++++++------- .../rst/scala/{http-core => http}/model.rst | 0 .../rst/scala/{http-core => http}/server.rst | 0 12 files changed, 66 insertions(+), 49 deletions(-) delete mode 100644 akka-docs-dev/rst/experimental/index.rst delete mode 100644 akka-docs-dev/rst/scala/http-core/index.rst delete mode 100644 akka-docs-dev/rst/scala/http-testkit/testkit.rst rename akka-docs-dev/rst/scala/{http-core => http}/client.rst (100%) rename akka-docs-dev/rst/scala/{http-core => http}/https.rst (100%) create mode 100644 akka-docs-dev/rst/scala/http/index-client-server.rst create mode 100644 akka-docs-dev/rst/scala/http/index-routing.rst create mode 100644 akka-docs-dev/rst/scala/http/index-testkit.rst rename akka-docs-dev/rst/scala/{http-core => http}/model.rst (100%) rename akka-docs-dev/rst/scala/{http-core => http}/server.rst (100%) diff --git a/akka-docs-dev/rst/experimental/index.rst b/akka-docs-dev/rst/experimental/index.rst deleted file mode 100644 index 0690a33579..0000000000 --- a/akka-docs-dev/rst/experimental/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _experimental: - -#################### -Experimental Modules -#################### - -The following modules of Akka are marked as experimental, which means -that they are in early access mode, which also means that they are not -covered by commercial support. The purpose of releasing them early, as -experimental, is to make them easily available and improve based on -feedback, or even discover that the module wasn't useful. - -An experimental module doesn't have to obey the rule of staying binary -compatible between micro releases. Breaking API changes may be introduced -in minor releases without notice as we refine and simplify based on your -feedback. An experimental module may be dropped in minor releases without -prior deprecation. - -.. toctree:: - :maxdepth: 1 - diff --git a/akka-docs-dev/rst/java.rst b/akka-docs-dev/rst/java.rst index 888f8c3b8f..31249b63a6 100644 --- a/akka-docs-dev/rst/java.rst +++ b/akka-docs-dev/rst/java.rst @@ -3,7 +3,8 @@ Java Documentation ================== -.. toctree:: - :maxdepth: 2 +.. note:: - experimental/index + The documentation has not yet been ported to Java, you are welcome to read + the Scala version since all APIs are closely reflected between the two + language bindings. diff --git a/akka-docs-dev/rst/scala/http-core/index.rst b/akka-docs-dev/rst/scala/http-core/index.rst deleted file mode 100644 index 96e764577a..0000000000 --- a/akka-docs-dev/rst/scala/http-core/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -Low-level HTTP API -================== - -.. toctree:: - :maxdepth: 2 - - model - server - client - https diff --git a/akka-docs-dev/rst/scala/http-testkit/testkit.rst b/akka-docs-dev/rst/scala/http-testkit/testkit.rst deleted file mode 100644 index e1edcd0066..0000000000 --- a/akka-docs-dev/rst/scala/http-testkit/testkit.rst +++ /dev/null @@ -1,2 +0,0 @@ -HTTP Testkit -============ \ No newline at end of file diff --git a/akka-docs-dev/rst/scala/http-core/client.rst b/akka-docs-dev/rst/scala/http/client.rst similarity index 100% rename from akka-docs-dev/rst/scala/http-core/client.rst rename to akka-docs-dev/rst/scala/http/client.rst diff --git a/akka-docs-dev/rst/scala/http-core/https.rst b/akka-docs-dev/rst/scala/http/https.rst similarity index 100% rename from akka-docs-dev/rst/scala/http-core/https.rst rename to akka-docs-dev/rst/scala/http/https.rst diff --git a/akka-docs-dev/rst/scala/http/index-client-server.rst b/akka-docs-dev/rst/scala/http/index-client-server.rst new file mode 100644 index 0000000000..98fb7329dd --- /dev/null +++ b/akka-docs-dev/rst/scala/http/index-client-server.rst @@ -0,0 +1,12 @@ +.. _http-client-server-scala: + +HTTP Client & Server +==================== + +.. toctree:: + :maxdepth: 2 + + model + client + server + https diff --git a/akka-docs-dev/rst/scala/http/index-routing.rst b/akka-docs-dev/rst/scala/http/index-routing.rst new file mode 100644 index 0000000000..b04f97e7d3 --- /dev/null +++ b/akka-docs-dev/rst/scala/http/index-routing.rst @@ -0,0 +1,18 @@ +.. _http-routing-index-scala: + +HTTP Routing +============ + +.. toctree:: + :maxdepth: 2 + + quick-start + routing + directives + rejections + exception-handling + path-matchers + marshalling + directives/alphabetically + directives/by-trait + diff --git a/akka-docs-dev/rst/scala/http/index-testkit.rst b/akka-docs-dev/rst/scala/http/index-testkit.rst new file mode 100644 index 0000000000..328e28f729 --- /dev/null +++ b/akka-docs-dev/rst/scala/http/index-testkit.rst @@ -0,0 +1,8 @@ +.. _http-testkit-scala: + +HTTP TestKit +============ + +.. note:: + + This part of the documentation has not yet been written, please stay tuned for updates. diff --git a/akka-docs-dev/rst/scala/http/index.rst b/akka-docs-dev/rst/scala/http/index.rst index 30ec9e2fd6..ed019c16b7 100644 --- a/akka-docs-dev/rst/scala/http/index.rst +++ b/akka-docs-dev/rst/scala/http/index.rst @@ -1,17 +1,28 @@ -High-level HTTP API -=================== +.. _http-scala: + +Akka HTTP +========= + +The purpose of the Akka HTTP layer is to expose Actors to the web via HTTP and +to enable them to consume HTTP services as a client. It is not an HTTP +framework, it is an Actor-based toolkit for interacting with web services and +clients. This toolkit is structured into several layers: + + * ``akka-http-core``: A complete implementation of the HTTP standard, both as + client and server. + + * ``akka-http``: A convenient and powerful routing DSL for expressing web + services. + + * ``akka-http-testkit``: A test harness and set of utilities for verifying + your web service implementations. + +Additionally there are several integration modules with bindings for different +serialization and deserialization schemes for HTTP entities. .. toctree:: :maxdepth: 2 - quick-start - routing - directives - rejections - exception-handling - path-matchers - marshalling - directives/alphabetically - directives/by-trait - - + index-client-server + index-routing + index-testkit diff --git a/akka-docs-dev/rst/scala/http-core/model.rst b/akka-docs-dev/rst/scala/http/model.rst similarity index 100% rename from akka-docs-dev/rst/scala/http-core/model.rst rename to akka-docs-dev/rst/scala/http/model.rst diff --git a/akka-docs-dev/rst/scala/http-core/server.rst b/akka-docs-dev/rst/scala/http/server.rst similarity index 100% rename from akka-docs-dev/rst/scala/http-core/server.rst rename to akka-docs-dev/rst/scala/http/server.rst