Cookie consent requested for each version of the documentation

[mattdibi]

Hello there!

We recently setup site analytics and configured cookie consent on our documentation page.

We're using mike for versioning as per Material for MkDocs documentation.

We're currently encountering the issue where cookie consent is asked every time the user switches version. Is this supposed to happen? Is there any way around it? Did we configure something wrong?

Feel free to ask any additional detail about the issue.

[alexvoss]

Hm, interesting. Can you point us to the documentation where this happens? What are the path attributes of the cookies that are set? Does site analytics have a cookie for each version? Can you point us to your mkdocs.yml so we can see which cookies you have configured?

[alexvoss]

Never mind, it is the Eclipse Kura Documentation, right?

[alexvoss]

So, the problem seems to be that the key for the cookie consent data in the browser's local storage contains part of the path. That is what makes the consent appear for each version. The same kind of problem affects the palette switching (dark mode).

[mattdibi]

Hi there, thanks for the feedback!

Yeah, that seems to be the case. I thought the palette switching issue was the expected behavior 🤔

Is there a way to avoid this? A custom cookie? Has this anything to do with mike's "alias_type"?

[kamilkrzyskow]

@mattdibi
Try setting the config.extra.scope to /kura/.

extra:
  scope: "/kura/"

mkdocs-material/src/templates/partials/javascripts/base.html

Line 30 in 454af62

__md_scope = new URL("{{ config.extra.scope | d(base_url) }}", location)

This should result in new URL("/kura/", location), and always resolve to https://eclipse-kura.github.io/kura/

[mattdibi]

From https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#scope

There might be a use case, where you want to share user-level settings like the selected color palette, or cookie consent across all projects. To do so, add the following lines to mkdocs.yml:

This looks exactly what we need! Thanks @kamilkrzyskow I'll test this out and report back the results.

[alexvoss]

Thanks, @kamilkrzyskow for finding that. I am sure I looked at the file but had to take a call so you beat me to it - again!

[mattdibi]

@alexvoss @kamilkrzyskow Thanks both of you for the help!

[mattdibi]

Hi there @alexvoss @kamilkrzyskow, sorry for pinging you again.

I deployed the scope configuration update on our documentation and the cookie consent is preserved between versions but, unfortunately I didn't realise this before, this broke our version warning banner. Is the version banner relying on the scope to infer the currently viewed version? Is there a way to preserve the banner and the cookie consent sharing?

Our banner can be found here. We're using latest as our default version.

Let me know if you want me to open a separate discussion/issue.