Projects/Documentation/KDE: Difference between revisions

From KDE TechBase
(Make sure the information in the page is at least not horribly outdated)
 
(28 intermediate revisions by 6 users not shown)
Line 1: Line 1:
= KDE 4 Documentation Tasks =
{{Warning | The Techbase wiki is going away as soon as its content is ported elsewhere. The information here may be outdated.}}
The following task list is broken down by experience as closely as possible. It is recommended that you join #kde-docs on IRC (Freenode) and coordinate with the other members as to not create any problems or duplicate work. Currently the channel is quite slow and quiet.
 
= KDE Documentation Tasks =
The following task list is broken down by experience as closely as possible. It is recommended that you [https://community.kde.org/Get_Involved/documentation get in touch with the team] and coordinate with the other members so
as not to create any problems or duplicate work. Currently the channel is quite slow and quiet.


If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.
If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.


If you haven't yet subscribed to the KDE Documentation mailing list, please do so now at https://mail.kde.org/mailman/listinfo/kde-doc-english and say hello. Maybe provide a little bit of information as well as your experience.
If you haven't yet subscribed to the KDE Documentation mailing list, please do so now at [https://mail.kde.org/mailman/listinfo/kde-doc-english the mail manager] and say hello. Maybe provide a little bit of information as well as your experience.


'''NOTE:''' Please use the [[#EBN|English Breakfast Network]] while working on documentation.
== Beginner ==
=== Documentation Primer ===


== Beginner ==
Here is a [http://l10n.kde.org/docs/doc-primer comprehensive manual] about KDE DocBooks creating.
=== EBN ===
EBN, or the [http://www.englishbreakfastnetwork.org English Breakfast Network], is a utility that both developers and documentation writers use to make sure they have created perfection for KDE. For documentation, there is are 2 utilities which will make your work easier:
# [http://www.englishbreakfastnetwork.org/sanitizer/?component=kde-4.x Documentation Sanitizer] - this utility within the EBN scours the trunk of the subversion repository checking the format of the documentation, discovering typos, grammar, markup, and more. This is a perfect utility for beginners looking to contribute as this tool pretty much tells you how to fix the issues.
# [http://www.englishbreakfastnetwork.org/sanitizer/just-in-time.php Just In Time] - this utility allows you to check your code/documentation and it will provide the same information that the sanitizer above produces. Use this before committing your patches or committing to subversion.


=== KColorEdit ===
=== Useful Links on Wikis ===
* '''Location:''' trunk/extragear/graphics
* '''Status:''' Needs updating and new material
* '''Info:''' Should be a fairly straight forward process with the updating and new material addition.
* '''Document writer:''' ''TimS on IRC, or via the mailing list.''


=== Gwenview ===
* [[Projects/Documentation/KDE_(health_table)|Health Table]]. Please do not hesitate to improve it.
* '''Location:''' trunk/KDE/kdegraphics
* [https://community.kde.org/Schedules Current release schedule and feature plan]
* '''Status:''' Needs updating
* '''Info:''' Documentation is based on the KDE 3 release, needs to be updated to match the KDE 4 release.
* '''Document writer:''' ''Henry de Valence: hdevalence (at) gmail (dot) com''


== Intermediate ==
== Intermediate ==
=== Kalzium ===
* '''Location:''' trunk/KDE/kdeedu
* '''Status:''' Needs updating and new material
* '''Info:''' Many parts of the Kalzium document needs to be updated and there are yet many parts that haven't been documented.
* '''Document writer:''' ''Karthik Periagaram (karthikp on IRC, karthikp AT gatech DOT edu)''
=== Parley ===
* '''Location:''' trunk/KDE/kdeedu
* '''Status:''' Needs updating and new material
* '''Info:''' There are quite a bit of KDE 3 and KVocTrain references still in the documentation.
* '''Document writer:''' ''Stephanie Whiting stephaniewhiting on IRC, [email protected]''
=== Step ===
* '''Location:''' trunk/KDE/kdeedu/doc/step
* '''Status:''' Examples need to be documented, a template is started as examples.docbook - Index.docbook can be improved.
* '''Info:''' You need to be good in Physics - coordinate with annma
* '''Document writer:'''
** Object Info: [[User:JLP|Jure Repinc]]


== Advanced ==
== Advanced ==
=== kdelibs ===
* '''Location:''' trunk/KDE/kdelibs
* '''Status:''' Needs a lot of work
* '''Info:''' There is a TODO file located in trunk/KDE/kdelibs/doc/ - refer to this for more information.
* '''Document writer:''' ''Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>''


=== System Settings ===
=== KMail ===
* '''Location:''' usually in subdir doc/kcontrol of a module (kdeadmin, kdebase/workspace, kdebase/runtime, kdegraphics, kdepimlibs, kdeutils, exceptions of that rule are dolphin/kxkb/kscd/kdm and some more)
* '''Location:''' [https://commits.kde.org/kmail?path=doc/kmail/ KMail docbook]
* '''Status:''' ·~85% up to date in 4.4
* '''Status:''' Needs a lot of updating and new material. David Bryant ([email protected]) has undertaken the task of updating this manual 15 August 2020. Targeting completion in two or three months.
* '''Info:''' Missing / outdated docs:
* '''Status Update:''' Rewrite task took a while. Six chapters (through "FAQ") complete as of 6 June, 2021. Still to do: Troubleshooting, Licenses and Credits.
** ""Service Discovery"" (kcmshell4 kcm_kdnssd) - missing
* '''Info:''' Check with Allen Winter (winterz) on IRC
** ""Network Settings"" (kcmshell4 kcm_knetworkconfmodule) - outdated
** ""Size & Orientation"" (kcmshell4 randr) - outdated
** ""Multiple Monitors"" (kcmshell4 xinerama) - missing
** ""Input Actions"" (kcmshell4 khotkeys) - missing
** ""Printer Configuration"" (kcmshell4 system-config-printer-kde) - missing
** ""Audio CDs"" (kcmshell4 audiocd) - opens kioslave/audiocd - wrong
** ""Samba"" (kcmshell4 kcmsambaconf) - missing
* '''Document writer:''' ''Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>''


=== KMail ===
* '''Location:''' trunk/KDE/kdepim
* '''Status:''' Needs a lot of updating and new material
* '''Info:''' Check with Allen Winter (winterz) on IRC and [[Projects/Documentation/KDE4/kdepim/kmail]]
* '''Document writer:''' Manfred Mislik (tictric) on IRC


=== KOrganizer ===
=== KOrganizer ===
* '''Location:''' trunk/KDE/kdepim
* '''Location:''' [https://commits.kde.org/korganizer?path=doc/ KOrganizer docbook]
* '''Status:''' Needs a lot of updating and new material
* '''Status:''' Needs a lot of updating and new material
* '''Info:''' Check with Allen Winter (winterz) on IRC
* '''Info:''' Check with Allen Winter (winterz) on IRC
* '''Document writer:''' ''Vikram Dhillon <dhillonv10 AT lavabit DOT com>''

Latest revision as of 10:54, 8 November 2023

Warning
The Techbase wiki is going away as soon as its content is ported elsewhere. The information here may be outdated.


KDE Documentation Tasks

The following task list is broken down by experience as closely as possible. It is recommended that you get in touch with the team and coordinate with the other members so as not to create any problems or duplicate work. Currently the channel is quite slow and quiet.

If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.

If you haven't yet subscribed to the KDE Documentation mailing list, please do so now at the mail manager and say hello. Maybe provide a little bit of information as well as your experience.

Beginner

Documentation Primer

Here is a comprehensive manual about KDE DocBooks creating.

Useful Links on Wikis

Intermediate

Advanced

KMail

  • Location: KMail docbook
  • Status: Needs a lot of updating and new material. David Bryant ([email protected]) has undertaken the task of updating this manual 15 August 2020. Targeting completion in two or three months.
  • Status Update: Rewrite task took a while. Six chapters (through "FAQ") complete as of 6 June, 2021. Still to do: Troubleshooting, Licenses and Credits.
  • Info: Check with Allen Winter (winterz) on IRC


KOrganizer

  • Location: KOrganizer docbook
  • Status: Needs a lot of updating and new material
  • Info: Check with Allen Winter (winterz) on IRC
Retrieved from "https://techbase.kde.org/index.php?title=Projects/Documentation/KDE&oldid=107156"