Bug 245357

Summary: No manual
Product: [Unmaintained] Network Management Reporter: Christopher Yeleighton <giecrilj>
Component: Control ModuleAssignee: Will Stephenson <wstephenson>
Status: RESOLVED DUPLICATE    
Severity: normal CC: james, Jan-Beren-Ansgar-Kropik, kde-doc-english, lamarque
Priority: NOR    
Version: 0.9   
Target Milestone: ---   
Platform: openSUSE   
OS: Linux   
Latest Commit: Version Fixed In:
Sentry Crash Report:

Description Christopher Yeleighton 2010-07-21 21:21:11 UTC
Version:           0.9 (using KDE 4.3.5) 
OS:                Linux

The manual for kcm_networkmanagement does not exist

Reproducible: Always

Steps to Reproduce:
1. Open Network Connections control panel.
2. Press the Help button beneath.

Actual Results:  
2. Nothing happens.

Expected Results:  
2. The corresponding manual.
Comment 1 Burkhard Lück 2010-07-22 09:11:40 UTC
KNetworkmanager really needs a manual, and I offer any help from the docbook side to write one.
Networking is very complicated, my knowledge of that is limited, so without technical input from devels it is impossible for me to write a manual.

This manual should have several chapters:

* A glossar with a short explanation of all these "strange" terms used in the gui, I am sure Joe User does only understand less than half of them. And without a minimum understanding of the meaning of these term he is unable to use that module

* Quickstart
Just the minimum - and typical- settings needed for any possible type of connection
Using the plasma applet

* Advanced
Use cases for all these settings
Managed / unmanaged connetction
Relation to /etc/network/interfaces (do I need that any more / concflicts)
Troubleshooting eg
why do the settings in /var/lib/NetworkManager/NetworkManager.state sometimes seem to change magically?
Comment 2 Burkhard Lück 2010-08-07 09:25:15 UTC
*** Bug 246951 has been marked as a duplicate of this bug. ***
Comment 3 Lamarque V. Souza 2011-07-07 21:30:42 UTC

*** This bug has been marked as a duplicate of bug 231613 ***
Comment 4 Jan Kropik 2016-06-16 08:38:14 UTC
Yeah and list of regular Expressions used and how the programmer use and understand them, it is proof that this was and is always a problem in interdisciplinary routines.

Not any Joe User is patient enough to read the Full Versions before trying.
Learning is easier while doing stuff, 

And a Link to the Online Material Coders for their self used as Reference 
or a proper List of that.  Who wants to learn only the unnecessary Special Knowledge? 
or is able to that.

explaining complicate things into the Blue Sky is a little disturbing. 
So user will forgive missing Helps... but will continue stupid asking.