[IMP] *: add knowledge tour to redirect to knowledge article

Added the knowledge tour to all industry modules so when a DB is started a tour pointing to the knowledge app is directly launched. To avoid the maintenance lines of code for these tours, these files are added in the cloc_exclude of the manifest, leading to the automatic creation of ir_model_data entries to exclude the cloc. This change is related to this PR: odoo/odoo@a47de680de14 In all the modules, the message related to the onboarding is improved. task-4056239
odoo · Sep 27, 2024 · acac5e7 · acac5e7
1 parent 2be3c24
commit acac5e7
Show file tree

Hide file tree

Showing 165 changed files with 1,532 additions and 528 deletions.
diff --git a/agriculture_shop/__manifest__.py b/agriculture_shop/__manifest__.py
@@ -66,6 +66,15 @@
         'demo/payment_provider_demo_post.xml',
     ],
     'license': 'OPL-1',
+    'assets': {
+        'web.assets_backend': [
+            'agriculture_shop/static/src/js/my_tour.js',
+        ]
+    },
     'author': 'Odoo S.A.',
+    "cloc_exclude": [
+        "data/knowledge_article.xml",
+        "static/src/js/my_tour.js",
+    ],
     'images': ['images/main.png'],
 }
diff --git a/agriculture_shop/data/knowledge_article.xml b/agriculture_shop/data/knowledge_article.xml
@@ -1,14 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <odoo>
-    <record id="knowledge_article_1" model="knowledge.article">
-        <field name="name">Agriculture Store</field>
-        <field name="internal_permission">write</field>
-        <field name="icon">🍀</field>
-        <field name="cover_image_id" ref="knowledge_cover_6"/>
-        <field name="is_article_visible_by_everyone" eval="True"/>
-        <field name="is_locked" eval="True"/>
-        <field name="body">
-            <![CDATA[
+    <template id="welcome_article_body">
+        <![CDATA[
                 <p>
                     <span style="font-size: 36px;"><strong>Agricultural Retail</strong></span>
                 </p>
@@ -87,7 +80,18 @@
                     <li>Sales person shares quotation and confirm the order.</li>
                     <li>Make Invoice.</li>
                 </ul>
-            ]]>
+        ]]>
+    </template>
+
+    <record id="welcome_article" model="knowledge.article">
+        <field name="name">Agriculture Store</field>
+        <field name="internal_permission">write</field>
+        <field name="icon">🍀</field>
+        <field name="cover_image_id" ref="knowledge_cover_6"/>
+        <field name="is_article_visible_by_everyone" eval="True"/>
+        <field name="is_locked" eval="True"/>
+        <field name="body">
+            <![CDATA[]]>
         </field>
     </record>
 </odoo>
diff --git a/agriculture_shop/data/knowledge_article_favorite.xml b/agriculture_shop/data/knowledge_article_favorite.xml
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <odoo noupdate="1">
     <record id="knowledge_favorite" model="knowledge.article.favorite">
-        <field name="article_id" ref="knowledge_article_1"/>
+        <field name="article_id" ref="welcome_article"/>
         <field name="user_id" ref="base.user_admin"/>
     </record>
 </odoo>
diff --git a/agriculture_shop/data/mail_message.xml b/agriculture_shop/data/mail_message.xml
@@ -6,11 +6,10 @@
         <field name="message_type">email</field>
         <field name="author_id" ref="base.partner_root"/>
         <field name="subtype_id" ref="mail.mt_comment"/>
-        <field name="subject">Knowledge article</field>
+        <field name="subject">🚀 Get started with Odoo Agriculture Shop</field>
         <field name="body" model="knowledge.article" eval="
-            '&lt;br>Hey! Need help?&lt;/br>
-             &lt;br>Checkout this &lt;a href=\''
-             + obj().env.ref('agriculture_shop.knowledge_article_1').article_url.replace(obj().get_base_url(), '')
-             + '\'>article&lt;/a>&lt;/br>'"/>
+            '&lt;span>&#x1F44B; Hi! Follow this &lt;a href=\''
+             + obj().env.ref('agriculture_shop.welcome_article').article_url 
+             + '\'>onboarding guide&lt;/a>. You can find it anytime in the Knowledge app.&lt;/span>'"/>
     </record>
 </odoo>
