Skip to content

Commit

Permalink
[IMP] website_cookiebot: pre-commit auto fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
adriresu committed Jun 27, 2024
1 parent 0fe1b4d commit 4794687
Show file tree
Hide file tree
Showing 10 changed files with 78 additions and 63 deletions.
72 changes: 40 additions & 32 deletions website_cookiebot/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,20 @@ Website Cookiebot
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwebsite-lightgray.png?logo=github
:target: https://github.com/OCA/website/tree/16.0/website_cookiebot
:target: https://github.com/OCA/website/tree/17.0/website_cookiebot
:alt: OCA/website
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/website-16-0/website-16-0-website_cookiebot
:target: https://translation.odoo-community.org/projects/website-17-0/website-17-0-website_cookiebot
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/website&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/website&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module integrates Odoo website with `Cookiebot <https://www.cookiebot.com/>`__,
to ask for consent before installing cookies on users' browsers.
This module integrates Odoo website with
`Cookiebot <https://www.cookiebot.com/>`__, to ask for consent before
installing cookies on users' browsers.

**Table of contents**

Expand All @@ -41,63 +42,70 @@ Configuration

To configure this module, you need to:

#. Go to *Website > Configuration > Settings*
#. Under *Select the Website to Configure*, choose a website.
#. In the privacy section enable *Cookiebot* option.
#. Click on *`How to configure Cookiebot <https://cookiebot.com/goto/help>`__*.
#. Follow the instructions, except step 3 (do not insert the ``<script>`` tags, the module will do it for you).
#. Fill in your *Domain Group ID* (e.g. ``00000000-0000-0000-0000-000000000000``)
#. Click on the *Save* button.
1. Go to *Website > Configuration > Settings*
2. Under *Select the Website to Configure*, choose a website.
3. In the privacy section enable *Cookiebot* option.
4. Click on *\`How to configure Cookiebot
<*\ `https://cookiebot.com/goto/help\\>\\`\\\_\\ <https://cookiebot.com/goto/help\>\`\_\>`__\ *\ \_*.
5. Follow the instructions, except step 3 (do not insert the
``<script>`` tags, the module will do it for you).
6. Fill in your *Domain Group ID* (e.g.
``00000000-0000-0000-0000-000000000000``)
7. Click on the *Save* button.

⚠️ **This module will do nothing unless configured and linked with Cookiebot.**
⚠️ **This module will do nothing unless configured and linked with
Cookiebot.**

Usage
=====

To use this module, once configured for your website, you just need to browse
that website. You will see the Cookiebot consent banner, and a *Cookies Policy*
link in the footer.
To use this module, once configured for your website, you just need to
browse that website. You will see the Cookiebot consent banner, and a
*Cookies Policy* link in the footer.

.. figure:: https://raw.githubusercontent.com/OCA/website/16.0/website_cookiebot/static/description/screenshot.png
:alt: Cookiebot consent banner
|image1|

Remember that, if your browser is configured to block 3rd party cookies,
trackers or consent banners, you won't notice the change. Disable any of those
protections to experiment the benefits.
trackers or consent banners, you won't notice the change. Disable any of
those protections to experiment the benefits.

.. |image1| image:: https://raw.githubusercontent.com/OCA/website/17.0/website_cookiebot/static/description/screenshot.png

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/website/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/website/issues/new?body=module:%20website_cookiebot%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/website/issues/new?body=module:%20website_cookiebot%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~
-------

* Trey (www.trey.es)
* Tecnativa

Contributors
~~~~~~~~~~~~
------------

- `Trey <https://www.trey.es>`__:

- Jorge Camacho <[email protected]>
- Antonio González <[email protected]>

* `Trey <https://www.trey.es>`__:
* Jorge Camacho <[email protected]>
* Antonio González <[email protected]>
- `Tecnativa <https://www.tecnativa.com/>`__:

* `Tecnativa <https://www.tecnativa.com/>`__:
* Jairo Llopis
* Stefan Ungureanu
* Pilar Vargas
- Jairo Llopis
- Stefan Ungureanu
- Pilar Vargas

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand All @@ -109,6 +117,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/website <https://github.com/OCA/website/tree/16.0/website_cookiebot>`_ project on GitHub.
This module is part of the `OCA/website <https://github.com/OCA/website/tree/17.0/website_cookiebot>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions website_cookiebot/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
15 changes: 15 additions & 0 deletions website_cookiebot/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
To configure this module, you need to:

1. Go to *Website \> Configuration \> Settings*
2. Under *Select the Website to Configure*, choose a website.
3. In the privacy section enable *Cookiebot* option.
4. Click on *\`How to configure Cookiebot
\<https://cookiebot.com/goto/help\>\`\_\_*.
5. Follow the instructions, except step 3 (do not insert the `<script>`
tags, the module will do it for you).
6. Fill in your *Domain Group ID* (e.g.
`00000000-0000-0000-0000-000000000000`)
7. Click on the *Save* button.

⚠️ **This module will do nothing unless configured and linked with
Cookiebot.**
11 changes: 0 additions & 11 deletions website_cookiebot/readme/CONFIGURE.rst

This file was deleted.

8 changes: 8 additions & 0 deletions website_cookiebot/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
- [Trey](https://www.trey.es):
- Jorge Camacho \<<[email protected]>\>
- Antonio González \<<[email protected]>\>

- [Tecnativa](https://www.tecnativa.com/):
- Jairo Llopis
- Stefan Ungureanu
- Pilar Vargas
8 changes: 0 additions & 8 deletions website_cookiebot/readme/CONTRIBUTORS.rst

This file was deleted.

3 changes: 3 additions & 0 deletions website_cookiebot/readme/DESCRIPTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This module integrates Odoo website with
[Cookiebot](https://www.cookiebot.com/), to ask for consent before
installing cookies on users' browsers.
2 changes: 0 additions & 2 deletions website_cookiebot/readme/DESCRIPTION.rst

This file was deleted.

9 changes: 9 additions & 0 deletions website_cookiebot/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
To use this module, once configured for your website, you just need to
browse that website. You will see the Cookiebot consent banner, and a
*Cookies Policy* link in the footer.

![](../static/description/screenshot.png)

Remember that, if your browser is configured to block 3rd party cookies,
trackers or consent banners, you won't notice the change. Disable any of
those protections to experiment the benefits.
10 changes: 0 additions & 10 deletions website_cookiebot/readme/USAGE.rst

This file was deleted.

0 comments on commit 4794687

Please sign in to comment.