e3fee2cf46
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
82 lines
3.1 KiB
ReStructuredText
82 lines
3.1 KiB
ReStructuredText
=====================================================
|
|
How to efficiently communicate in 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.
|
|
|
|
|
|
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.** |