This forum has been archived. All content is frozen. Please use KDE Discuss instead.

Move KDE documentation to a wiki

47

Votes
52
5
Tags: None
(comma "," separated)
Sepp
Registered Member
Posts
13
Karma
0
OS

Move KDE documentation to a wiki

Mon Mar 23, 2009 9:37 am
Some (or most?) of the KDE user documentation shipped with KDE 4 is out of date. Look at http://docs.kde.org/
Many users are willing to write Documentation for the apps they use, but don't want to fiddle with docbook or tools like that.
Therefore the KDE documentation should be moved to a wiki - so users can get involved in writing/translating documentation easier and faster.


User avatar
neverendingo
Administrator
Posts
2136
Karma
17
OS

Last edited by neverendingo on Mon Mar 23, 2009 9:40 am, edited 1 time in total.


New to KDE Software? - get help from Userbase or ask questions on the Forums
Communicate.
Image
Sepp
Registered Member
Posts
13
Karma
0
OS
Yes, there are user wikis, but I mean the official application documentation (manuals), shipped with every KDE release.
The juK manual, for example is from 2004!


User avatar
neverendingo
Administrator
Posts
2136
Karma
17
OS
I heard the doc team rejected the idea of putting all docus on a wiki.
Though it is still possible as user to enter above wikis and put in every info you want.

This reminds me, i should poke some mentor to put up a doku writing kourse... ;-P


New to KDE Software? - get help from Userbase or ask questions on the Forums
Communicate.
Image
Sepp
Registered Member
Posts
13
Karma
0
OS

RE: Move KDE documentation to a wiki

Mon Mar 23, 2009 10:01 am
Do you know why they rejected the idea?

The current documentation is not very useful - what's the point to click on "Help" if you get a manual that's 4 years old?

If they don't want a wiki, they shoul provide another easy way for users to contribute.


pinotree
KDE Developer
Posts
222
Karma
7
OS

RE: Move KDE documentation to a wiki

Mon Mar 23, 2009 10:10 am
You can just subscribe to the kde-doc-english mailing list (https://mail.kde.org/mailman/listinfo/kde-doc-english) and say that you want to contribute. You don't even need to know svn or docbook, just sending even plain text files with documentation updates should be more than enough.


Pino Toscano
User avatar
zander
KDE Developer
Posts
87
Karma
1

RE: Move KDE documentation to a wiki

Thu Mar 26, 2009 10:51 am
The KOffice guys came to the same conclusion; the current system doesn't work and a wiki might help. You can find KWords manual on userbase already :)
Go update it now! :D


Thomas Zander
KWord maintainer
metellius
KDE Developer
Posts
13
Karma
0
Wiki is the way to go now. I don't believe docbooks and offline-only manuals, however simple it is to contribute to them, is going much further. Look at gentoo's wiki, it's great. When I used gentoo, I always found what I needed on there.


Harald Hvaal AKA metellius
Ark maintainer
Find me in #kde-devel on freenode
User avatar
Ujjwol
Registered Member
Posts
136
Karma
1
OS
Wiki is great, i think KDE should implement that faster...


Ujjwol, proud user of KDE 4 and member of KDE forums since 2008-Oct.
Image
Image
Rms-Mit
Registered Member
Posts
58
Karma
0
OS

RE: Move KDE documentation to a wiki

Wed Apr 01, 2009 11:14 pm
I think the ideal would be a bit of both. If there was an online wiki that users could edit it would make for easy contributions and finding the most up to date stuff easy.

BUT

I think there should be a tool that would then take that wiki and convert it to the usual KDE help files to included into the next KDE release.

That way the Help files would be both up to date and availble online and at a known state and in standard help file format in KDE.

It's the tools to conver from wiki to KDE help files that is the hard bit :undecided:
pembo13
Registered Member
Posts
75
Karma
0
OS
Rms-Mit wrote:I think there should be a tool that would then take that wiki and convert it to the usual KDE help files to included into the next KDE release.


Ideally, every release, someone(s) would sanitize the wiki covert them to docbooks and ship them.
pinotree
KDE Developer
Posts
222
Karma
7
OS
pembo13 wrote:
Rms-Mit wrote:I think there should be a tool that would then take that wiki and convert it to the usual KDE help files to included into the next KDE release.


Ideally, every release, someone(s) would sanitize the wiki covert them to docbooks and ship them.

... and say goobye to translations, right!


Pino Toscano
pembo13
Registered Member
Posts
75
Karma
0
OS
pinotree wrote:... and say goobye to translations, right!


Good point. The translation team will have to give their input here, though there's no reason why a wiki can't support multiple languages.
User avatar
Hans
Administrator
Posts
3304
Karma
24
OS
help-with-the-kwor ... 39933.html
Time to show that you, the users, are willing to contribute to something like this. ;)


Problem solved? Please click on "Accept this answer" below the post with the best answer to mark your topic as solved.

10 things you might want to do in KDE | Open menu with Super key | Mouse shortcuts
User avatar
Ujjwol
Registered Member
Posts
136
Karma
1
OS
ArchLinux and Gentoo have their documentation in wiki and which is having great contributions...


Ujjwol, proud user of KDE 4 and member of KDE forums since 2008-Oct.
Image
Image


Bookmarks



Who is online

Registered users: Bing [Bot], Evergrowing, Google [Bot]