Projects/Documentation/KDE: Difference between revisions

From KDE TechBase
mNo edit summary
Line 1: Line 1:
= KDE 4 Documentation Tasks =
= KDE 4 Documentation Tasks =
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.
The following task list is broken down by experience as closely as possible. It is recommended that you join [irc://chat.freenode.net/kde-docs #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.


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 this page] 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.
{{Note|Please use the [[#EBN|English Breakfast Network]] while working on documentation.}}


== Beginner ==
== Beginner ==
Line 14: Line 14:
# [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.
# [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.


=== Documentation Primer ===
Here is a [[Documentation_Primer/Manual|comprehensive manual]] about KDE DocBooks creating.
=== Useful Links on Wikis ===
* [[Projects/Documentation/KDE4_(health_table)|Health Table]]. Please do not hesitate to improve it.
<!--
=== KColorEdit ===
=== KColorEdit ===
* '''Location:''' trunk/extragear/graphics
* '''Location:''' trunk/extragear/graphics
Line 19: Line 28:
* '''Info:''' Should be a fairly straight forward process with the updating and new material addition.
* '''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.''
* '''Document writer:''' ''TimS on IRC, or via the mailing list.''
-->


== Intermediate ==
== Intermediate ==
=== 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 ===
=== kdelibs ===
* '''Location:''' trunk/KDE/kdelibs
* '''Location:''' trunk/KDE/kdelibs
Line 35: Line 39:
* '''Info:''' There is a TODO file located in trunk/KDE/kdelibs/doc/ - refer to this for more information.
* '''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>''
* '''Document writer:''' ''Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>''
 
-->
=== System Settings ===
* '''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). Drafts for missing/outdated kcm docs you find in branches/work/doc/ subdirs.
* '''Status:''' 100 % up to date in 4.5
* '''Info:''' Missing docs:
** Service Discovery (kcmshell4 kcm_kdnssd) - missing, draft in kdnssd
** Network Setting (kcmshell4 kcm_knetworkconfmodule) - outdated
** Size & Orientation (kcmshell4 randr) - outdated, draft in kcmdisplay
** Input Actions (kcmshell4 khotkeys) - missing
** Printer Configuration (kcmshell4 system-config-printer-kde) - missing
** Audio CDs (kcmshell4 audiocd) - opens kioslave/audiocd - wrong, draft in audiocd
** Samba (kcmshell4 kcmsambaconf) - missing
* '''Document writer:''' ''Richard Johnson (nixternal) <nixternal AT kubuntu DOT org>''


=== KMail ===
=== KMail ===
Line 53: Line 45:
* '''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 and [[Projects/Documentation/KDE4/kdepim/kmail]]
* '''Info:''' Check with Allen Winter (winterz) on IRC and [[Projects/Documentation/KDE4/kdepim/kmail]]
* '''Document writer:''' Manfred Mislik (tictric) on IRC
* '''Document writer:''' kde-doc-english mailing list, [irc://chat.freenode.net/kde-docs #kde-docs]


=== KOrganizer ===
=== KOrganizer ===
Line 59: Line 51:
* '''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>''
* '''Document writer:''' kde-doc-english mailing list, [irc://chat.freenode.net/kde-docs #kde-docs]

Revision as of 18:04, 12 June 2013

KDE 4 Documentation Tasks

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.

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 this page and say hello. Maybe provide a little bit of information as well as your experience.

Note
Please use the English Breakfast Network while working on documentation.


Beginner

EBN

EBN, or the 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 are 2 utilities which will make your work easier:

  1. 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.
  2. 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.

Documentation Primer

Here is a comprehensive manual about KDE DocBooks creating.

Useful Links on Wikis


Intermediate

Advanced

KMail

KOrganizer

  • Location: trunk/KDE/kdepim
  • Status: Needs a lot of updating and new material
  • Info: Check with Allen Winter (winterz) on IRC
  • Document writer: kde-doc-english mailing list, #kde-docs
Retrieved from "https://techbase.kde.org/index.php?title=Projects/Documentation/KDE&oldid=79729"