Merge pull request #364 from FriendsOfSymfony/Toflar

Added a note about the replay-headers-bundle

Author: dbu

Resources/doc/features/user-context.rst

@@ -37,6 +37,19 @@ These five steps resemble the Overview in the FOSHttpCache documentation.
    sets a ``Vary: X-User-Context-Hash`` header. The appropriate user context
    dependent representation of ``/foo`` will then be returned to the client.
 
+.. note::
+
+    In other words we execute a preflight request here. A preflight request is
+    a request that is sent prior to the real request. See for example how
+    `CORS requests`_ work. The result of the preflight request is the
+    ``X-User-Context-Hash`` header that is added to the real request.
+
+    This concept can be generalized to handle more than the user context
+    scenario. The `terminal42/header-replay-bundle`_ builds on top of the
+    ``FOSHttpCacheBundle`` to add support for more complicated use cases. Have
+    a look at the `HeaderReplayBundle documentation`_ if the user context is
+    not flexible enough for your needs.
+    
 Configuration
 -------------
 
@@ -111,3 +124,7 @@ Caching Hash Responses
 
 To improve User Context Caching performance, you should cache the hash responses.
 You can do so by configuring :ref:`hash_cache_ttl`.
+
+.. _CORS requests: https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS
+.. _terminal42/header-replay-bundle: https://github.com/terminal42/header-replay-bundle
+.. _HeaderReplayBundle documentation: https://github.com/terminal42/header-replay-bundle#terminal42header-replay-bundle

Resources/doc/spelling_word_list.txt

@@ -18,3 +18,4 @@ multi
 login
 logout
 Packagist
+preflight