Skip to content

Commit cc33ccc

Browse files
committed
docs/guide/cache/*.md: Fix links
1 parent 3024888 commit cc33ccc

File tree

6 files changed

+29
-30
lines changed

6 files changed

+29
-30
lines changed

docs/guide/cache/content_aware_cache.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Apache has a [hard](https://github.com/apache/httpd/blob/5f32ea94af5f1e7ea68d6fc
9292
1\. For inline rendering just displaying the content name, image attribute, and/or link, it would be enough to:
9393

9494
- Look into how many inline (non ESI) render calls for content rendering you are doing, and see if you can organize it differently.
95-
- Consider inlining the views not used elsewhere in the given template and [tagging the response in Twig](#response-tagging-in-twig) with "relation" tags.
95+
- Consider inlining the views not used elsewhere in the given template and [tagging the response in Twig](#response-tagging-in-templates) with "relation" tags.
9696
- (Optional) You can set reduced cache TTL for the given view, to reduce the risk of stale cache on subtree operations affecting the inlined content.
9797

9898
2\. You can opt in to set a max length parameter (in bytes) and corresponding ttl (in seconds)
@@ -197,7 +197,7 @@ but parent response needs these tags to get refreshed if they are deleted:
197197
$responseTagger->addTags([ContentTagInterface::RELATION_PREFIX . '33', ContentTagInterface::RELATION_PREFIX . '34']);
198198
```
199199

200-
See [Tagging from code](https://foshttpcachebundle.readthedocs.io/en/2.8.0/features/tagging.html#tagging-and-invalidating-from-php-code) in FOSHttpCacheBundle doc.
200+
See [Tagging from code](https://foshttpcachebundle.readthedocs.io/en/stable/features/tagging.html#tagging-and-invalidating-from-php-code) in FOSHttpCacheBundle doc.
201201

202202
4\. Use deprecated `X-Location-Id` header.
203203

@@ -250,7 +250,7 @@ As a last resort you can also use the following function from FOS which lets you
250250
{{ fos_httpcache_tag(['r33', 'r44']) }}
251251
```
252252

253-
See [Tagging from Twig Templates](https://foshttpcachebundle.readthedocs.io/en/latest/features/tagging.html#tagging-from-twig-templates) in FOSHttpCacheBundle documentation.
253+
See [Tagging from Twig Templates](https://foshttpcachebundle.readthedocs.io/en/stable/features/tagging.html#tagging-from-twig-templates) in FOSHttpCacheBundle documentation.
254254

255255
## Tag purging
256256

@@ -400,7 +400,7 @@ To find a valid route, click an element in the **URLs** drop-down for the specif
400400
A route may look like this:
401401
`https://www.staging.foobar.com.us-2.platformsh.site/`
402402

403-
In this case the region is `us-2` and you can find the public IP list on [Platform.sh documentation page](https://docs.platform.sh/development/public-ips.html)
403+
In this case the region is `us-2` and you can find the public IP list on [Platform.sh documentation page](https://docs.platform.sh/development/regions.html#public-ip-addresses)
404404
Typically, you can add a `gw` to the hostname and use nslookup to find it.
405405

406406
```bash

docs/guide/cache/context_aware_cache.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A similar but internal logic is done in the provided enhanced Symfony Proxy (App
1818

1919
## Request lifecycle
2020

21-
This expands steps covered in [FOSHttpCacheBundle documentation on user context feature](https://foshttpcachebundle.readthedocs.io/en/latest/features/user-context.html#how-it-works):
21+
This expands steps covered in [FOSHttpCacheBundle documentation on user context feature](https://foshttpcachebundle.readthedocs.io/en/stable/features/user-context.html#how-it-works):
2222

2323
1. A client (browser) requests URI `/foo`.
2424
1. The caching proxy receives the request and holds it. It first sends a hash request to the application's context hash route: `/_fos_user_context_hash`.
@@ -32,7 +32,7 @@ as the hash lookup itself is cached by the cache proxy as described below.
3232

3333
### User context hash caching
3434

35-
Example of a response sent to reverse proxy from `/_fos_user_context_hash` with [[[= product_name =]]'s default config](#default-options-for-FOSHttpCacheBundle-defined-in-ibexa-dxp):
35+
Example of a response sent to reverse proxy from `/_fos_user_context_hash` with [[[= product_name =]]'s default config](#default-options-for-foshttpcachebundle):
3636

3737
```
3838
HTTP/1.1 200 OK
@@ -68,6 +68,7 @@ It also varies on `Authorization` to cover any possible basic authorization head
6868

6969
!!! caution "Default options for FOSHttpCacheBundle"
7070

71+
<a name="default-options-for-foshttpcachebundle"></a>
7172
The following configuration is defined by default for FOSHttpCacheBundle.
7273
You should not override these settings unless you know what you are doing.
7374

@@ -125,16 +126,16 @@ This solution requires more effort (controller, VCL logic and adapting your own
125126
If you need to handle a paywall on a per-item basis, or example, do a
126127
lookup to backend for each URL where this is relevant.
127128

128-
You can find an example for paywall authorization in [FOSHTTPCache documentation.](https://foshttpcache.readthedocs.io/en/latest/user-context.html#alternative-for-paywalls-authorization-request)
129+
You can find an example for paywall authorization in [FOSHTTPCache documentation.](https://foshttpcache.readthedocs.io/en/stable/user-context.html#alternative-for-paywalls-authorization-request)
129130

130131
### Best practices for custom vary by logic
131132

132-
For information on how user context hashes are generated, see [FOSHttpCacheBundle documentation](https://foshttpcachebundle.readthedocs.io/en/latest/features/user-context.html#generating-hashes).
133+
For information on how user context hashes are generated, see [FOSHttpCacheBundle documentation](https://foshttpcachebundle.readthedocs.io/en/stable/features/user-context.html#generating-hashes).
133134

134135
[[= product_name =]] implements a custom context provider in order to make user context hash reflect the current User's Roles and Limitations.
135136
This is needed given [[= product_name =]]'s more complex permission model compared to Symfony's.
136137

137-
You can technically extend the user context hash by [implementing your own custom context provider(s)](https://foshttpcachebundle.readthedocs.io/en/latest/reference/configuration/user-context.html#custom-context-providers).
138+
You can technically extend the user context hash by [implementing your own custom context provider(s)](https://foshttpcachebundle.readthedocs.io/en/stable/reference/configuration/user-context.html#custom-context-providers).
138139
However, **this is strongly discouraged** as it means increasing the amount of cache variations
139140
stored in proxy for every single cache item, lowering cache hit ratio and increasing memory use.
140141

@@ -151,7 +152,7 @@ needs, and adapt the user context hash VCL logic to use the additional header.
151152

152153
To avoid overloading any application code, take advantage of Symfony's event system:
153154

154-
1\. Add a [Response event (`kernel.response`)](https://symfony.com/doc/5.4/reference/events.html#kernel-response) [listener or subscriber](https://symfony.com/doc/5.4/event_dispatcher.html) to add your own hash to `/_fos_user_context_hash`:
155+
1\. Add a [Response event (`kernel.response`)]([[= symfony_doc =]]/reference/events.html#kernel-response) [listener or subscriber]([[= symfony_doc =]]/event_dispatcher.html) to add your own hash to `/_fos_user_context_hash`:
155156

156157
```php
157158
public function addPreferenceHash(FilterResponseEvent $event)

docs/guide/cache/fastly.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Configure Fastly for use with Ibexa DXP.
55
# Configure and customize Fastly
66

77
You can configure Fastly by using API calls or through the Fastly Web Interface.
8-
Fastly provides a [Fastly CLI](https://developer.fastly.com/reference/cli/) for configuring Fastly through its API.
8+
Fastly provides a [Fastly CLI](https://www.fastly.com/documentation/reference/cli/) for configuring Fastly through its API.
99

1010
Ibexa Cloud is delivered with Fastly preconfigured.
1111
It means that you don't have to do any changes to the Fastly configuration to make your site work.
@@ -44,7 +44,7 @@ When you configure the Fastly CLI, use the credentials for the environment that
4444

4545
Use the commands below to install VCL configuration required for running Fastly with [[= product_name =]].
4646
You also need to set up domains, HTTPS and origin configuration (not covered here).
47-
All commands are explained in detail [below](#viewing-and-modifying-the-vcl-configuration):
47+
All commands are explained in detail [below](#view-and-modify-vcl-configuration):
4848

4949
``` bash
5050
fastly vcl custom create --name=ez_main.vcl --version=active --autoclone --content=vendor/ezsystems/ezplatform-http-cache-fastly/fastly/ez_main.vcl --main
@@ -335,11 +335,11 @@ diff -ruN generated_vcl_11_json_done generated_vcl_12_json_done
335335
336336
## Enable basic-auth on Fastly
337337
338-
To enable basic-auth, use [Fastly documentation](https://developer.fastly.com/solutions/examples/http-basic-auth) as an example.
338+
To enable basic-auth, use [Fastly documentation](https://www.fastly.com/documentation/solutions/examples/http-basic-auth/) as an example.
339339
340340
Follow the steps below.
341341
342-
Usernames and passwords can be stored inside the VCL file, but in this case credentials are stored in a [dictionary](https://docs.fastly.com/en/guides/working-with-dictionaries-using-the-web-interface#working-with-dictionaries-using-vcl-snippets).
342+
Usernames and passwords can be stored inside the VCL file, but in this case credentials are stored in a [dictionary](https://docs.fastly.com/en/guides/working-with-dictionaries#working-with-dictionaries-using-vcl-snippets).
343343
344344
!!! note
345345
To make this example work, you must run [[= product_name =]] in version 3.3.16 or later, or 4.5.
@@ -484,5 +484,3 @@ fastly vcl snippet create --name="BasicAuth recv" --version=active --autoclone -
484484
fastly vcl snippet create --name="BasicAuth error" --version=latest --priority 100 --type error --content=snippet_basic_auth_error.vcl
485485
fastly service-version activate --version=latest
486486
```
487-
488-

docs/guide/cache/http_cache.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ to make Varnish and Fastly act as the view cache for the system.
99
This and other features allow [[= product_name =]] to be scaled up to serve high traffic websites and applications.
1010

1111
HTTP cache is handled by the [ezplatform-http-cache](https://github.com/ezsystems/ezplatform-http-cache) bundle,
12-
which extends [friendsofsymfony/http-cache-bundle](https://foshttpcachebundle.readthedocs.io/en/2.8.0/),
13-
a Symfony community bundle that in turn extends [Symfony HTTP cache](http://symfony.com/doc/5.1/http_cache.html).
12+
which extends [friendsofsymfony/http-cache-bundle](https://foshttpcachebundle.readthedocs.io/en/stable/),
13+
a Symfony community bundle that in turn extends [Symfony HTTP cache](https://symfony.com/doc/5.x/http_cache.html).
1414

1515
For content view responses coming from [[= product_name =]] itself, this means that:
1616

docs/guide/cache/http_cache_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ As the system takes care of purges, the cache should not become stale with the e
2929
A few redirect and error pages are served through the content view system. If you set a high `default_ttl`, they can also be served from cache.
3030

3131
To avoid this, the installation ships with configuration to match these specific situations and set a much lower TTL.
32-
[FOSHttpCacheBundle matching rules](http://foshttpcachebundle.readthedocs.io/en/2.8.0/reference/configuration/headers.html) enables you to specify a different TTL:
32+
[FOSHttpCacheBundle matching rules](https://foshttpcachebundle.readthedocs.io/en/stable/reference/configuration/headers.html) enables you to specify a different TTL:
3333

3434
``` yaml
3535
fos_http_cache:

docs/guide/cache/symfony_reverse_proxy.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ For more information on how to configure Fastly with [[= product_name =]], see [
6161

6262
Support for Fastly Shielding was added in [[= product_name =]] v3.3.24 and v4.1.6.
6363

64-
When you extend [FOSHttpCacheBundle](https://foshttpcachebundle.readthedocs.io/en/2.9.1/),
65-
you can also adapt your VCL further with [FOSHttpCache documentation](http://foshttpcache.readthedocs.org/en/latest/varnish-configuration.html)
64+
When you extend [FOSHttpCacheBundle](https://foshttpcachebundle.readthedocs.io/en/stable/),
65+
you can also adapt your VCL further with [FOSHttpCache documentation](https://foshttpcache.readthedocs.io/en/stable/varnish-configuration.html)
6666
to use additional features.
6767

6868
## Configure Varnish and Fastly
@@ -77,7 +77,7 @@ Failing to configure reverse proxies correctly may introduce several problems, i
7777

7878
### Configure Symfony front controller
7979

80-
You need to consider your `TrustedProxy` configuration when you use Symfony [behind a load balancer or a reverse proxy.](https://symfony.com/doc/5.1/deployment/proxies.html)
80+
You need to consider your `TrustedProxy` configuration when you use Symfony [behind a load balancer or a reverse proxy.](https://symfony.com/doc/5.x/deployment/proxies.html)
8181

8282
Set the following environment variable:
8383
- `TRUSTED_PROXIES`: String with trusted IP, multiple proxies can be configured with a comma, for example, `TRUSTED_PROXIES="192.0.0.1,10.0.0.0/8"`
@@ -91,7 +91,7 @@ framework:
9191
9292
!!! caution "Careful when trusting dynamic IP using `REMOTE_ADDR` value or similar"
9393

94-
On Platform.sh, Varnish does not have a static IP, like with [AWS LB](https://symfony.com/doc/5.1/deployment/proxies.html#but-what-if-the-ip-of-my-reverse-proxy-changes-constantly).
94+
On Platform.sh, Varnish does not have a static IP, like with [AWS LB](https://symfony.com/doc/5.x/deployment/proxies.html#but-what-if-the-ip-of-my-reverse-proxy-changes-constantly).
9595
For this reason, the `TRUSTED_PROXIES` env variable supports being set to value `REMOTE_ADDR`, which is equal to:
9696

9797
```php
@@ -104,7 +104,7 @@ framework:
104104
Make sure that **all** traffic always comes from the trusted proxy/load balancer,
105105
and that there is no other way to configure it.
106106

107-
When using Fastly, you need to set `trusted_proxies` according to the [IP ranges used by Fastly](https://docs.fastly.com/en/guides/accessing-fastlys-ip-ranges).
107+
When using Fastly, you need to set `trusted_proxies` according to the [IP ranges used by Fastly](https://www.fastly.com/documentation/reference/api/utils/public-ip-list/).
108108

109109
!!! tip
110110

@@ -194,7 +194,7 @@ For more information about configuring Captcha fields, see [Captcha field](../..
194194
### Use Fastly as HttpCache proxy
195195

196196
[Fastly](https://www.fastly.com/) delivers Varnish as a CDN service and is supported with [[= product_name =]].
197-
To learn how it works, see [Fastly documentation](https://docs.fastly.com/guides/basic-concepts/how-fastlys-cdn-service-works).
197+
To learn how it works, see [Fastly documentation](https://docs.fastly.com/en/guides/using-fastlys-global-pop-network).
198198

199199
#### Configure Fastly in YML
200200

@@ -230,16 +230,16 @@ FASTLY_KEY="token"
230230

231231
#### Configure Fastly on Platform.sh
232232

233-
If you use Platform.sh, it is recommended to configure all environment variables through [Platform.sh variables](https://docs.platform.sh/frameworks/ibexa/fastly.html).
233+
If you use Platform.sh, it is recommended to configure all environment variables through [Platform.sh variables](https://docs.platform.sh/guides/ibexa/fastly.html).
234234
In [[= product_name =]], Varnish is enabled by default. To use Fastly, first you must
235-
[disable Varnish](https://docs.platform.sh/frameworks/ibexa/fastly.html#remove-varnish-configuration)
235+
[disable Varnish](https://docs.platform.sh/guides/ibexa/fastly.html#remove-varnish-configuration)
236236

237237
#### Get Fastly service ID and API token
238238

239-
To get the service ID, log in to http://fastly.com. In the upper menu, click the **CONFIGURE** tab.
239+
To get the service ID, log in to https://www.fastly.com/. In the upper menu, click the **CONFIGURE** tab.
240240
The service ID is displayed next to the name of your service on any page.
241241

242-
For instructions on how to generate a Fastly API token, see [the Fastly guide](https://docs.fastly.com/guides/account-management-and-security/using-api-tokens).
242+
For instructions on how to generate a Fastly API token, see [the Fastly guide](https://docs.fastly.com/en/guides/using-api-tokens).
243243
The API token needs the `purge_all` an `purge_select` scopes.
244244

245245
### Configuration examples
@@ -272,7 +272,7 @@ fastcgi_param HTTPCACHE_PURGE_SERVER "http://varnish:80";
272272

273273
Example for Platform.sh:
274274

275-
You can configure environment variables through [Platform.sh variables](https://docs.platform.sh/frameworks/ibexa/fastly.html).
275+
You can configure environment variables through [Platform.sh variables](https://docs.platform.sh/guides/ibexa/fastly.html).
276276

277277
!!! tip
278278

0 commit comments

Comments
 (0)