[IMP] Discuss: Improve the documentation page

This commit is contained in:
Yannick Tivisse 2016-02-11 10:28:50 +01:00
parent a90cd21547
commit 3dd49ab2c4
13 changed files with 243 additions and 86 deletions

View File

@ -7,25 +7,101 @@ Discuss
Overview
========
Odoo Discuss is an easy-to-use messaging app for teams that brings all
your organizations communication into one place and integrates with the
Odoo platform. Discuss lets you send and receive messages from wherever
you are in Odoo as well as manage your messages and notifications easily
from within the app. Discuss allows you to create **channels** for team
chats, conversations about projects, meeting coordination, and more in
one simple and searchable interface.
Odoo Discuss is an easy to use messaging app for teams that brings all
your organization's communication into one place and seamlessly
integrates with the Odoo platform. Discuss lets you send and receive
messages from wherever you are in Odoo as well as manage your messages
and notifications easily from within the app. Discuss allows you to
create **channels** for team chats, conversations about projects,
meeting coordination, and more in one simple and searchable
interface.
.. image:: media/discuss01.png
:align: center
Communicating with Your Team Using Channels
===========================================
You can use **channels** to organize discussions between individual
teams, departments, projects, or any other group that requires regular
communication. By having conversations that everyone in the channel can
see, it's easy to keep the whole team in the loop with the latest
developments.
Creating a Channel
------------------
In Discuss there are two types of channels - **public** and
**private**.
A **public channel** can only be created by an administrator with
write privileges and can be seen by everyone in the organization. By
contrast, a **private channel** can be created by any user and by
default is only visible to users who have been invited to this
channel.
.. note::
A public channel is best used when many employees need to
access information (such as interdepartmental communication or
company announcements), whereas a private channel should be used
whenever information should be limited to specific users/employees
(such as department specific or sensitive information).
Configuring a Channel
---------------------
You can configure a channel's name, description, access rights,
automatic subscription, and emailing from
:menuselection:`#channel-name --> Settings`.
Changing channel access rights allows
you to control which groups can view each channel. You can make a
channel visible by all users, invited users, or users within a
selected user group. Note that allowing "Everyone" to follow a
private channel will let other users view and join it as they would
a public channel.
.. image:: media/discuss02.png
:align: center
How To Set Up a Mailing List
----------------------------
A channel can be configured to behave as a mailing list. From within
:menuselection:`#channel-name --> Settings`, define the email you would like to use.
Users can then post to the channel and choose to receive
notifications using the defined email address. An envelope icon will
appear next to the channel name in the list to indicate that a
channel will send messages by email.
Locating a Channel
------------------
If you do not see a channel on your dashboard, you can search the
list of **public channels** to locate the correct channel or create
a new channel by clicking the plus icon.
.. image:: media/discuss03.png
:align: center
You can also click the **CHANNELS** heading to browse a list of all
public channels. This allows the user to manually **join** and
**leave** public channels from a single screen.
.. note::
It is always wise to search for a channel before creating a new
one to ensure that duplicate entries are not created for the same topic.
Monitoring Your Messages Using the Inbox
========================================
.. image:: media/getting_started01.png
.. image:: media/discuss04.png
:align: center
Use the **inbox** to monitor updates and progress on everything you do
in Odoo. Notifications from everything you follow and conversations in
which you are mentioned appear in your inbox.
.. image:: media/getting_started02.png
.. image:: media/discuss05.png
:align: center
Marking an item with a check sets the message to **read** and removes it
@ -34,58 +110,75 @@ or action, mark it with a star to add it to the **Starred** box. You can
star any message or notification in Discuss or any of the item-specific
chatters throughout Odoo to keep tabs on it here.
Communicating with Your Team Using Channels
===========================================
Sending Emails
--------------
You can use **channels** to organize discussions between individual
teams, departments, projects, and any other communication need. By
having conversations that everyone in the **channel** can see, its easy
to keep the whole team in the loop with the latest developments. You can
attach files with Odoo Discuss just as you would in an email.If you need
to draw someones attention to a conversation, you can mention them by
typing @user-name. They will see a notification in their inbox and be
notified by email. Discuss can also alert you with desktop notifications
when you receive a new message.
You can **send emails** from the inbox of Odoo Discuss. In addition
to the usual email features, you can select a template that you have
already created, or create one on the fly and save it for later use.
You can search the list of **public channels** or create a new
**channel** by clicking the plus icon.
Grabbing Attention with Direct Messages and Mentions
====================================================
.. image:: media/getting_started03.png
You can **mention** a user in a channel or chatter by typing
**@user-name**. Mentioning a user in the chatter will set them as a
follower of the item (if they are not already) and send a message to
their inbox. The item containing the mention will also be bolded in the
list view. Mentioning a user in a channel will send a message to their
inbox. You cannot mention a user in a channel who is not subscribed to
the channel. Typing **#channel-name** will provide a link to the
mentioned channel in either a chatter or another channel.
Direct Messaging a User
-----------------------
**Direct messages** are private messages viewable only by the sender
and recipient. You can send direct messages to other users from
within the Discuss module by creating a new conversation or
selecting an existing one from the sidebar. Direct messages can be
sent from anywhere in Odoo using the speech bubble icon in the top
bar. The online status of other users is displayed to the left of
their name. A **green dot** indicates that a user is Online, an
**orange dot** that they are Idle, and a **grey dot** that they are
offline.
Desktop Notifications from Discuss
----------------------------------
You can choose to see **desktop notifications** when you receive a
new direct message. The notification shows you the sender and a
brief preview of the message contents. These can be configured or
disabled by clicking on the gear icon in the corner of the
notification..
.. image:: media/discuss06.png
:align: center
Channels can be configured to aggregate emails from a specified address
and to send messages as emails. You can also define who can join and who
will be automatically included in a channel.
Tracking Important Topics, Projects, and Conversations
======================================================
.. image:: media/getting_started04.png
You can keep track of virtually any object in Odoo, such as a Task or
Quotation, by **following** it. An item can be followed from the item
view, just above the chatter.
.. image:: media/discuss07.png
:align: center
Desktop notifications allow quick previews of incoming messages without
interrupting what you are currently working on. These can be configured
or disabled via **preferences**.
You can choose which types of events to follow, with the depending on
the type of item. The example below shows the options available when
following a **task** in the **Projects** **Module**.
You Can Take it with You
========================
Click **Detach** to move a conversation to a detached window that stays
with you when navigating from app to app. Conversations can be accessed
universally from the speech bubble icon in the top bar.
In addition to public channels and direct messages, you can create
private channels to discuss anything that is sensitive, confidential, or
otherwise unfit for a public channel. You can configure who is allowed
to join and follow private channels exactly as you would for a public
channel, however a private channel is only visible to its participants.
Website Livechat
================
.. image:: media/getting_started05.png
.. image:: media/discuss08.png
:align: center
If you have the **Website Livechat** module installed, new messages will
appear in the Discuss module allowing you to navigate between them as
you would with direct messages.
You can invite other users and add channels as followers. Adding a
channel as a follower will send messages posted in the chatter to the
channel with a link back to the original document.
.. image:: media/discuss09.png
:align: center
.. image:: media/discuss10.png
:align: center
Using Filters to Navigate within Discuss
========================================
@ -93,5 +186,5 @@ Using Filters to Navigate within Discuss
The topbar search provides access to the same comprehensive search
function present in the rest of Odoo. You can apply multiple **filter
criteria** and **save filters** for later use. The search function
accepts wildcards by using the underscore character “\ **\_**\ ” to
represent a **single character wildcard**.
accepts wildcards by using the underscore character "\ **\_**\ " to
represent a **single character wildcard.**

