From 39c7a5100a62fbc0f18832b1c304cd7a24a01eaa Mon Sep 17 00:00:00 2001 From: Anastasia Alexandrova Date: Tue, 27 Feb 2024 10:40:24 +0100 Subject: [PATCH] HD-22392 Added Osano cookie consent (#155) HD-22392 Added Osano cookie consent modified: _resource/overrides/main.html modified: docs/index.md new file: docs/js/consent.js modified: mkdocs-base.yml --- _resource/overrides/main.html | 6 +- _resource/overrides/partials/copyright.html | 3 +- docs/css/osano.css | 206 ++++++++++++++++++++ docs/index.md | 1 - docs/js/consent.js | 6 + docs/js/feedback.js | 11 -- mkdocs-base.yml | 35 ++-- 7 files changed, 237 insertions(+), 31 deletions(-) create mode 100644 docs/css/osano.css create mode 100644 docs/js/consent.js delete mode 100644 docs/js/feedback.js diff --git a/_resource/overrides/main.html b/_resource/overrides/main.html index d9e06b8c..f2ba683d 100644 --- a/_resource/overrides/main.html +++ b/_resource/overrides/main.html @@ -6,7 +6,11 @@ {# Import the theme's layout. #} {% extends "base.html" %} - +{% block scripts %} + +{{ super() }} +{% endblock %} + {% block extrahead %} {{ super() }} {% set title = config.site_name %} diff --git a/_resource/overrides/partials/copyright.html b/_resource/overrides/partials/copyright.html index 4dc9e364..383b48fe 100644 --- a/_resource/overrides/partials/copyright.html +++ b/_resource/overrides/partials/copyright.html @@ -3,7 +3,8 @@ -#}
- Percona LLC and/or its affiliates, © {{ build_date_utc.strftime('%Y') }} + Percona LLC and/or its affiliates, © {{ build_date_utc.strftime('%Y') }} + — Cookie Preferences
{% if not config.extra.generator == false %} Made with diff --git a/docs/css/osano.css b/docs/css/osano.css new file mode 100644 index 00000000..b89fa6ac --- /dev/null +++ b/docs/css/osano.css @@ -0,0 +1,206 @@ +/* General styling */ + +.osano-cm-window { + font-family: "Roboto", Arial, Helvetica, sans-serif; + font-size: 20px; +} +.osano-cm-dialog--type_bar { + justify-content: center; + color: #000; + background: #fff; + box-shadow: 0 0 0 100vmax rgba(0,0,0,0.66) +} + +.osano-cm-dialog { + font-size: 0.75em; + padding: 2em 1em; + color: var(--md-typeset-color); + background: var(--md-footer-bg-color--dark); +} +.osano-cm-header, +.osano-cm-info-dialog-header { + background: var(--md-default-bg-color); +} +.osano-cm-link, +.osano-cm-disclosure__toggle, +.osano-cm-expansion-panel__toggle { + color: var(--md-typeset-a-color); +} +.osano-cm-link:hover, +.osano-cm-link:active, +.osano-cm-disclosure__toggle:hover, +.osano-cm-disclosure__toggle:active, +.osano-cm-disclosure__toggle:focus, +.osano-cm-expansion-panel__toggle:hover, +.osano-cm-expansion-panel__toggle:active, +.osano-cm-expansion-panel__toggle:focus { + color: var(--md-accent-fg-color); +} +.osano-cm-drawer-links { + display: inline-block; +} +.osano-cm-link.osano-cm-storage-policy { + margin-right: 0.5em; +} +.osano-cm-description { + font-weight: 400; +} +.osano-cm-info { + color: var(--md-typeset-color); + background: var(--md-default-bg-color); + box-shadow: unset; +} +.osano-cm-dialog--hidden, +.osano-cm-info-dialog--hidden { + transition-delay: 0ms, 0ms; +} +.osano-cm-disclosure { + padding-top: 0; +} +.osano-cm-disclosure--collapse { + border-color: var(--md-default-fg-color--lightest); +} + +/* Closing button */ + +.osano-cm-dialog__close, +.osano-cm-dialog__close:hover, +.osano-cm-dialog__close:focus, +.osano-cm-dialog__close:focus:hover { + color: var(--md-typeset-color); + stroke: var(--md-typeset-color); + border-color: transparent; + outline: initial; +} +.osano-cm-dialog__close:focus { + background-color: var(--md-default-fg-color--lightest); +} +.osano-cm-close { + padding: 0.25em; + margin: 0.5em; + stroke-width: 2px; + border-width: 2px; + opacity: 0.4; +} +.osano-cm-close:focus, +.osano-cm-close:hover { + stroke-width: 2px; + opacity: 1; +} +.osano-cm-info-dialog-header__close:focus { + background-color: var(--md-typeset-color); +} + +/* Switch buttons */ + +.osano-cm-toggle__switch { + background-color: var(--md-default-fg-color--lightest); + transition: all 0.1s ease-out; +} +.osano-cm-toggle__input:hover + .osano-cm-toggle__switch { + background-color: var(--md-default-fg-color--light); + border-color: transparent; +} +.osano-cm-toggle__input:focus + .osano-cm-toggle__switch { + background-color: var(--md-default-fg-color--lightest); + border-color: transparent; +} +.osano-cm-toggle__input:focus + .osano-cm-toggle__switch::before { + border-color: var(--md-accent-fg-color); +} +.osano-cm-toggle__input:focus:hover + .osano-cm-toggle__switch { + background-color: var(--md-default-fg-color--light); + border-color: transparent; +} +.osano-cm-toggle__input:checked + .osano-cm-toggle__switch, +.osano-cm-toggle__input:disabled:checked + .osano-cm-toggle__switch { + background-color: var(--md-primary-fg-color); + border-color: var(--md-primary-fg-color); +} +.osano-cm-toggle__input:checked:hover + .osano-cm-toggle__switch, +.osano-cm-toggle__input:disabled:checked:hover + .osano-cm-toggle__switch { + background-color: var(--md-accent-fg-color); + border-color: var(--md-accent-fg-color); +} +.osano-cm-toggle__input:checked:focus + .osano-cm-toggle__switch, +.osano-cm-toggle__input:disabled:checked:focus + .osano-cm-toggle__switch { + background-color: var(--md-primary-fg-color); + border-color: var(--md-primary-fg-color); +} +.osano-cm-toggle__input:checked:focus + .osano-cm-toggle__switch::before { + border-color: var(--md-accent-fg-color); +} +.osano-cm-toggle__input:checked:focus:hover + .osano-cm-toggle__switch { + background-color: var(--md-accent-fg-color); + border-color: var(--md-accent-fg-color); +} +.osano-cm-toggle__input:disabled:checked + .osano-cm-toggle__switch, +.osano-cm-toggle__input:disabled:checked:focus + .osano-cm-toggle__switch, +.osano-cm-toggle__input:disabled:checked:hover + .osano-cm-toggle__switch { + opacity: 0.3; + cursor: not-allowed; +} +.osano-cm-toggle__input + .osano-cm-toggle__switch::after { + background-color: var(--md-default-bg-color) !important; +} +.osano-cm-toggle__input:checked + .osano-cm-toggle__switch::before { + border-color: transparent; +} +.osano-cm-list { + gap: 0.75em; +} + +/* CTA Buttons */ + +.osano-cm-dialog__buttons { + display: flex; + justify-content: flex-start; + flex-wrap: wrap; + gap: 0.5em 0.75em; +} +.osano-cm-button { + font-family: var(--fHeading); + flex: 1 1 20em; + color: var(--md-primary-fg-color); + background-color: transparent; + border-width: 2px; + border-color: var(--md-primary-fg-color); + border-radius: 20em; +} +.osano-cm-button:hover { + color: var(--md-accent-fg-color); + background-color: transparent; + border-color: var(--md-accent-fg-color); +} + +/* Widget */ + +.osano-cm-widget { + display: none; + opacity: 0.5; + border-radius: 10em; + bottom: 3em; +} +.osano-cm-widget:focus { + outline-offset: 0.125em; + outline-color: var(--md-default-fg-color--lighter); + outline-width: 0.1875em; +} +.osano-cm-widget__outline { + fill: transparent; + stroke: var(--md-typeset-color); +} +.osano-cm-widget__dot { + fill: var(--md-typeset-color); +} + +/* Media conditions */ + +@media screen and (min-width: 768px) { + .osano-cm-dialog--type_bar .osano-cm-dialog__content { + max-width: 50em; + } + .osano-cm-dialog--type_bar .osano-cm-dialog__buttons { + max-width: 20em; + } +} \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index ca6b1cf2..de411052 100644 --- a/docs/index.md +++ b/docs/index.md @@ -52,4 +52,3 @@ Our comprehensive resources will help you overcome challenges, from everyday iss - diff --git a/docs/js/consent.js b/docs/js/consent.js new file mode 100644 index 00000000..b6f8a8ac --- /dev/null +++ b/docs/js/consent.js @@ -0,0 +1,6 @@ +var consent = __md_get("__consent") +if (consent && consent.custom) { + /* The user accepted the cookie */ +} else { + /* The user rejected the cookie */ +} \ No newline at end of file diff --git a/docs/js/feedback.js b/docs/js/feedback.js deleted file mode 100644 index fcf4709a..00000000 --- a/docs/js/feedback.js +++ /dev/null @@ -1,11 +0,0 @@ -var feedback = document.forms.feedback -feedback.addEventListener("submit", function(ev) { - ev.preventDefault() - - /* Retrieve page and feedback value */ - var page = document.location.pathname - var data = ev.submitter.getAttribute("data-md-value") - - /* Send feedback value */ - console.log(page, data) -}) diff --git a/mkdocs-base.yml b/mkdocs-base.yml index 374d5c89..d8d06ecf 100644 --- a/mkdocs-base.yml +++ b/mkdocs-base.yml @@ -4,9 +4,8 @@ site_name: Percona Backup for MongoDB site_description: documentation site_author: Percona LLC copyright: > - Percona LLC and/or its affiliates © 2023 — Cookie Consent - - + Percona LLC and/or its affiliates © 2024 + — Cookie Preferences repo_name: percona/pbm-docs repo_url: https://github.com/percona/pbm-docs edit_uri: edit/main/docs/ @@ -52,10 +51,11 @@ extra_css: - css/percona.css - css/extra.css - css/design.css + - css/osano.css extra_javascript: - js/promptremover.js - - js/feedback.js + - js/consent.js markdown_extensions: abbr: {} @@ -137,19 +137,20 @@ plugins: extra: homepage: https://docs.percona.com - consent: - title: Cookie consent - description: >- - We use cookies to recognize your repeated visits and preferences, as well - as to measure the effectiveness of our documentation and whether users - find what they're searching for. With your consent, you're helping us to - make our documentation better. Read more about Percona Cookie Policy. - cookies: - analytics: Google Analytics - github: Github - actions: - - manage - - accept +# consent: +# title: Cookie consent +# description: >- +# We use cookies to recognize your repeated visits and preferences, as well +# as to measure the effectiveness of our documentation and whether users +# find what they're searching for. With your consent, you're helping us to +# make our documentation better. Read more about Percona Cookie Policy. +# cookies: +# analytics: Google Analytics +# github: Github +# custom: Osano +# actions: +# - manage +# - accept nav: - Home: index.md