Skip to content

Commit 32bbd77

Browse files
committed
[IMP] PLM: Fix formating, add images, clarify
Apply suggestions from code review Co-authored-by: Felicia Kuan <feku@odoo.com> [IMP] howto/website_themes: Layout page update - Update the Bootstrap documentation urls - Update the Github urls closes #12713 Signed-off-by: Brandon Mercier (bram) <bram@odoo.com> [FIX] studio: automation rules doc page display closes #12726 Signed-off-by: Audrey Vandromme (auva) <auva@odoo.com> [IMP] howto/website_themes: Building blocks page update - Change the Github urls to the correct version of Odoo - Adapt the way of creating a snippet template and how to add it to the builder - Add explanation about how to make a custom snippet "inner content" closes #12721 Signed-off-by: Brandon Mercier (bram) <bram@odoo.com> [IMP] howto/website_themes: "Pages" page update - Update Bootstrap documentation urls - Update Github urls - Update Odoo version number into the manifest example - Dynamic Odoo version number in the code-block of the manifest example. - Typos closes #12714 Signed-off-by: Brandon Mercier (bram) <bram@odoo.com> [IMP] howto/website: update animations page This commit updates current animations page, by adding updated content. Task-4316707 closes #12744 Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com> [IMP] howto/website: update theming page This commit updates current theming page, by adding updated content. Task-4316707 closes #12740 Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com> [IMP] howto/website: update media page This commit updates current media page, by adding updated content. Task-4316619 closes #12746 X-original-commit: 533a6fd Signed-off-by: Carlos Valverde (cvs) <cvs@odoo.com> fix
1 parent ec8213d commit 32bbd77

File tree

11 files changed

+213
-109
lines changed

11 files changed

+213
-109
lines changed

content/applications/inventory_and_mrp/plm/manage_changes/eco_type.rst

Lines changed: 77 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,36 @@
55
.. |ECO| replace:: :abbr:`ECO (Engineering Change Order)`
66
.. |ECOs| replace:: :abbr:`ECOs (Engineering Change Orders)`
77

8-
========
9-
ECO type
10-
========
8+
====================
9+
ECO types and stages
10+
====================
1111

12-
An *ECO type* is assigned to *engineering change orders* (ECOs) to organize and track changes to
13-
products and bills of materials (BoMs). Each |ECO| type separates |ECOs| into a project in Gantt
14-
view, ensuring collaborators and stakeholders **only** view and assist with relevant |BOM|
15-
improvements.
12+
Engineering change orders (ECOs) are categorized by the type of change they represent and their
13+
statuses are tracked via stages. Both |ECO| types and stages are defined by the user and can be
14+
customized to the specific needs of a business or industry.
1615

17-
For example, an electronic chip manufacturer might use 'New Product Introduction', 'Product
18-
Improvement', 'Component Change', and 'Firmware Update' |ECO| types. Then, designers and engineers
19-
can focus on |ECOs| in the 'New Product Introduction' and 'Product Improvement' projects, avoiding
20-
unrelated supplier change or firmware update |ECOs|.
16+
ECO types
17+
=========
2118

22-
Create ECO type
23-
===============
19+
*Engineering change orders* (ECOs) require an |ECO| type to organize and track changes to products
20+
and bills of materials (BoMs). Like a :doc:`product
21+
type<../../inventory/product_management/configure/type>`, |ECO| types are highly customizable and
22+
specific to the needs of individual businesses. Each |ECO| type separates |ECOs| into different
23+
projects in the :guilabel:`PLM Overview`, ensuring collaborators and stakeholders only view and
24+
assist with relevant |BOM| improvements.
25+
26+
.. example::
27+
An electronic chip manufacturer might use the default `New Product Introduction` type and change
28+
the default `BOM Updates` type to `Component Change`. Additionally, they require new `Product
29+
Improvement` and `Firmware Update` |ECO| types. With this configuration, engineers can focus on
30+
|ECOs| in the `Component Change` and `Firmware Update` types, and designers can collaborate on
31+
|ECOs| in the `New Product Introduction` and `Product Improvement` types.
32+
33+
.. image:: eco_type/eco-type-example.png
34+
:alt: Example of several custom ECO types
35+
36+
Create an ECO type
37+
------------------
2438

