Skip to content

Commit

Permalink
HD-22392 Added Osano cookie consent (#523)
Browse files Browse the repository at this point in the history
modified:   _resource/overrides/main.html
	new file:   docs/css/osano.css
	new file:   docs/js/consent.js
	modified:   mkdocs-base.yml
  • Loading branch information
nastena1606 authored Feb 27, 2024
1 parent 66c726a commit 53ba54b
Show file tree
Hide file tree
Showing 5 changed files with 220 additions and 8 deletions.
5 changes: 5 additions & 0 deletions _resource/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ <h4>Contact Us </h4>
</div>
{%- endmacro %}

{% block scripts %}
<script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>
{{ super() }}
{% endblock %}

{% block extrahead %}
{{ super() }}
{% set title = config.site_name %}
Expand Down
2 changes: 1 addition & 1 deletion _resource/overrides/partials/copyright.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
-#}
<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') }}
<a href='https://percona.com' target='_blank'>Percona LLC and/or its affiliates, </a> &copy; {{ build_date_utc.strftime('%Y') }}<a href="#" onclick="Osano.cm.showDrawer('osano-cm-dom-info-dialog-open')">Cookie Preferences</a>
</div>
{% if not config.extra.generator == false %}
Made with
Expand Down
206 changes: 206 additions & 0 deletions docs/css/osano.css
Original file line number Diff line number Diff line change
@@ -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;
}
}
6 changes: 6 additions & 0 deletions docs/js/consent.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
var consent = __md_get("__consent")
if (consent && consent.custom) {
/* The user accepted the cookie */
} else {
/* The user rejected the cookie */
}
9 changes: 2 additions & 7 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,12 @@ extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
- css/percona.css
- css/extra.css
- css/osano.css

extra_javascript:
- js/version-select.js
- js/promptremover.js
- js/consent.css

markdown_extensions:
attr_list: {}
Expand Down Expand Up @@ -128,13 +130,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>.
postgresrecommended: 16

nav:
Expand Down

0 comments on commit 53ba54b

Please sign in to comment.