Bug 332030 - No user help in systemsettings module kcm_baloofile
Summary: No user help in systemsettings module kcm_baloofile
Status: RESOLVED FIXED
Alias: None
Product: Baloo
Classification: Frameworks and Libraries
Component: General (show other bugs)
Version: unspecified
Platform: unspecified Linux
: NOR normal
Target Milestone: ---
Assignee: Vishesh Handa
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-03-11 13:58 UTC by Burkhard Lück
Modified: 2014-10-17 15:08 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Burkhard Lück 2014-03-11 13:58:16 UTC
kcm_baloofile has a Help button but clicking that leads to the page "Documentation not Found".

That is bad for several reasons:
Our ordinary user does know nothing about the switch from nepomuk to baloo, so he will be surprised to select "Desktop Search" in Systemsettings and get a different kcm now (no Basic Settings + Backup tab any more etc)
So there should be a help article containing at least:
1)  The still relevant parts from http://docs.kde.org/stable/en/kde-runtime/kcontrol/nepomuk/index.html adapted for baloo
2) Explanation what has change for his usage (e.g. no option to enable PIM indexing anymore, was that functionality removed? etc.) 
3) Hints for parallel use of nepomuk/baloo and hints for migrating and possible problems e.g. a link to http://forum.kde.org/viewtopic.php?f=154&t=120047&hilit=baloo
Comment 1 Vishesh Handa 2014-09-27 10:29:57 UTC
Confirmed. We definitely need some documentation. I'm not too keen on putting any Nepomuk migration information in there since this will only get added in Plasma 5.2.
Comment 2 Vishesh Handa 2014-10-17 15:08:30 UTC
Git commit 76b5e7c31678856750a1704f26c6f63a1af6a901 by Vishesh Handa.
Committed on 17/10/2014 at 14:21.
Pushed by vhanda into branch 'master'.

Add a basic doc file for the Baloo KCM

M  +1    -0    doc/kcontrol/CMakeLists.txt
A  +3    -0    doc/kcontrol/baloo/CMakeLists.txt
A  +51   -0    doc/kcontrol/baloo/index.docbook
M  +2    -0    kcms/baloo/kcm_baloofile.desktop

http://commits.kde.org/plasma-desktop/76b5e7c31678856750a1704f26c6f63a1af6a901