diff --git a/agriculture_shop/static/src/js/my_tour.js b/agriculture_shop/static/src/js/my_tour.js
@@ -0,0 +1,17 @@
+/** @odoo-module **/
+
+import { _t } from "@web/core/l10n/translation";
+import { registry } from "@web/core/registry";
+
+registry.category("web_tour.tours").add("knowledge_tour", {
+    url: "/odoo",
+    sequence: 2,
+    steps: () => [
+        {
+            trigger: '.o_app[data-menu-xmlid="knowledge.knowledge_menu_root"]',
+            content: _t("Open Knowledge to find the onboarding guide."),
+            position: "bottom",
+            run: "click",
+        },
+    ],
+});
diff --git a/architects/__manifest__.py b/architects/__manifest__.py
@@ -59,6 +59,15 @@
         'demo/hr_expense_action.xml',
     ],
     'license': 'OPL-1',
+    'assets': {
+        'web.assets_backend': [
+            'architects/static/src/js/my_tour.js',
+        ]
+    },
     'author': 'Odoo S.A.',
+    "cloc_exclude": [
+        "data/knowledge_article.xml",
+        "static/src/js/my_tour.js",
+    ],
     'images': ['images/main.png'],
 }
diff --git a/architects/data/knowledge_article.xml b/architects/data/knowledge_article.xml
@@ -1,16 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <odoo>
-    <record id="knowledge_article_3" model="knowledge.article">
-        <field name="name">Architecture Firm</field>
-        <field name="sequence">2</field>
-        <field name="category">workspace</field>
-        <field name="internal_permission">write</field>
-        <field name="is_article_visible_by_everyone" eval="True"/>
-        <field name="cover_image_id" ref="knowledge_cover_2"/>
-        <field name="cover_image_position">68.59</field>
-        <field name="icon">📏</field>
-        <field name="body">
-            <![CDATA[
+    <template id="welcome_article_body">
+        <![CDATA[
                 <h1>Architect Industry</h1>
                 <p>
                     <span style="font-size: 16px;">
@@ -70,7 +61,19 @@
                     </span>
                     <br />
                 </p>
-            ]]>
+        ]]>
+    </template>
+    <record id="welcome_article" model="knowledge.article">
+        <field name="name">Architecture Firm</field>
+        <field name="sequence">2</field>
+        <field name="category">workspace</field>
+        <field name="internal_permission">write</field>
+        <field name="is_article_visible_by_everyone" eval="True"/>
+        <field name="cover_image_id" ref="knowledge_cover_2"/>
+        <field name="cover_image_position">68.59</field>
+        <field name="icon">📏</field>
+        <field name="body">
+            <![CDATA[]]>
         </field>
     </record>
 </odoo>
diff --git a/architects/data/knowledge_article_favorite.xml b/architects/data/knowledge_article_favorite.xml
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <odoo noupdate="1">
     <record id="knowledge_favorite" model="knowledge.article.favorite">
-        <field name="article_id" ref="knowledge_article_3"/>
+        <field name="article_id" ref="welcome_article"/>
         <field name="user_id" ref="base.user_admin"/>
     </record>
 </odoo>
diff --git a/architects/data/mail_message.xml b/architects/data/mail_message.xml
@@ -6,11 +6,10 @@
         <field name="message_type">email</field>
         <field name="author_id" ref="base.partner_root"/>
         <field name="subtype_id" ref="mail.mt_comment"/>
-        <field name="subject">Knowledge article</field>
+        <field name="subject">🚀 Get started with Odoo Architects</field>
         <field name="body" model="knowledge.article" eval="
-            '&lt;br>Hey! Need help?&lt;/br>
-             &lt;br>Checkout this &lt;a href=\''
-             + obj().env.ref('architects.knowledge_article_3').article_url.replace(obj().get_base_url(), '')
-             + '\'>article&lt;/a>&lt;/br>'"/>
+            '&lt;span>&#x1F44B; Hi! Follow this &lt;a href=\''
+             + obj().env.ref('architects.welcome_article').article_url 
+             + '\'>onboarding guide&lt;/a>. You can find it anytime in the Knowledge app.&lt;/span>'"/>
     </record>
 </odoo>
diff --git a/architects/static/src/js/my_tour.js b/architects/static/src/js/my_tour.js
@@ -0,0 +1,17 @@
+/** @odoo-module **/
+
+import { _t } from "@web/core/l10n/translation";
+import { registry } from "@web/core/registry";
+
+registry.category("web_tour.tours").add("knowledge_tour", {
+    url: "/odoo",
+    sequence: 2,
+    steps: () => [
+        {
+            trigger: '.o_app[data-menu-xmlid="knowledge.knowledge_menu_root"]',
+            content: _t("Open Knowledge to find the onboarding guide."),
+            position: "bottom",
+            run: "click",
+        },
+    ],
+});
diff --git a/art_craft/__manifest__.py b/art_craft/__manifest__.py
@@ -75,6 +75,15 @@
         'demo/website_theme_apply.xml',
     ],
     'license': 'OPL-1',
