Skip to content

Commit f4c091b

Browse files
Donapixpl-odoo
authored andcommitted
[ADD] forum: create the forum documentation
This PR adds a page describing how to create, use and moderate a forum. It creates references in the elearning page as karma features are shared. It removes redundant information from the helpdesk/overview/help_center page and links back to the more detailed forum page. task-3283274 closes #5672 X-original-commit: c60ec48 Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
1 parent 040e5ac commit f4c091b

File tree

10 files changed

+411
-86
lines changed

10 files changed

+411
-86
lines changed

content/applications/services/helpdesk/overview/help_center.rst

Lines changed: 6 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Help center
33
===========
44

5-
Odoo *Helpdesk* integrates with the *Forums*, *eLearning*, and *Knowledge* apps to create the *help
5+
Odoo *Helpdesk* integrates with the *Forum*, *eLearning*, and *Knowledge* apps to create the *help
66
center*.
77

88
.. image:: help_center/help-center-enable-features.png
@@ -171,6 +171,8 @@ make any necessary additions or edits to the template, then click :guilabel:`Sen
171171
Doing so will not replace the existing text in a ticket's description. The template will be added
172172
as additional text.
173173

174+
.. _helpdesk/forum:
175+
174176
Community Forum
175177
===============
176178

@@ -199,91 +201,9 @@ menu to enable that forum.
199201
To create a new forum, type a name into the blank :guilabel:`Forums` field, then click the
200202
:guilabel:`Create and Edit` option. Multiple forums can be selected in this field.
201203

202-
Set up a forum
203-
--------------
204-
205-
The settings on a forum are managed through either the *Website* or *eLearning* applications. From
206-
the Odoo Dashboard, navigate to :menuselection:`Website --> Configuration --> Forums` or
207-
:menuselection:`eLearning --> Forum --> Forums`. In either case, select a forum to edit from the
208-
list.
209-
210-
On the forum detail form, select a mode.
211-
212-
The :guilabel:`Questions` mode allows for one answer/response for each post, while
213-
:guilabel:`Discussion` mode allows for multiple responses. To limit the forum to a single website,
214-
select it from the :guilabel:`Website` field.
215-
216-
Under the :guilabel:`Order and Visibility` section, in the :guilabel:`Options` tab, choose how the
217-
posts should be sorted, by modifying the :guilabel:`Default Sort` field. Change the
218-
:guilabel:`Privacy` setting to change which users will have access to the forum.
219-
220-
Below these settings, there is space to add a description for the forum. This description will be
221-
visible on the website where the forum is published.
222-
223-
.. image:: help_center/help-center-forum-settings.png
224-
:align: center
225-
:alt: Overview of a forum's settings page in Odoo Helpdesk.
226-
227-
Karma gains and karma related rights
228-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
229-
230-
When users interact on forums - either through posting questions, submitting answers, or upvoting
231-
responses - they earn points, called *karma*.
232-
233-
Karma points are used to build the credibility of a user within the community. The more positive
234-
interactions a user has on the forum, the more karma points they gain. Certain activities, such as
235-
posting without validation, or editing posts, require users to have earned a specific level of karma
236-
points to prove their legitimacy and trustworthiness.
237-
238-
These figures can be adjusted on the :guilabel:`Karma gains` and :guilabel:`Karma related rights`
239-
tabs, located on the forums detail form.
240-
241-
.. tabs::
242-
243-
.. tab:: Karma gains
244-
245-
In the :guilabel:`Karma gains` tab, there are listed actions that will cause users to gain
246-
(or lose) karma points. Those actions are:
247-
248-
- Asking a question
249-
- Question upvoted
250-
- Question downvoted
251-
- Answer upvoted
252-
- Answer downvoted
253-
- Accepting an answer
254-
- Answer accepted
255-
- Answer flagged
256-
257-
.. tab:: Karma related rights
258-
259-
In the :guilabel:`Karma related rights` tab, there are listed activities that users cannot
260-
complete, without having a specific level of karma points. Those activities are:
261-
262-
- Ask questions
263-
- Answer questions
264-
- Upvote
265-
- Downvote
266-
- Edit own posts
267-
- Edit all posts
268-
- Close own posts
269-
- Close all posts
270-
- Delete own posts
271-
- Delete all posts
272-
- Nofollow links
273-
- Accept an answer on own question
274-
- Accept an answer to all questions
275-
- Editor features: image and links
276-
- Comment on own posts
277-
- Comment on all posts
278-
- Convert own answers to comments (and vice versa)
279-
- Convert all answers to comments (and vice versa)
280-
- Unlink own comments
281-
- Unlink all comments
282-
- Ask questions without validation
283-
- Flag a post as offensive
284-
- Moderate posts
285-
- Change question tags
286-
- Create new tags
204+
.. seealso::
205+
Check out the :doc:`Forum documentation <../../../websites/forum>` to learn how to configure,
206+
use, and moderate a forum.
287207

288208
Create a forum post from a Helpdesk ticket
289209
------------------------------------------

content/applications/websites.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ Websites
1010
websites/website
1111
websites/ecommerce
1212
websites/elearning
13+
websites/forum
1314
websites/livechat

content/applications/websites/elearning.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ It appears in the course content on your website.
214214
:align: center
215215
:alt: Additional ressources
216216

217+
.. _elearning/quiz:
218+
217219
Quiz tab
218220
--------
219221

0 commit comments

Comments
 (0)