Skip to content

Commit

Permalink
HD-22392 Added Osano cookie consent
Browse files Browse the repository at this point in the history
modified:   _resource/overrides/main.html
	modified:   docs/index.md
	new file:   docs/js/consent.js
	modified:   mkdocs-base.yml
  • Loading branch information
nastena1606 committed Feb 12, 2024
1 parent 7c62233 commit 20aaabb
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 6 deletions.
2 changes: 1 addition & 1 deletion _resource/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
{# Import the theme's layout. #}
{% extends "base.html" %}


{% 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="#__consent">Cookie Consent</a>
</div>
{% if not config.extra.generator == false %}
Made with
Expand Down
65 changes: 65 additions & 0 deletions _resource/overrides/partials/javascripts/consent.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<!--
Copyright (c) 2016-2024 Martin Donath <[email protected]>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
-->

<!-- CUSTOM CODE -->
<script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>
-->

<!-- User-preference: consent -->
<script>
var consent = __md_get("__consent")
if (consent) {
for (var input of document.forms.consent.elements)
if (input.name)
input.checked = consent[input.name] || false

/* Show consent with a small delay, but not if browsing locally */
} else if (location.protocol !== "file:") {
setTimeout(function() {
var el = document.querySelector("[data-md-component=consent]")
el.hidden = false
}, 250)
}

/* Intercept submission of consent form */
var form = document.forms.consent
for (var action of ["submit", "reset"])
form.addEventListener(action, function(ev) {
ev.preventDefault()

/* Reject all cookies */
if (ev.type === "reset")
for (var input of document.forms.consent.elements)
if (input.name)
input.checked = false

/* Grab and serialize form data */
__md_set("__consent", Object.fromEntries(
Array.from(new FormData(form).keys())
.map(function(key) { return [key, true] })
))

/* Remove anchor to omit consent from reappearing and reload */
location.hash = '';
location.reload()
})
</script>
1 change: 0 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,4 +52,3 @@ Our comprehensive resources will help you overcome challenges, from everyday iss




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 */
}
1 change: 1 addition & 0 deletions docs/js/osano.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>
8 changes: 5 additions & 3 deletions mkdocs-base.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ site_name: Percona Backup for MongoDB
site_description: documentation
site_author: Percona LLC
copyright: >
<a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2023 — <a href="#__consent">Cookie Consent</a>
<a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2024 — <a href="#__consent">Cookie Consent</a>
repo_name: percona/pbm-docs
repo_url: https://github.com/percona/pbm-docs
Expand Down Expand Up @@ -55,7 +54,9 @@ extra_css:

extra_javascript:
- js/promptremover.js
- js/feedback.js
# - js/osano.js
- js/consent.js
# - js/feedback.js

markdown_extensions:
abbr: {}
Expand Down Expand Up @@ -147,6 +148,7 @@ extra:
cookies:
analytics: Google Analytics
github: Github
custom: Osano
actions:
- manage
- accept
Expand Down

0 comments on commit 20aaabb

Please sign in to comment.