2539
To access and manage ECO types, navigate to :menuselection:`PLM app --> Configuration --> ECO
2640
Types`.
@@ -39,41 +53,51 @@ the following information:
3953
change` project sent to the email address, `pawlish-change@pawlished-glam.odoo.com`.
4054

4155
.. image:: eco_type/create-eco-type.png
42-
:align: center
4356
:alt: Example of an ECO type.
4457

45-
Edit ECO type
46-
=============
58+
Edit ECO types
59+
--------------
4760

4861
Modify existing |ECO| type names and email aliases by navigating to the :menuselection:`PLM app -->
4962
Configuration --> ECO Types` page. There, click on the desired |ECO| type from the list.
5063

51-
On the form for each |ECO| type, proceed to edit the :guilabel:`Name` and :guilabel:`Email Alias`
52-
fields.
64+
On the form for each |ECO| type, edit the :guilabel:`Name` or :guilabel:`Email Alias` fields.
5365

5466
.. _plm/eco/stage-config:
5567

5668
Stages
5769
======
5870

59-
Within an |ECO| type project, *stages* are like milestones and are used to identify the progress of
60-
the |ECO| before the changes are ready to be applied. (e.g. 'Feedback', 'In Progress', 'Approved',
61-
'Complete')
71+
Within the ::guilabel:`Engineering Change Orders` Kanban view for a specific |ECO| type, *stages*
72+
are milestones used to identify the progress of the |ECO| before the changes are ready to be
73+
applied. By default, Odoo uses `New`, `In-Progress`, `Validated`, and `Effective`, but these are
74+
fully customizable to the specific life cycle of an |ECO| type.
75+
76+
.. image:: eco_type/eco-stage-defaults.png
77+
:alt: Default stages for an ECO type.
78+
79+
.. note::
80+
The `Effective` stage is folded by default to avoid listing every single |ECO| that has gone into
81+
effect. See :ref:`Closing stage<plm/eco/closing-stage>` for more on this configuration.
6282

6383
Additionally, required approvers can be added to each stage, ensuring that changes to the production
6484
|BOM| cannot proceed until the approver reviews and approves the |ECO|. Doing so prevents errors on
65-
the production |BOM| by enforcing at least one review of suggested changes before they're applied on
66-
a production |BOM|.
85+
the production |BOM| by enforcing at least one review of suggested changes before they are applied
86+
on a production |BOM|.
6787

68-
For best practice, there should be at least one *verification* stage, which is a stage with a
88+
The most common practice is to have at least one *verification* stage, which is a stage with a
6989
required approver, and one *closing* stage, which stores |ECOs| that have been either cancelled or
7090
approved for use as the next production |BOM|.
7191

72-
Create stage
73-
------------
92+
.. seealso::
93+
:doc:`Approvals<../management/approvals>`
7494

75-
To add a stage, go to the :menuselection:`PLM` app and select the intended project for an |ECO| type
76-
from the :guilabel:`PLM Overview` dashboard.
95+
96+
Create a new stage
97+
------------------
98+
99+
To add a stage, go to the **PLM** app and select the |ECO| type project view from the :guilabel:`PLM
100+
Overview` dashboard.
77101

78102
Then, on the :guilabel:`Engineering Change Orders` project pipeline for the |ECO| type, click the
79103
:guilabel:`+ Stage` button. Doing so reveals a text box to fill in the name of the stage. After
@@ -84,17 +108,20 @@ filling it in, click the :guilabel:`Add` button to finish adding the stage.
84108
Adding another stage helps the product manager track unassigned tasks.
85109

86110
.. image:: eco_type/create-stage.png
87-
:align: center
88111
:alt: Create a new stage in a project for an ECO type.
89112

113+
Use case: configuring verification and closing stages
114+
-----------------------------------------------------
115+
90116
Verification stage
91-
------------------
117+
~~~~~~~~~~~~~~~~~~
118+
119+
Click an |ECO| type from :menuselection:`PLM app --> Overview` to open the Kanban view of |ECOs| of
120+
this type.
92121

93-
Click an ECO type from :menuselection:`PLM app --> Overview` to open a kanban view of |ECOs| of this
94-
type.
122+
To configure a verification stage, hover over the intended stage, and select the :icon:`fa-gear`
123+
:guilabel:`(gear)`. Then, click :guilabel:`Edit` to open a pop-up window.
95124

96-
To configure a verification stage, hover over the intended stage, and select the :guilabel:`⚙️
97-
(gear)` icon. Then, click :guilabel:`Edit` to open a pop-up window.
98125

99126
Configure the verification stage in the edit stage pop-up window, by checking the box for
100127
:guilabel:`Allow to apply changes`.
@@ -111,24 +138,31 @@ pop-up window. Once finished, click :guilabel:`Save & Close`.
111138

112139
.. example::
113140
In the |ECO| type `New Product Introduction`, the verification stage `Validated` is configured by
114-
clicking the :guilabel:`⚙️ (gear)` icon, and selecting :guilabel:`Edit`. Doing so opens the
115-
:guilabel:`Edit: Validated` pop-up window.
141+
clicking the :icon:`fa-gear` :guilabel:`(gear)` icon, and selecting :guilabel:`Edit`. Doing so
142+
opens the :guilabel:`Edit: Validated` pop-up window.
116143

117144
By adding the `Engineering manager` as an approver, only |ECOs| approved by this user can proceed
118145
to the next stage, and have the changes applied on the production |BOM|.
119146

120147
Additionally, check the :guilabel:`Allow to apply changes` option to ensure proper behavior.
121148

122149
.. image:: eco_type/verification-stage.png
123-
:align: center
124-
:alt: Show "Allow to apply changes" option is checked.
150+
:alt: Edit Validated page with "Allow to apply changes" checked.
151+
152+
.. seealso::
153+
:doc:`../management/approvals`
154+
155+
.. _plm/eco/closing-stage:
125156

126157
Closing stage
127-
-------------
158+
~~~~~~~~~~~~~
128159

129-
Configure a closing stage by opening the :guilabel:`Edit: [stage]` pop-up window. To do so, hover
130-
over the intended stage and click the :guilabel:`⚙️ (gear)` icon that appears in the top-right
131-
corner. Then, click :guilabel:`Edit` from the drop-down menu.
160+
Click an |ECO| type from :menuselection:`PLM app --> Overview` to open the Kanban view of |ECOs| of
161+
this type.
162+
163+
To configure a closing stage, hover over the intended stage's name and click the :icon:`fa-gear`
164+
:guilabel:`(gear)` icon that appears in the top-right corner. Then, select :guilabel:`Edit` from the
165+
drop-down menu.
132166

133167
On the :guilabel:`Edit: [stage]` pop-up window, select the check boxes for :guilabel:`Folded in
134168
kanban view`, :guilabel:`Allow to apply changes` and :guilabel:`Final Stage`.
@@ -138,6 +172,4 @@ kanban view`, :guilabel:`Allow to apply changes` and :guilabel:`Final Stage`.
138172
:guilabel:`Allow to apply changes`, and :guilabel:`Final Stage` options
139173

