Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[17.0][MIG] announcement: Migration to 17.0 #935

Merged
merged 21 commits into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
d1bd94c
[13.0][ADD] announcement: New module
chienandalu Aug 10, 2022
d6f5680
[FIX] announcement: assorted fixes
chienandalu Aug 22, 2022
ec7ca9e
[FIX] announcement: log read just once
chienandalu Aug 30, 2022
32fe33d
[IMP] announcement: configurable full width
chienandalu Sep 26, 2022
41b0270
[MIG] announcement: Migration to 15.0
chienandalu Nov 17, 2022
6afd5c4
Translated using Weblate (Spanish)
victoralmau Dec 15, 2022
60b4cc8
[IMP] announcement: add general_anouncement option to announcement
pilarvargas-tecnativa Jun 27, 2023
514ffd2
[IMP] announcement: Add Announcement Tags
victoralmau Jul 10, 2023
b7a4814
[IMP] announcement: Prevent False specific_user_ids from when not app…
victoralmau Jul 13, 2023
e8b5c25
[IMP] announcement: add attachments field
pilarvargas-tecnativa Jul 13, 2023
a95d5c9
[FIX] announcement: Avoid permission error on attachments
pedrobaeza Jul 27, 2023
9a32ae4
[IMP] announcement: add calendar view
chienandalu Dec 15, 2023
603bdb6
[FIX] announcement: allow multicompany tags
chienandalu Dec 21, 2023
2005d03
[FIX] announcement: Change web_ribbon text to title to make it transl…
victoralmau Jan 25, 2024
0739f79
[MIG] announcement: Migration to 16.0
chienandalu Mar 5, 2024
028e865
[IMP] announcement: Continue migration
CarlosRoca13 Apr 12, 2024
4623748
Added translation using Weblate (Italian)
mymage Apr 15, 2024
8cab2ff
[IMP] announcement: Also show archived users.
victoralmau Aug 6, 2024
280f5ab
[UPD] Copier update
chienandalu Sep 3, 2024
3dbe4f0
[IMP] announcement: pre-commit auto fixes
chienandalu Sep 3, 2024
2577de3
[MIG] announcement: Migration to 17.0
chienandalu Sep 3, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .copier-answers.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Do NOT update manually; changes here will be overwritten by Copier
_commit: v1.21.1
_commit: v1.24
_src_path: gh:oca/oca-addons-repo-template
additional_ruff_rules: []
ci: GitHub
Expand Down
2 changes: 1 addition & 1 deletion .eslintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ env:

# See https://github.com/OCA/odoo-community.org/issues/37#issuecomment-470686449
parserOptions:
ecmaVersion: 2019
ecmaVersion: 2022

overrides:
- files:
Expand Down
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ var/
*.egg
*.eggs

# Debian packages
*.deb

# Redhat packages
*.rpm

# MacOS packages
*.dmg

# Installer logs
pip-log.txt
pip-delete-this-directory.txt
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ repos:
hooks:
- id: whool-init
- repo: https://github.com/oca/maintainer-tools
rev: 9a170331575a265c092ee6b24b845ec508e8ef75
rev: d5fab7ee87fceee858a3d01048c78a548974d935
hooks:
# update the NOT INSTALLABLE ADDONS section above
- id: oca-update-pre-commit-excluded-addons
Expand Down
132 changes: 132 additions & 0 deletions announcement/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
============
Announcement
============

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:784e888a875fb1f37b9d3a48ca5c5c63bdec23a06cce24e648a5910f4907891d
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--ux-lightgray.png?logo=github
:target: https://github.com/OCA/server-ux/tree/17.0/announcement
:alt: OCA/server-ux
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-ux-17-0/server-ux-17-0-announcement
: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/server-ux&target_branch=17.0
:alt: Try me on Runboat

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

This module adds popup announcements in the backend for targeted
internal users. Those announcements can contain rich format and a user
read log is kept for everyone.

**Table of contents**

.. contents::
:local:

Configuration
=============

To create new announcements a user should be in the *Announcements
Managers* group. When your user has such permissions, this is the way to
create an announcement:

1. Go to *Discuss > Announcements*
2. Create a new one and define a title. This title will be shown in the
announcement header.
3. Define the announcement scope:

- Specific users: manually select which users will see the
announcement.
- User groups: users from the selected groups will be the ones to
see the announcement.

4. Define the announcement body. You can use rich formatting and event
paste your own html (editor in debug mode).
5. By default, the announcement will be archived. This is to prevent the
announcement to show up before time.
6. Once the announcement is ready, unarchive it going to the *Actions*
menu an choosing the *Unarchive* option.
7. Optionally you can set an announcement date to schedule the
announcement. The announcement won't show up until that date.
8. If the announcement doesn't make sense once a date is passed, you can
set a due date. From that date, the announcement won't be shown to
anyone.

Usage
=====

When a user in the scope of active announcements logs in, those will
popup. The user has to mark them as read to continue working. If the
announcement is set during the user session, the announcement will be
eventually prompted in the top bar on the right part. The user click on
the unread announcements icon (a speaker) and the announcements will
popup for the user to check them.

Users can go *Discuss > Announcements* to check current and past
announcements. Announcement managers can also track which users have
read the announcement.

Known issues / Roadmap
======================

- It could be integrated in Discuss app to review past announcements.
- Log other information like geolocation, IP, browser agent, etc when
marking announcement as read.

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

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-ux/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/server-ux/issues/new?body=module:%20announcement%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
-------

* Tecnativa

Contributors
------------

- `Tecnativa <https://www.tecnativa.com>`__:

- Pedro M. Baeza
- David Vidal
- Carlos Roca

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

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/server-ux <https://github.com/OCA/server-ux/tree/17.0/announcement>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
2 changes: 2 additions & 0 deletions announcement/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import models
from . import wizards
30 changes: 30 additions & 0 deletions announcement/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Copyright 2022 Tecnativa - David Vidal
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

{
"name": "Announcement",
"version": "17.0.1.0.0",
"summary": "Notify internal users about relevant organization stuff",
"author": "Tecnativa, Odoo Community Association (OCA)",
"license": "AGPL-3",
"category": "Server UX",
"website": "https://github.com/OCA/server-ux",
"depends": ["mail"],
"data": [
"security/announcement_security.xml",
"security/ir.model.access.csv",
"views/announcement_views.xml",
"views/announcement_tag_views.xml",
"wizards/read_announcement_wizard.xml",
],
"demo": [
"demo/announcement_tag_demo.xml",
],
"assets": {
"web.assets_backend": [
"announcement/static/src/js/announcement_dialog/**/*",
"announcement/static/src/js/announcement_menu/**/*",
"announcement/static/src/js/announcement_service/**/*",
],
},
}
23 changes: 23 additions & 0 deletions announcement/demo/announcement_tag_demo.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<record id="announcement_tag_1" model="announcement.tag">
<field name="name">Company information</field>
<field name="color" eval="1" />
</record>
<record id="announcement_tag_2" model="announcement.tag">
<field name="name">Employees</field>
<field name="color" eval="2" />
</record>
<record id="announcement_tag_3" model="announcement.tag">
<field name="name">Accounting</field>
<field name="color" eval="3" />
</record>
<record id="announcement_tag_4" model="announcement.tag">
<field name="name">Sales</field>
<field name="color" eval="4" />
</record>
<record id="announcement_tag_5" model="announcement.tag">
<field name="name">Manufacturing</field>
<field name="color" eval="5" />
</record>
</odoo>
Loading
Loading