aboutsummaryrefslogtreecommitdiffstats
path: root/guide/toc.md
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-09-16 23:51:09 +0200
committerLoïc Hoguin <[email protected]>2013-09-18 12:02:37 +0200
commit7319526de6b983e153151d64e19aec5f7199095b (patch)
tree81541e0af2b133ad5d6f953ad22a1c8802312c97 /guide/toc.md
parent40b87545f68d52d7b4e2dd495639deef184cceca (diff)
downloadcowboy-7319526de6b983e153151d64e19aec5f7199095b.tar.gz
cowboy-7319526de6b983e153151d64e19aec5f7199095b.tar.bz2
cowboy-7319526de6b983e153151d64e19aec5f7199095b.zip
Added a chapter about life of HTTP requests
Reworked the table of contents also.
Diffstat (limited to 'guide/toc.md')
-rw-r--r--guide/toc.md142
1 files changed, 68 insertions, 74 deletions
diff --git a/guide/toc.md b/guide/toc.md
index f30a5bd..6543ca1 100644
--- a/guide/toc.md
+++ b/guide/toc.md
@@ -8,89 +8,83 @@ Introducing Cowboy
------------------
* [Introduction](introduction.md)
- * Purpose
- * Prerequisites
- * Supported platforms
- * Conventions
* [The modern Web](modern_web.md)
- * The prehistoric Web
- * HTTP/1.1
- * REST
- * Long-polling
- * HTML5
- * EventSource
- * Websocket
- * SPDY
- * HTTP/2.0
* [Erlang and the Web](erlang_web.md)
- * The Web is concurrent
- * The Web is soft real time
- * The Web is asynchronous
- * The Web is omnipresent
- * Erlang is the ideal platform for the Web
* [Erlang for beginners](erlang_beginners.md)
* [Getting started](getting_started.md)
-Using Cowboy
-------------
+HTTP
+----
+ * [The life of a request](http_req_life.md)
+<!-- you are here -->
* [Routing](routing.md)
- * Purpose
- * Structure
- * Match syntax
- * Constraints
- * Compilation
- * Live update
- * [Handlers](handlers.md)
- * Purpose
- * Protocol upgrades
- * Custom protocol upgrades
- * [HTTP handlers](http_handlers.md)
- * Purpose
- * Usage
- * [Loop handlers](loop_handlers.md)
- * Purpose
- * Usage
- * [Websocket handlers](ws_handlers.md)
- * Purpose
- * Usage
- * [REST handlers](rest_handlers.md)
- * Purpose
- * Usage
- * Flow diagram
- * Methods
- * Callbacks
- * Meta data
- * Response headers
+ * [Handling plain HTTP requests](http_handlers.md)
+ * [The Req object](req.md)
+ * Reading the request body
+ * Sending a response
+
+Static files
+------------
+
* [Static handlers](static_handlers.md)
- * Purpose
- * Usage
- * MIME type
- * [Request object](req.md)
- * Purpose
- * Request
- * Request body
- * Multipart request body
- * Response
- * Chunked response
- * Response preconfiguration
- * Closing the connection
- * Reducing the memory footprint
+ * Distributed CDN solutions
+
+REST
+----
+
+ * REST principles
+ * Media types explained
+ * HTTP caching
+ * [Handling REST requests](rest_handlers.md)
+ * HEAD/GET requests flowchart
+ * POST/PUT/PATCH requests flowchart
+ * DELETE requests flowchart
+ * OPTIONS requests flowchart
+ * Designing a REST API
+
+Multipart
+---------
+
+ * Understanding multipart
+ * Multipart requests
+ * Multipart responses
+
+Server push technologies
+------------------------
+
+ * Push technologies
+ * [Using loop handlers for server push](loop_handlers.md)
+ * CORS
+
+Using Websocket
+---------------
+
+ * The Websocket protocol
+ * [Handling Websocket connections](ws_handlers.md)
+
+Advanced HTTP
+-------------
+
+ * Authentication
+ * Sessions
+
+Advanced Cowboy usage
+---------------------
+
+ * Optimization guide
* [Hooks](hooks.md)
- * On request
- * On response
* [Middlewares](middlewares.md)
- * Purpose
- * Usage
- * Configuration
- * Routing middleware
- * Handler middleware
+ * Access and error logs
+ * Handling broken clients
+ * HTTP header names
+ * HTTP/1.1 streaming not chunked
+
+Old guide misc
+--------------
+
+This section will be removed as content is moved into other chapters.
+
+ * [Handlers](handlers.md)
* [Internals](internals.md)
- * Architecture
- * One process for many requests
- * Lowercase header names
- * Improving performance
* [Resources](resources.md)
- * Frameworks
- * Helper libraries
- * Articles