140174
.. image:: eco_type/closing-stage.png
141-
:align: center
142-
:alt: Show configurations of the closing stage.
143-
175+
:alt: Configuration of the closing stage.
9.79 KB
Loading
15.4 KB
Loading

content/applications/studio/automated_actions.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:show-content:
2+
13
================
24
Automation rules
35
================

content/developer/howtos/website_themes/animations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Additionally, we can also set an `in` or `out` effect, an animation `direction`
102102

103103
.. seealso::
104104
`Website Animate
105-
<https://github.com/odoo/odoo/blob/34c0c9c1ae00aba391932129d4cefd027a9c6bbd/addons/website/static/src/scss/website.scss#L1638>`_
105+
<https://github.com/odoo/odoo/blob/c272c49657e8b7865bb93e5f1dcc183cc7d44f17/addons/website/static/src/scss/website.scss#L2075>`_
106106

107107
.. _website_themes/animations/hover:
108108

@@ -162,4 +162,4 @@ also define the type of animation in the `data-hover-effect` attribute.
162162

163163
.. seealso::
164164
`Hover effect options
165-
<https://github.com/odoo/odoo/blob/f43fbf67c98236434429e26d9d93de71ddb06790/addons/website/views/snippets/snippets.xml#L405>`_
165+
<https://github.com/odoo/odoo/blob/c272c49657e8b7865bb93e5f1dcc183cc7d44f17/addons/website/views/snippets/snippets.xml#L694>`_

0 commit comments

Comments
 (0)