+    'assets': {
+        'web.assets_backend': [
+            'art_craft/static/src/js/my_tour.js',
+        ]
+    },
     'author': 'Odoo S.A.',
+    "cloc_exclude": [
+        "data/knowledge_article.xml",
+        "static/src/js/my_tour.js",
+    ],
     'images': ['images/main.png'],
 }
diff --git a/art_craft/data/knowledge_article.xml b/art_craft/data/knowledge_article.xml
@@ -1,15 +1,6 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <odoo>
-    <record id="knowledge_article_1" model="knowledge.article">
-        <field name="name">Arts &amp; Crafts Store</field>
-        <field name="icon">🖌️</field>
-        <field name="category">workspace</field>
-        <field name="is_locked" eval="True" />
-        <field name="is_article_visible_by_everyone" eval="True"/>
-        <field name="internal_permission">write</field>
-        <field name="cover_image_id" ref="knowledge_cover_3"/>
-        <field name="cover_image_position">41.40999999999994</field>
-        <field name="body">
+    <template id="welcome_article_body">
         <![CDATA[
                 <p><span style="color: rgb(0, 0, 0); background-color: transparent; font-weight: 700; font-style: normal; text-decoration: none; font-size: 24px;">The Arts and Crafts Shop</span></p>
                 <p style="margin-bottom: 0px;"><span style="font-size:13pt;color:#000000;background-color:transparent;font-weight:400;font-style:normal;text-decoration:none"></span><span class="text-o-color-2" style="background-color: transparent; font-weight: 400; font-style: normal; text-decoration: none;"><font class="text-800">An arts and crafts store is a haven for creative individuals and hobbyists, offering a diverse range of supplies and materials for various artistic endeavours. From painting and drawing, scrap booking. These stores provide a colourful array of paints, brushes, paper, beads, tools, colourful trays and other crafting (Handmade) essentials. They are a treasure trove for anyone seeking to express their creativity, explore new hobbies, or create beautiful handmade items.</font></span></p>
@@ -86,6 +77,19 @@
                 </ul>
                 <p style="margin-bottom: 0px;"><br></p>
         ]]>
+    </template>
+
+    <record id="welcome_article" model="knowledge.article">
+        <field name="name">Arts &amp; Crafts Store</field>
+        <field name="icon">🖌️</field>
+        <field name="category">workspace</field>
+        <field name="is_locked" eval="True" />
+        <field name="is_article_visible_by_everyone" eval="True"/>
+        <field name="internal_permission">write</field>
+        <field name="cover_image_id" ref="knowledge_cover_3"/>
+        <field name="cover_image_position">41.40999999999994</field>
+        <field name="body">
+            <![CDATA[]]>
         </field>
     </record>
 </odoo>
diff --git a/art_craft/data/knowledge_article_favorite.xml b/art_craft/data/knowledge_article_favorite.xml
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <odoo noupdate="1">
     <record id="knowledge_favorite" model="knowledge.article.favorite">
-        <field name="article_id" ref="knowledge_article_1"/>
+        <field name="article_id" ref="welcome_article"/>
         <field name="user_id" ref="base.user_admin"/>
     </record>
 </odoo>
diff --git a/art_craft/data/mail_message.xml b/art_craft/data/mail_message.xml
@@ -6,11 +6,10 @@
         <field name="message_type">email</field>
         <field name="author_id" ref="base.partner_root"/>
         <field name="subtype_id" ref="mail.mt_comment"/>
-        <field name="subject">Knowledge article</field>
+        <field name="subject">🚀 Get started with Odoo Art Craft</field>
         <field name="body" model="knowledge.article" eval="
-            '&lt;br>Hey! Need help?&lt;/br>
-             &lt;br>Checkout this &lt;a href=\''
-             + obj().env.ref('art_craft.knowledge_article_1').article_url.replace(obj().get_base_url(), '')
-             + '\'>article&lt;/a>&lt;/br>'"/>
+            '&lt;span>&#x1F44B; Hi! Follow this &lt;a href=\''
+             + obj().env.ref('art_craft.welcome_article').article_url 
+             + '\'>onboarding guide&lt;/a>. You can find it anytime in the Knowledge app.&lt;/span>'"/>
     </record>
 </odoo>
