[IMP] essentials: progress bar

closes odoo/documentation#15272

X-original-commit: 894f05059e
Signed-off-by: Megan Valenzuela (meval) <meval@odoo.com>

content/applications/essentials.rst

@@ -4,6 +4,7 @@ Odoo essentials
 
 .. toctree::
 
+   essentials/stages
    essentials/activities
    essentials/reporting
    essentials/search

content/applications/essentials/stages.rst

@@ -2,8 +2,11 @@
 Stages
 ======
 
-*Stages* are used to organize the **Helpdesk** pipeline and track the progress of tickets. Stages
+*Stages* are used to organize an app's pipeline and track the progress of configured items, from now
-are customizable, and can be renamed to fit the needs of each team.
+on are referred to as cards.
+
+In apps these cards represent specific items, for example, in the **Helpdesk** app, stages track
+tickets. Stages are customizable, and can be renamed to fit the needs of each team.
 
 Create or modify stages
 =======================
@@ -13,11 +16,10 @@ Create or modify stages
    activate developer mode, go to :menuselection:`Settings app --> General Settings --> Developer
    Tools`, and click :guilabel:`Activate the developer mode`.
 
-To view or modify **Helpdesk** stages, go to :menuselection:`Helpdesk app --> Configuration -->
+To view or modify stages, go to the desired app and go to :menuselection:`Configuration --> Stages`.
-Stages`.
 
 The default list view on the :guilabel:`Stages` page displays the stages currently available in the
-**Helpdesk** app. They are listed in the order they appear in the pipeline.
+app. They are listed in the order they appear in the pipeline.
 
 To change the order of the stages, click the :icon:`oi-draggable` :guilabel:`(draggable)` icon, to
 the left of the stage name, and drag it to the desired place on the list.
@@ -27,8 +29,8 @@ the left of the stage name, and drag it to the desired place on the list.
          appear in the list.
 
 .. tip::
-   Change the stage order on the Kanban view of a **Helpdesk** team's pipeline by dragging and
+   Change the stage order on the Kanban view of a team's pipeline by dragging and dropping
-   dropping individual columns.
+   individual columns.
 
 To create a new stage, click the :guilabel:`New` button at the top-left of the stage list. Doing so
 reveals a blank stage form.
@@ -38,6 +40,26 @@ Choose a :guilabel:`Name` for the new stage.
 .. image:: stages/new-stage-details.png
    :alt: View of a stage's settings page in Odoo Helpdesk.
 
+Progress bar
+============
+
+The progress bar is visible above each stage, displaying the percentage breakdown of every status
+type for all the cards within that stage. Each status type has an assigned color that appears within
+the bar.
+
+The specific definition of these statuses changes depending on the app. For example, in the
+**Helpdesk** app, the progress bar for a stage consists of the :guilabel:`In progress`,
+:guilabel:`Ready`, and :guilabel:`Blocked` statuses by default.
+
+To see a detailed count, hover over a representative color, which activates a notification detailing
+the number of cards in the stage of that specific status.
+
+Clicking a status color filters the stage to show only cards with that status. The card count for
+the selected status appears next to the progress bar.
+
+.. image:: stages/stage-progress-bar-highlight.png
+   :alt: View of a stage's progress highlighting the activities that are due today.
+
 Add email and SMS templates to stages
 =====================================
 
@@ -69,31 +91,30 @@ Follow the same steps to select, edit, or create an :guilabel:`SMS Template`.
 Fold a stage
 ============
 
-By default, stages are unfolded in the Kanban view of either tickets dashboard: :guilabel:`My
+By default, stages are unfolded in the Kanban view. If there is a Won or Closed stage, it is folded
-Tickets` (:menuselection:`Helpdesk app --> Tickets --> My Tickets`) or :guilabel:`All Tickets`
+by default.
-(:menuselection:`Helpdesk app --> Tickets --> All Tickets`).
 
-Tickets in an unfolded stage are visible in the pipeline under the stage name, and are considered
+Cards in an unfolded stage are visible in the pipeline under the stage name, and are considered
 *open*.
 
-Stages can be configured to be folded in the Kanban view of a tickets page.
+Stages can be configured to be folded in the Kanban view of the pipeline page.
 
-The name of the folded stages are still visible, but the tickets in the stage are hidden from view.
+The name of the folded stages are still visible, but the cards in the stage are hidden from view.
 
 To fold a stage, tick the :guilabel:`Folded in Kanban` checkbox on the :guilabel:`Stages` form.
 
 .. warning::
-   Tickets that reach a *folded* stage are considered *closed*. Closing a ticket before the work is
+   Cards that reach a *folded* stage are considered *closed*. Closing a card before the work is
    completed can result in reporting and communication issues. This setting should **only** be
    enabled for stages that are considered *closing* stages.
 
 Temporarily fold a stage
 ------------------------
 
-Stages can be temporarily folded in the Kanban view of the tickets pipeline, as well.
+Stages can be temporarily folded in the Kanban view of the pipeline, as well.
 
-View a specific team's pipeline by navigating to :menuselection:`Helpdesk app`, and clicking the
+View a specific team's pipeline by navigating to the desired app, and clicking the team's Kanban
-team's Kanban card.
+card.
 
 Hover the cursor at the top of the desired stage to fold temporarily, then click the :icon:`fa-gear`
 :guilabel:`(gear)` icon that appears, and select :guilabel:`Fold` from the drop-down menu.
@@ -102,11 +123,11 @@ Hover the cursor at the top of the desired stage to fold temporarily, then click
    :alt: Kanban view of a Helpdesk stage, with the temporary fold option emphasized.
 
 .. important::
-   Manually folding a stage from the Kanban view is temporary and does **not** close the tickets in
+   Manually folding a stage from the Kanban view is temporary and does **not** close the cards in
    the stage.
 
 Assign stages to a team
 =======================
 
-Make a selection in the :guilabel:`Helpdesk Teams` field on the :guilabel:`Stages` form. More than
+Make a selection in the :guilabel:`Teams` field on the :guilabel:`Stages` form. More than one team
-one team may be selected, since the same stage can be assigned to multiple teams.
+may be selected, since the same stage can be assigned to multiple teams.

content/applications/services/helpdesk/overview.rst

@@ -7,7 +7,6 @@ Overview
 .. toctree::
    :titlesonly:
 
-   overview/stages
    overview/receiving_tickets
    overview/help_center
    overview/sla