BIN
discuss/media/discuss01.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 KiB

BIN
discuss/media/discuss02.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

View File

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View File

Before

Width:  |  Height:  |  Size: 3.0 KiB

After

Width:  |  Height:  |  Size: 3.0 KiB

View File

Before

Width:  |  Height:  |  Size: 7.5 KiB

After

Width:  |  Height:  |  Size: 7.5 KiB

View File

Before

Width:  |  Height:  |  Size: 5.6 KiB

After

Width:  |  Height:  |  Size: 5.6 KiB

BIN
discuss/media/discuss07.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.2 KiB

BIN
discuss/media/discuss08.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.8 KiB

BIN
discuss/media/discuss09.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.7 KiB

BIN
discuss/media/discuss10.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

View File

@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Odoo Business 9.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2016-02-08 10:50+0100\n"
"POT-Creation-Date: 2016-02-11 10:31+0100\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
@ -26,66 +26,130 @@ msgid "Overview"
msgstr ""
#: ../../discuss/getting_started.rst:10
msgid "Odoo Discuss is an easy-to-use messaging app for teams that brings all your organizations communication into one place and integrates with the Odoo platform. Discuss lets you send and receive messages from wherever you are in Odoo as well as manage your messages and notifications easily from within the app. Discuss allows you to create **channels** for team chats, conversations about projects, meeting coordination, and more in one simple and searchable interface."
msgid "Odoo Discuss is an easy to use messaging app for teams that brings all your organization's communication into one place and seamlessly integrates with the Odoo platform. Discuss lets you send and receive messages from wherever you are in Odoo as well as manage your messages and notifications easily from within the app. Discuss allows you to create **channels** for team chats, conversations about projects, meeting coordination, and more in one simple and searchable interface."
msgstr ""
#: ../../discuss/getting_started.rst:19
msgid "Monitoring Your Messages Using the Inbox"
msgstr ""
#: ../../discuss/getting_started.rst:24
msgid "Use the **inbox** to monitor updates and progress on everything you do in Odoo. Notifications from everything you follow and conversations in which you are mentioned appear in your inbox."
msgstr ""
#: ../../discuss/getting_started.rst:31
msgid "Marking an item with a check sets the message to **read** and removes it from your inbox. If you would like to save an item for future reference or action, mark it with a star to add it to the **Starred** box. You can star any message or notification in Discuss or any of the item-specific chatters throughout Odoo to keep tabs on it here."
msgstr ""
#: ../../discuss/getting_started.rst:38
#: ../../discuss/getting_started.rst:23
msgid "Communicating with Your Team Using Channels"
msgstr ""
#: ../../discuss/getting_started.rst:40
msgid "You can use **channels** to organize discussions between individual teams, departments, projects, and any other communication need. By having conversations that everyone in the **channel** can see, its easy to keep the whole team in the loop with the latest developments. You can attach files with Odoo Discuss just as you would in an email.If you need to draw someones attention to a conversation, you can mention them by typing @user-name. They will see a notification in their inbox and be notified by email. Discuss can also alert you with desktop notifications when you receive a new message."
#: ../../discuss/getting_started.rst:25
msgid "You can use **channels** to organize discussions between individual teams, departments, projects, or any other group that requires regular communication. By having conversations that everyone in the channel can see, it's easy to keep the whole team in the loop with the latest developments."
msgstr ""
#: ../../discuss/getting_started.rst:50
msgid "You can search the list of **public channels** or create a new **channel** by clicking the plus icon."
#: ../../discuss/getting_started.rst:32
msgid "Creating a Channel"
msgstr ""
#: ../../discuss/getting_started.rst:56
msgid "Channels can be configured to aggregate emails from a specified address and to send messages as emails. You can also define who can join and who will be automatically included in a channel."
#: ../../discuss/getting_started.rst:34
msgid "In Discuss there are two types of channels - **public** and **private**."
msgstr ""
#: ../../discuss/getting_started.rst:63
msgid "Desktop notifications allow quick previews of incoming messages without interrupting what you are currently working on. These can be configured or disabled via **preferences**."
#: ../../discuss/getting_started.rst:37
msgid "A **public channel** can only be created by an administrator with write privileges and can be seen by everyone in the organization. By contrast, a **private channel** can be created by any user and by default is only visible to users who have been invited to this channel."
msgstr ""
#: ../../discuss/getting_started.rst:68
msgid "You Can Take it with You"
#: ../../discuss/getting_started.rst:44
msgid "A public channel is best used when many employees need to access information (such as interdepartmental communication or company announcements), whereas a private channel should be used whenever information should be limited to specific users/employees (such as department specific or sensitive information)."
msgstr ""
#: ../../discuss/getting_started.rst:70
msgid "Click **Detach** to move a conversation to a detached window that stays with you when navigating from app to app. Conversations can be accessed universally from the speech bubble icon in the top bar."
#: ../../discuss/getting_started.rst:51
msgid "Configuring a Channel"
msgstr ""
#: ../../discuss/getting_started.rst:74
msgid "In addition to public channels and direct messages, you can create private channels to discuss anything that is sensitive, confidential, or otherwise unfit for a public channel. You can configure who is allowed to join and follow private channels exactly as you would for a public channel, however a private channel is only visible to its participants."
#: ../../discuss/getting_started.rst:53
msgid "You can configure a channel's name, description, access rights, automatic subscription, and emailing from :menuselection:`#channel-name --> Settings`. Changing channel access rights allows you to control which groups can view each channel. You can make a channel visible by all users, invited users, or users within a selected user group. Note that allowing \"Everyone\" to follow a private channel will let other users view and join it as they would a public channel."
msgstr ""
#: ../../discuss/getting_started.rst:81
msgid "Website Livechat"
#: ../../discuss/getting_started.rst:67
msgid "How To Set Up a Mailing List"
msgstr ""
#: ../../discuss/getting_started.rst:69
msgid "A channel can be configured to behave as a mailing list. From within :menuselection:`#channel-name --> Settings`, define the email you would like to use. Users can then post to the channel and choose to receive notifications using the defined email address. An envelope icon will appear next to the channel name in the list to indicate that a channel will send messages by email."
msgstr ""
#: ../../discuss/getting_started.rst:77
msgid "Locating a Channel"
msgstr ""
#: ../../discuss/getting_started.rst:79
msgid "If you do not see a channel on your dashboard, you can search the list of **public channels** to locate the correct channel or create a new channel by clicking the plus icon."
msgstr ""
#: ../../discuss/getting_started.rst:86
msgid "If you have the **Website Livechat** module installed, new messages will appear in the Discuss module allowing you to navigate between them as you would with direct messages."
msgid "You can also click the **CHANNELS** heading to browse a list of all public channels. This allows the user to manually **join** and **leave** public channels from a single screen."
msgstr ""
#: ../../discuss/getting_started.rst:91
msgid "It is always wise to search for a channel before creating a new one to ensure that duplicate entries are not created for the same topic."
msgstr ""
#: ../../discuss/getting_started.rst:95
msgid "Monitoring Your Messages Using the Inbox"
msgstr ""
#: ../../discuss/getting_started.rst:100
msgid "Use the **inbox** to monitor updates and progress on everything you do in Odoo. Notifications from everything you follow and conversations in which you are mentioned appear in your inbox."
msgstr ""
#: ../../discuss/getting_started.rst:107
msgid "Marking an item with a check sets the message to **read** and removes it from your inbox. If you would like to save an item for future reference or action, mark it with a star to add it to the **Starred** box. You can star any message or notification in Discuss or any of the item-specific chatters throughout Odoo to keep tabs on it here."
msgstr ""
#: ../../discuss/getting_started.rst:114
msgid "Sending Emails"
msgstr ""
#: ../../discuss/getting_started.rst:116
msgid "You can **send emails** from the inbox of Odoo Discuss. In addition to the usual email features, you can select a template that you have already created, or create one on the fly and save it for later use."
msgstr ""
#: ../../discuss/getting_started.rst:121
msgid "Grabbing Attention with Direct Messages and Mentions"
msgstr ""
#: ../../discuss/getting_started.rst:123
msgid "You can **mention** a user in a channel or chatter by typing **@user-name**. Mentioning a user in the chatter will set them as a follower of the item (if they are not already) and send a message to their inbox. The item containing the mention will also be bolded in the list view. Mentioning a user in a channel will send a message to their inbox. You cannot mention a user in a channel who is not subscribed to the channel. Typing **#channel-name** will provide a link to the mentioned channel in either a chatter or another channel."
msgstr ""
#: ../../discuss/getting_started.rst:133
msgid "Direct Messaging a User"
msgstr ""
#: ../../discuss/getting_started.rst:135
msgid "**Direct messages** are private messages viewable only by the sender and recipient. You can send direct messages to other users from within the Discuss module by creating a new conversation or selecting an existing one from the sidebar. Direct messages can be sent from anywhere in Odoo using the speech bubble icon in the top bar. The online status of other users is displayed to the left of their name. A **green dot** indicates that a user is Online, an **orange dot** that they are Idle, and a **grey dot** that they are offline."
msgstr ""
#: ../../discuss/getting_started.rst:146
msgid "Desktop Notifications from Discuss"
msgstr ""
#: ../../discuss/getting_started.rst:148
msgid "You can choose to see **desktop notifications** when you receive a new direct message. The notification shows you the sender and a brief preview of the message contents. These can be configured or disabled by clicking on the gear icon in the corner of the notification.."
msgstr ""
#: ../../discuss/getting_started.rst:158
msgid "Tracking Important Topics, Projects, and Conversations"
msgstr ""
#: ../../discuss/getting_started.rst:160
msgid "You can keep track of virtually any object in Odoo, such as a Task or Quotation, by **following** it. An item can be followed from the item view, just above the chatter."
msgstr ""
#: ../../discuss/getting_started.rst:167
msgid "You can choose which types of events to follow, with the depending on the type of item. The example below shows the options available when following a **task** in the **Projects** **Module**."
msgstr ""
#: ../../discuss/getting_started.rst:174
msgid "You can invite other users and add channels as followers. Adding a channel as a follower will send messages posted in the chatter to the channel with a link back to the original document."
msgstr ""
#: ../../discuss/getting_started.rst:184
msgid "Using Filters to Navigate within Discuss"
msgstr ""
#: ../../discuss/getting_started.rst:93
msgid "The topbar search provides access to the same comprehensive search function present in the rest of Odoo. You can apply multiple **filter criteria** and **save filters** for later use. The search function accepts wildcards by using the underscore character “\\ **\\_**\\ ” to represent a **single character wildcard**."
#: ../../discuss/getting_started.rst:186
msgid "The topbar search provides access to the same comprehensive search function present in the rest of Odoo. You can apply multiple **filter criteria** and **save filters** for later use. The search function accepts wildcards by using the underscore character \"\\ **\\_**\\ \" to represent a **single character wildcard.**"
msgstr ""