diff --git a/art_craft/static/src/js/my_tour.js b/art_craft/static/src/js/my_tour.js
@@ -0,0 +1,17 @@
+/** @odoo-module **/
+
+import { _t } from "@web/core/l10n/translation";
+import { registry } from "@web/core/registry";
+
+registry.category("web_tour.tours").add("knowledge_tour", {
+    url: "/odoo",
+    sequence: 2,
+    steps: () => [
+        {
+            trigger: '.o_app[data-menu-xmlid="knowledge.knowledge_menu_root"]',
+            content: _t("Open Knowledge to find the onboarding guide."),
+            position: "bottom",
+            run: "click",
+        },
+    ],
+});
diff --git a/automobile/__manifest__.py b/automobile/__manifest__.py
@@ -60,6 +60,15 @@
         'demo/sale_order_post.xml',
     ],
     'license': 'OPL-1',
+    'assets': {
+        'web.assets_backend': [
+            'automobile/static/src/js/my_tour.js',
+        ]
+    },
     'author': 'Odoo S.A.',
+    "cloc_exclude": [
+        "data/knowledge_article.xml",
+        "static/src/js/my_tour.js",
+    ],
     'images': ['images/main.png'],
 }
diff --git a/automobile/data/knowledge_article.xml b/automobile/data/knowledge_article.xml
@@ -1,15 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <odoo>
-    <record id="knowledge_article_2" model="knowledge.article">
-        <field name="name">Automobile Spare Parts</field>
-        <field name="category">private</field>
-        <field name="is_locked" eval="True"/>
-        <field name="icon">🛠️</field>
-        <field name="cover_image_id" ref="knowledge_cover_5"/>
-        <field name="internal_permission">write</field>
-        <field name="is_article_visible_by_everyone" eval="True"/>
-        <field name="body">
-            <![CDATA[
+    <template id="welcome_article_body">
+        <![CDATA[
                 <h1>Automobile Spare parts Trading</h1>
                 <p><br /></p>
                 <p>
@@ -70,6 +62,18 @@
                     <br />
                 </p>
         ]]>
+    </template>
+
+    <record id="welcome_article" model="knowledge.article">
+        <field name="name">Automobile Spare Parts</field>
+        <field name="category">private</field>
+        <field name="is_locked" eval="True"/>
+        <field name="icon">🛠️</field>
+        <field name="cover_image_id" ref="knowledge_cover_5"/>
+        <field name="internal_permission">write</field>
+        <field name="is_article_visible_by_everyone" eval="True"/>
+        <field name="body">
+            <![CDATA[]]>
         </field>
     </record>
 </odoo>
diff --git a/automobile/data/knowledge_article_favorite.xml b/automobile/data/knowledge_article_favorite.xml
@@ -1,7 +1,7 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <odoo noupdate="1">
     <record id="knowledge_favorite" model="knowledge.article.favorite">
-        <field name="article_id" ref="knowledge_article_2"/>
+        <field name="article_id" ref="welcome_article"/>
         <field name="user_id" ref="base.user_admin"/>
     </record>
 </odoo>
diff --git a/automobile/data/mail_message.xml b/automobile/data/mail_message.xml
@@ -6,11 +6,10 @@
         <field name="message_type">email</field>
         <field name="author_id" ref="base.partner_root"/>
         <field name="subtype_id" ref="mail.mt_comment"/>
-        <field name="subject">Knowledge article</field>
+        <field name="subject">🚀 Get started with Odoo Automobile</field>
         <field name="body" model="knowledge.article" eval="
-            '&lt;br>Hey! Need help?&lt;/br>
-             &lt;br>Checkout this &lt;a href=\''
-             + obj().env.ref('automobile.knowledge_article_2').article_url.replace(obj().get_base_url(), '')
-             + '\'>article&lt;/a>&lt;/br>'"/>
+            '&lt;span>&#x1F44B; Hi! Follow this &lt;a href=\''
+             + obj().env.ref('automobile.welcome_article').article_url 
+             + '\'>onboarding guide&lt;/a>. You can find it anytime in the Knowledge app.&lt;/span>'"/>
     </record>
 </odoo>
diff --git a/automobile/static/src/js/my_tour.js b/automobile/static/src/js/my_tour.js
@@ -0,0 +1,17 @@
+/** @odoo-module **/
+
+import { _t } from "@web/core/l10n/translation";
+import { registry } from "@web/core/registry";
+
+registry.category("web_tour.tours").add("knowledge_tour", {
+    url: "/odoo",
+    sequence: 2,
+    steps: () => [
+        {
+            trigger: '.o_app[data-menu-xmlid="knowledge.knowledge_menu_root"]',
+            content: _t("Open Knowledge to find the onboarding guide."),
+            position: "bottom",
+            run: "click",
+        },
+    ],
+});