[IMP] Productivity: Discuss Getting Started rewrite

[FIX] Updates to Discuss doc for 17.0

Adding reviewer suggestions

Added blank line at end of file

closes odoo/documentation#10580

Signed-off-by: Jessica Rogers (jero) <jero@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>
This commit is contained in:
kekiss 2024-08-02 12:02:13 -07:00 committed by jero-odoo
parent db36928ff6
commit cdf833810f
11 changed files with 131 additions and 67 deletions

View File

@ -1,105 +1,169 @@
:show-content: :show-content:
:show-toc: :hide-page-toc:
======= =======
Discuss Discuss
======= =======
Odoo *Discuss* is an internal communication app that allows users to connect through messages, Odoo **Discuss** is an internal communication app that allows users to connect through messages,
notes, and file sharing, either through a persistent chat window that works across applications, or notes, file sharing, and video calls. **Discuss** enables communication through a persistent chat
through the dedicated *Discuss* dashboard. window that works across applications, or through the dedicated *Discuss* dashboard.
.. _discuss_app/notification_preferences: Upon opening the :menuselection:`Discuss app`, the :guilabel:`Discuss` dashboard appears.
Choose notifications preference Inbox, starred, and history
=============================== ===========================
Access user-specific preferences for the *Discuss* app by navigating to :menuselection:`Settings app Upon opening the :menuselection:`Discuss app`, the *Discuss* dashboard appears.
--> Users --> User --> Preferences tab`.
.. image:: discuss/preferences-user.png On the :guilabel:`Discuss` dashboard, unread messages are visible in the :icon:`fa-inbox`
:alt: View of the Preferences tab for Odoo Discuss. :guilabel:`Inbox`. :icon:`fa-star-o` :guilabel:`Starred` is where starred messages are stored.
:icon:`fa-history` :guilabel:`History` shows chatter updates for records in the Odoo database the
user has been assigned to, or tagged on.
By default, the :guilabel:`Notification` field is set as :guilabel:`Handle by Emails`. With this Direct messages
setting enabled, a notification email will be sent by Odoo every time a message is sent from the ===============
chatter, a note is sent with an `@` mention (from chatter), or a notification is sent for a record
that the user follows. Something that triggers a notification is changing of the stage (if an email\
is configured to be sent, for example if the task is set to :guilabel:`Done`).
By choosing :guilabel:`Handle in Odoo`, the above notifications are shown in the *Discuss* app's *Direct messages* allow the user to communicate privately with one or multiple team members. To
*inbox*. Messages can have the following actions taken on them: respond with an emoji by clicking start a new direct message, click the :icon:`fa-plus` icon, next to :guilabel:`Direct Messages` on
:guilabel:`Add a Reaction`, or reply to the message by clicking on :guilabel:`Reply`. Additional the :guilabel:`Discuss` dashboard, and enter the name of the desired person in the :guilabel:`Start
actions may include starring the message by clicking :guilabel:`Marked as Todo`, or pinning the a conversation` search bar that appears.
message by selecting :guilabel:`Pin` or even mark the message as unread by selecting
:guilabel:`Marked as unread`.
.. image:: discuss/reactions-discuss.png
:alt: View of an inbox message and its action options in Odoo Discuss.
Clicking :guilabel:`Mark as Todo` on a message causes it to appear on the :guilabel:`Starred` page,
while clicking :guilabel:`Mark as Read` moves the message to :guilabel:`History`.
.. image:: discuss/starred-messages.png
:alt: View of messages marked as todo in Odoo Discuss.
Start chatting
==============
The first time a user logs in to their account, OdooBot sends a message asking for permission to
send desktop notifications for chats. If accepted, the user will receive push notifications on their
desktop for the messages they receive, regardless of where the user is in Odoo.
.. image:: discuss/odoobot-push.png
:alt: View of the messages under the messaging menu emphasizing the request for push
notifications for Odoo Discuss.
.. tip:: .. tip::
To stop receiving desktop notifications, reset the notifications settings of the browser. Multiple names can be selected in the :guilabel:`Start a conversation` search bar. Once all of
the names have been entered, press :kbd:`Enter`.
To start a chat, go to the :menuselection:`Discuss` app and click on the :guilabel:`+ (plus)` icon Direct message actions
next to :guilabel:`Direct Messages` or :guilabel:`Channels` in the left menu of the dashboard. ----------------------
.. image:: discuss/channels-direct-messages.png Hover over a direct message in the chat window to see a menu of actions to take on the message.
:height: 400
:alt: View of Discuss's panel emphasizing the titles channels and direct messages in Odoo
Discuss.
A company can also easily create :doc:`public and private channels <discuss/team_communication>`. - :icon:`oi-smile-add` :guilabel:`(Add a Reaction)`: open a drop-down menu of emojis that can be
used to react to the direct message.
- :icon:`fa-reply` :guilabel:`(Reply)`: reply to the direct message in a thread.
- :icon:`fa-star-o` :guilabel:`(Mark as Todo)`: add the message to the :guilabel:`Starred` tab.
- :icon:`fa-ellipsis-h` :guilabel:`(Expand)`: reveals more message actions, including:
Mentions in the chat and on the chatter - :icon:`fa-thumb-tack` :guilabel:`Pin`
--------------------------------------- - :icon:`fa-eye-slash` :guilabel:`Mark as Unread`
- :icon:`fa-pencil` :guilabel:`Edit`
- :icon:`fa-trash` :guilabel:`Delete`
To mention a user within a chat or the chatter, type `@user-name`; to refer to a channel, type Conversation actions
`#channel-name`. The user mentioned will be notified in their *inbox* or through an email, depending --------------------
on their communication settings.
.. image:: discuss/chat-windows.png The icons in the top-right corner of a direct message conversation represent different actions the
:alt: View of a couple of chat window messages for Odoo Discuss. user can take on that conversation.
.. tip:: Click :icon:`fa-bell` :guilabel:`Notification Settings` to set up notification preferences for the
When a user is mentioned, the search list (list of names) suggests values first based on the conversation, or click :icon:`fa-phone` :guilabel:`Start a Call` to begin a meeting. See the
task's followers, and secondly on employees. If the record being searched does not match with :ref:`Meetings <discuss/meetings>` section for more information about meetings.
either a follower or employee, the scope of the search becomes all partners.
At the top of the direct message window, click the name of the direct message to change the group
name, and choose to add a description in the adjacent :guilabel:`Add a description` field.
.. image:: discuss/conversation-actions.png
:alt: View of the conversation actions.
.. note::
The :guilabel:`Add a description` field is **only** available for group messages with more than
two participants.
User status User status
----------- -----------
It is helpful to see what colleagues are up to and how quickly they can respond to messages by It is helpful to see what colleagues are up to, and how quickly they can respond to messages, by
checking their *status*. The status is shown on the left side of a contact's name on the checking their status. The status is displayed as a circle in the bottom-right corner of a contact's
:guilabel:`Discuss` sidebar, on the *messaging menu* and when listed in the *chatter*. photo in the :icon:`fa-users` :guilabel:`(Members List)`.
The color of the circle represents the user's status:
- Green = online - Green = online
- Orange = away - Orange = away
- White = offline - White = offline
- Airplane = out of the office - Airplane = out of the office
.. image:: discuss/status.png Leave a direct message conversation
:height: 300 -----------------------------------
:alt: View of the contacts' status for Odoo Discuss.
To leave a direct message conversations, click the :icon:`fa-times` :guilabel:`(Leave this channel)`
icon next to the conversation name in the :guilabel:`Direct Messages` section of the sidebar.
.. note::
Leaving a conversation does **not** delete the direct messages in the conversation. The direct
message conversation's history is visible when another direct message with the same person, or
group, is created.
.. _discuss/meetings:
Meetings
========
In **Discuss**, *Meetings* are video calls. To start a meeting from the :guilabel:`Discuss`
dashboard, click :guilabel:`Start a meeting` in the top-left corner, and select who to invite to the
meeting, via the :guilabel:`Invite People` drop-down window that appears. To start a meeting from a
direct message, click the :icon:`fa-phone` :guilabel:`Start a Call` icon in the top-right corner.
.. image:: discuss/meeting.png
:alt: View of a Meeting in Odoo Discuss.
Once a meeting has been started, the following buttons can be used:
+-----------------------------+--------------------------------+
| Icon | Use |
+=============================+================================+
| :icon:`fa-microphone` | :guilabel:`Mute` |
+-----------------------------+--------------------------------+
| :icon:`fa-microphone-slash` | :guilabel:`Unmute` |
+-----------------------------+--------------------------------+
| :icon:`fa-headphones` | :guilabel:`Deafen` |
+-----------------------------+--------------------------------+
| :icon:`fa-deaf` | :guilabel:`Undeafen` |
+-----------------------------+--------------------------------+
| :icon:`fa-video-camera` | :guilabel:`Turn camera on/off` |
+-----------------------------+--------------------------------+
| :icon:`fa-hand-paper-o` | :guilabel:`Raise Hand` |
+-----------------------------+--------------------------------+
| :icon:`fa-desktop` | :guilabel:`Share Screen` |
+-----------------------------+--------------------------------+
| :icon:`fa-arrows-alt` | :guilabel:`Enter Full Screen` |
+-----------------------------+--------------------------------+
.. _discuss_app/notification_preferences:
User-specific notification preferences
======================================
Access user-specific preferences for the **Discuss** app by navigating to :menuselection:`Settings
app --> Manage Users`, select a user, then click the :guilabel:`Preferences` tab.
.. image:: discuss/preferences-user.png
:alt: View of the Preferences tab for Odoo Discuss.
By default, the :guilabel:`Notification` field is set as :guilabel:`Handle by Emails`. With this
setting enabled, a notification email is sent by Odoo every time a message is sent from the chatter
of a record, a note is sent with an `@` mention (from the chatter of a record), or a notification is
sent for a record the user follows.
By choosing :guilabel:`Handle in Odoo`, the above notifications are shown in the **Discuss** app's
*Inbox*.
Chat from different applications
================================
The **Discuss** application enables communication across all of Odoo's applications. To view chats
and channels, or start a new message, select the speech bubbles that are consistently present in the
upper-right corner of the database header.
.. image:: discuss/discuss-in-other-apps.png
:alt: Use Discuss across other applications by clicking the speech bubbles.
.. seealso:: .. seealso::
- :doc:`discuss/team_communication` - :doc:`discuss/team_communication`
- :doc:`/applications/essentials/activities` - :doc:`/applications/essentials/activities`
- :doc:`discuss/ice_servers`
- :doc:`discuss/chatter`
.. toctree:: .. toctree::
:titlesonly: :titlesonly:

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.6 KiB

After

Width:  |  Height:  |  Size: 6.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB