Skip to content

Commit 91abd33

Browse files
committed
Adapt our docs to 'type: express' being the default for cookie consent now
1 parent 3dd63ff commit 91abd33

File tree

3 files changed

+13
-9
lines changed

3 files changed

+13
-9
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
Quarto 1.9 includes the following new features:
22

3+
- [Privacy-first cookie consent](/docs/websites/website-tools.qmd#cookie-consent): The default for cookie consent has changed to `type: express`, providing opt-in consent that blocks cookies until users explicitly agree. This privacy-conscious default is designed with modern privacy regulations in mind.
4+
35
- [`aria-label` for videos](/docs/authoring/videos.qmd#accessibility-label): Improve accessibility of embedded videos by providing custom descriptive labels for screen readers instead of the default "Video Player" label.

docs/websites/website-search.qmd

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -171,11 +171,11 @@ You can confirm that events are being properly sent to Algolia using the [Event
171171

172172
#### Cookie Consent and User Tracking
173173

174-
Algolia Insights uses user tokens to track click and conversion events. By default, Quarto uses a **privacy-first approach** that does not store cookies:
174+
Algolia Insights uses user tokens to track click and conversion events. Quarto uses a **privacy-first approach** for handling cookies:
175175

176-
- **Default behavior (no cookies)**: A random session token is generated for each browser session. This allows tracking of search interactions during a single visit without storing persistent cookies. This default is compliant with privacy regulations like GDPR.
176+
- **Without cookie consent enabled**: A random session token is generated for each browser session. This allows tracking of search interactions during a single visit without storing persistent cookies. This privacy-first approach avoids persistent cookies entirely.
177177

178-
- **Persistent tracking (with cookies)**: To track users across multiple sessions, you must enable [cookie consent](website-tools.qmd#cookie-consent). When cookie consent is enabled, Algolia will only use cookies after the user grants "tracking" consent:
178+
- **With cookie consent enabled**: When you enable [cookie consent](website-tools.qmd#cookie-consent), cookies are blocked by default until the user expressly grants consent. After the user grants "tracking" consent, Algolia will use cookies to maintain an anonymous user identifier across sessions:
179179

180180
``` yaml
181181
website:
@@ -190,10 +190,12 @@ website:
190190

191191
With this configuration, the Algolia Insights API will use cookies to maintain an anonymous user identifier across sessions, but only after the user has explicitly granted consent.
192192

193-
::: {.callout-note}
194-
## Privacy and Compliance
193+
::: {.callout-important}
194+
## Privacy Regulations
195195

196-
The default session-only tracking provides meaningful analytics about search usage patterns while respecting user privacy. Enabling persistent cookie tracking may require compliance with privacy regulations in your jurisdiction, which is why Quarto requires explicit configuration of cookie consent.
196+
The default session-only tracking (without cookie consent) provides meaningful analytics about search usage patterns without using persistent cookies. When cookie consent is enabled, Quarto uses an opt-in approach (express consent) by default, blocking cookies until the user explicitly agrees.
197+
198+
While these features are designed with privacy regulations in mind, website owners should consult with legal counsel to ensure their specific implementation meets applicable privacy laws and regulations in their jurisdiction.
197199
:::
198200

199201
### Advanced Configuration

docs/websites/website-tools.qmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -272,9 +272,9 @@ You can further customize the appearance and behavior of the consent using the f
272272
+==============+======================================================================================================================================================================================+
273273
| `type` | The type of consent that should be requested, using one of these two values: |
274274
| | |
275-
| | **implied -** (default) This will notify the user that the site uses cookies and permit them to change preferences, but not block cookies unless the user changes their preferences. |
275+
| | **express -** (default) This will block cookies until the user expressly agrees to allow them (or continue blocking them if the user doesn't agree). |
276276
| | |
277-
| | **express -** This will block cookies until the user expressly agrees to allow them (or continue blocking them if the user doesn't agree). |
277+
| | **implied -** This will notify the user that the site uses cookies and permit them to change preferences, but not block cookies unless the user changes their preferences. |
278278
+--------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
279279
| `style` | The style of the consent banner that is displayed: |
280280
| | |
@@ -321,7 +321,7 @@ website:
321321
analytics-events: true
322322
```
323323

324-
Note that with cookie consent enabled, both Google Analytics and Algolia search analytics will only use cookies after the user has granted "tracking" consent. Without cookie consent enabled, Algolia will use session-only tracking without cookies. See [Algolia Insights](/docs/websites/website-search.qmd#algolia-insights) for more details.
324+
Note that with cookie consent enabled (which uses opt-in "express" consent by default), both Google Analytics and Algolia search analytics will only use cookies after the user has granted "tracking" consent. Without cookie consent enabled, Algolia will use session-only tracking without cookies. See [Algolia Insights](/docs/websites/website-search.qmd#algolia-insights) for more details.
325325

326326
### Cookie Preferences
327327

0 commit comments

Comments
 (0)