Bug 368413

Summary:	compositor documentation missing
Product:	[Websites] docs.kde.org	Reporter:	frautukka
Component:	Missing Content	Assignee:	Documentation Editorial Team <kde-doc-english>
Status:	CONFIRMED ---
Severity:	wishlist	CC:	keybounce, kwin-bugs-null, lueck, notuxius
Priority:	NOR
Version:	unspecified
Target Milestone:	---
Platform:	Kubuntu
OS:	Linux
Latest Commit:		Version Fixed In:
Sentry Crash Report:

Description frautukka 2016-09-07 18:04:05 UTC

I can' t find any documentation for the compositor module. 

Reproducible: Always

Steps to Reproduce:
1. In the "Display and Monitor" module open the "Compositor Settings for Desktop Effects" 
2. Click on "Help" 
3. Search in the Muon Package Manager, install libwayland-doc
4. Optionally go to the "KDE Documentation site" and search for compositor

Actual Results:  
After step 2. the KDE Help Center opens and says:
Documentation not Found
No change after step 3.
No documentation found online at the "KDE Documentation site"

Expected Results:  
After step 2 show the documentation, or point to the missing -doc package that should be installed. At least show some sort of documentation online.

Comment 1 Burkhard Lück 2016-09-11 08:53:38 UTC

In plasma 5.4 the old outdated kwincompositing docbook was removed and replaced with a link to https://userbase.kde.org/Desktop_Effects_Performance#Advanced_Desktop_Effects_Settings, see https://git.reviewboard.kde.org/r/124436/

If I open the Compositor kcm in systemsettings and click Help the page "Documentation not found" is displayed.
If I use "kcmshell5 kwincompositing" in konsole the Help action opens the userbase page properly.

Why this different behavior?

Comment 2 Alexander Mentyu 2018-03-29 17:29:48 UTC

'Documentation not Found' error is displayed in both cases - when launching Compositor window from System Settings and from console

Plasma: 5.12.3
Apps: 17.12.3
Frameworks: 5.44.0
Qt: 5.10.1
Kernel: 4.14.27-1-MANJARO
OS: Netrunner Rolling

Antergos Linux is launching userbase.kde.org help page in browser also in both cases

Comment 3 Burkhard Lück 2018-03-29 18:30:57 UTC

kwincompositing.desktop points to
X-DocPath=https://userbase.kde.org/Desktop_Effects_Performance#Advanced_Desktop_Effects_Settings

This is intended, but obviously does noct work in up to date neon devedition unstable oer master

Comment 4 keybounce 2024-02-12 17:49:21 UTC

I cannot believe this. I wanted to report this same missing documentation. And ... this is now 7 years without even an explanation of what a compositor is or why I need it? And there's a reddit article saying that there's three different ones to choose from (really? what do they do different?), but that article is so old it has no usable current information.

Seven years without adding a documentation package? And no "Install this as a work-around"?

The "documentation not found" article says to search for the program on the documentation site, and see if it's there under a different name. I could not find a single name that was found and could turn up documentation for the compositor.