Skip to content

Commit 308be68

Browse files
committed
Finalise docs
* fix links to FOSHttpCache docs * a little clean-up
1 parent c9ee056 commit 308be68

File tree

7 files changed

+21
-23
lines changed

7 files changed

+21
-23
lines changed

Resources/doc/features/headers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ For instance:
4949
headers:
5050
cache_control: { public: true, max_age: 15, s_maxage: 30, last_modified: "-1 hour" }
5151
52-
See :doc:`/reference/configuration/headers`.
52+
See the :doc:`/reference/configuration/headers` configuration reference.
5353

5454
.. _manually setting cache headers: http://symfony.com/doc/current/book/http_cache.html#the-cache-control-header
5555
.. _setting caching headers through annotations: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/cache.html

Resources/doc/features/helpers/flash-message.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Flash Message Subscriber
22
========================
33

4-
**Prerequisites**: *None*
4+
**Prerequisites**: *none*
55

66
When flash messages are rendered into the content of a page, you can't cache
77
the page anymore. When enabled, this subscriber reads all flash messages into a

Resources/doc/features/invalidation.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Invalidation
22
============
33

4-
**Prerequisites**: :ref:`Configure caching proxy <foshttpcache:proxy-configuration>`.
4+
**Prerequisites**: :ref:`configure caching proxy <foshttpcache:proxy-configuration>`.
55

66
By *invalidating* a piece of content, you tell your HTTP caching proxy (Varnish
77
or Nginx) to no longer serve it to clients. When next requested, the proxy will
@@ -64,8 +64,8 @@ You can add invalidation rules to your application configuration:
6464
6565
Now when a request to either route ``villain_edit`` or route ``villain_delete``
6666
returns a succesful response, both routes ``vilains_index`` and
67-
``villain_details`` will be purged. See
68-
:doc:`/reference/configuration/invalidation` for more.
67+
``villain_details`` will be purged. See the
68+
:doc:`/reference/configuration/invalidation` configuration reference.
6969

7070
Annotations
7171
-----------
@@ -84,7 +84,7 @@ invalidation from your controllers::
8484
{
8585
}
8686

87-
See further :doc:`/reference/annotations`.
87+
See the :doc:`/reference/annotations` reference.
8888

8989
Console Commands
9090
----------------
@@ -100,7 +100,8 @@ and will automatically talk to all configured cache instances.
100100
them. See :ref:`cache manager refreshing`.
101101
* ``fos:httpcache:invalidate:regex`` expects a regular expression and invalidates
102102
all cache entries matching that expression. To invalidate your entire cache,
103-
you can specify ``.`` which will match everything. See :ref:`cache manager invalidation`.
103+
you can specify ``.`` (dot) which will match everything.
104+
See :ref:`cache manager invalidation`.
104105
* ``fos:httpcache:invalidate:tag`` accepts one or more tags and invalidates all
105106
cache entries matching any of those tags. See :doc:`tagging`.
106107

Resources/doc/features/tagging.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
Tagging
22
=======
33

4-
**Prerequisites**: :ref:`Configure caching proxy for banning <foshttpcache:varnish-configuration#ban>` (only supported with Varnish).
4+
**Prerequisites**: :ref:`configure caching proxy for tagging <foshttpcache:varnish_tagging>`
5+
(Varnish only).
56

67
If your application has many intricate relationships between cached items,
78
which makes it complex to invalidate them by route, cache tagging will be
8-
useful.
9+
useful. It helps you with invalidating many-to-many relationships between
10+
content items.
911

1012
Cache tagging, or more precisely `Tagged Cache Invalidation`_, a simpler
1113
version of `Linked Cache Invalidation`_ (LCI), allows you to:

Resources/doc/features/user-context.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
User Context
22
============
33

4-
**Prerequisites**: :ref:`Configure caching proxy for user context <foshttpcache:varnish-configuration#user-context>` (only supported with Varnish).
4+
**Prerequisites**: :ref:`configure caching proxy for user context <foshttpcache:varnish user context>` (Varnish only).
55

66
If your application serves different content depending on the user’s group
77
or context (guest, editor, admin), you can cache that content per user context.

Resources/doc/overview.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ Configuration
7878
-------------
7979

8080
Now you can configure the bundle under the ``fos_http_cache`` key. The
81-
:doc:`features` section contains configuration examples, for
82-
a reference see the :doc:`reference/configuration` section.
81+
:doc:`features` section introduces the bundle’s features. The
82+
:doc:`reference/configuration` section lists all configuration options.
8383

8484
Functionality
8585
-------------

Resources/doc/reference/configuration/match.rst

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
1-
Matching
2-
========
3-
4-
Several parts of the configuration use ``match`` sections to limit
5-
configuration to specific requests and responses. Matches are used for
6-
:doc:`caching headers <headers>`, :doc:`invalidation <invalidation>` and
7-
:doc:`tag rules <tags>`.
81
match
9-
-----
2+
=====
103

11-
**type**: ``array``
4+
The :doc:`cache <headers>`, :doc:`invalidation <invalidation>` and
5+
:doc:`tag rule <tags>` configurations all use ``match`` sections
6+
to limit the configuration to specific requests and responses.
127

13-
A match contains one or more match criteria for requests. All matching criteria
14-
are regular expressions. For instance:
8+
Each ``match`` section contains one or more match criteria for requests.
9+
All criteria are regular expressions. For instance:
1510

1611
.. code-block:: yaml
1712

0 commit comments

Comments
 (0)