Skip to content

Update ARCHITECTURE.md for new cookie consent provider #1790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Miranda Wilson (mscwilson) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update ARCHITECTURE.md for new cookie consent provider #1790

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ARCHITECTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,11 +88,11 @@ The plugin uses the title, description, and keywords from the page frontmatter.

## Cookies and tracking

The site uses [`cookie-though`](https://github.com/Cookie-Though/cookie-though) for consent management. It's initialized in `cookieConsent.js`.
The site uses [Ketch](https://www.ketch.com/) for consent management. The Ketch boot script is injected as an inline `<script>` tag via the `headTags` config in `docusaurus.config.ts`.

User preferences are stored in a cookie keyed by `COOKIE_PREF_KEY`, with per-policy flags (`analytics:0` / `analytics:1`).
User preferences are stored in the `_ketch_consent_v1_` cookie as a base64-encoded JSON object. Tracking scripts subscribe to consent changes via `window.ketch('on', 'consent', ...)` and read `consent.purposes.analytics` to determine whether analytics tracking is granted.

The user-facing preferences page is `src/pages/cookie-preferences.mdx`, linked to from the site footer.
The user-facing preferences page is `src/pages/cookie-preferences.md`, linked to from the site footer. The **Preferences** button on that page calls `window.ketch('showPreferences')` to open the Ketch consent modal.

### Tracking scripts

Expand Down
Loading