DOCS-106 Implement Osano Cookie consent in docs.percona.com + remove …

…scarf (#137) modified: _resource/overrides/main.html modified: _resource/overrides/partials/copyright.html new file: docs/css/osano.css new file: docs/features/consent.js new file: docs/js/consent.js modified: mkdocs-base.yml
percona · Mar 7, 2024 · 974ea39 · 974ea39
1 parent ebf3870
commit 974ea39
Show file tree

Hide file tree

Showing 6 changed files with 227 additions and 12 deletions.
diff --git a/_resource/overrides/main.html b/_resource/overrides/main.html
@@ -6,6 +6,11 @@
 {# Import the theme's layout. #}
 {% extends "base.html" %}
 
+{% block scripts %}
+<script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>
+{{ super() }}
+{% endblock %}
+
 {%- macro relbar2 () %}
 <div class="md-relbar2__inner md-grid">
 <div class="md-content">
@@ -14,7 +19,6 @@ <h3>Contact us </h3>
     <p>For free technical help, visit the Percona <a class="reference external" href="https://forums.percona.com/c/mysql-mariadb/percona-xtradb-cluster-5-x/12" target="_blank">Community Forum</a>.<br>
       <p>To report bugs or submit feature requests, open a <a class="reference external" href="https://jira.percona.com/projects/PXC/issues" target="_blank">JIRA</a> ticket.<br>
        <p>For paid <a class="reference external" href="https://www.percona.com/services/support"> support </a> and <a class="reference external" href="https://www.percona.com/services/managed-services"> managed </a> or <a class="reference external" href="https://www.percona.com/services/consulting">consulting services </a>, contact <a class="reference external" href="https://www.percona.com/about-percona/contact" target="_blank">Percona Sales</a>.</p>
-       <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=5aeb0baf-3caa-4b26-b583-aba985f5bfd7" />
       </article>
 </div>
 </div>

diff --git a/_resource/overrides/partials/copyright.html b/_resource/overrides/partials/copyright.html
@@ -4,7 +4,8 @@
 <div class="md-copyright">
     <div class="md-copyright__highlight">
  <a href='https://percona.com' target='_blank'>Percona LLC and/or its affiliates, </a> &copy; {{ build_date_utc.strftime('%Y') }}
-    </div>
+ <a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-dialog-open')">Cookie Preferences</a>    
+</div>
   {% if not config.extra.generator == false %}
     Made with
     <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">

diff --git a/docs/css/osano.css 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;
+    }
+}
diff --git a/docs/features/consent.js b/docs/features/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 */
+}
diff --git a/docs/js/consent.js 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 */
+}
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -46,7 +46,8 @@ extra_css:
   - https://unicons.iconscout.com/release/v3.0.3/css/line.css
   - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
   - css/percona.css
-  - css/nocopy.css\
+  - css/nocopy.css
+  - css/osano.css
   - css/extra.css
 
 #Copyright
@@ -121,15 +122,6 @@ extra:
     provider: mike
   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 <a class="reference external" href="https://www.percona.com/20180524-cookie-policy" target="_blank">Percona Cookie Policy</a>.
-  edit_page_text: '<i class="uil uil-pen"></i> <b>Edit this page</b>'
-  updated_text: '<i class="uil uil-refresh"></i> Page updated'
 
 nav:
   - Home: index.md