Difference between revisions of "Projects/Documentation/KDE4"

Jump to: navigation, search
(New page: = KDE 4 Documentation = == Background and Requirements == With the amount of work required in order to get KDE 4 documentation where it needs to be, there are tasks available for all sorts...)
 
(Kalzium)
(53 intermediate revisions by 13 users not shown)
Line 1: Line 1:
= KDE 4 Documentation =
+
= KDE 4 Documentation Tasks =
== Background and Requirements ==
+
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.
With the amount of work required in order to get KDE 4 documentation where it needs to be, there are tasks available for all sorts of skill sets. Whether you are the seasoned technical writer familiar with DocBook and XML or you are someone who just started using KDE and/or Linux, there is a task waiting for you. There are requirements in order to contribute to the base documentation. These requirements are the ability to read and write clearly in English. That's it!
+
  
== Task List ==
+
If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.
The available tasks start from typical spelling and grammar checking, all the way up to creating and maintaining documentation for new applications. This document will try to provide available tasks oriented towards the various levels of experience and this document will continue to expand in order to cover every possible task to reach our goal.
+
  
=== Beginner ===
+
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.
The Beginner level will encompass the very basic tasks required in order to assist the KDE Documentation Project. These tasks will normally include spelling and grammar checking/fixing, readability, and if possible technical correctness. Spelling and Grammar checking/fixing is rather straight forward. Readability will require you to read through a document and report back if there are portions that are unclear or confusing. Technical correctness requires a little knowledge with KDE 4 and/or the application documentation you are reviewing. If you are unfamiliar with the technology being covered in the documentation, then it may be easier for you to adopt a task or document in which are more familiar with.
+
  
To see a list of Beginner level tasks, please review <INSERT PAGE NAME & LINK>
+
'''NOTE:''' Please use the [[#EBN|English Breakfast Network]] while working on documentation.
  
=== Intermediate ===
+
== Beginner ==
The Intermediate level will encompass tasks that are a bit more involved than the Beginner level tasks. Of course you will still utilize the requirements and jobs listed above in the Beginner level tasks. The Intermediate level tasks will require you to be a little more familiar with SVN (anonymous unless you have an account) as well as DocBook and XML. A great tool for the Intermediate level to utilize, as well as the Beginner level, is the [http://www.englishbreakfastnetwork.org/ English Breakfast Network] or EBN[1] for short.
+
=== 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 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.
  
To see a list of Intermediate level tasks, please review <INSERT PAGE NAME & LINK>
+
=== KColorEdit ===
 +
* '''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.''
  
=== Advanced ===
+
== Intermediate ==
The Advanced level will encompass tasks such as creating a document from scratch utilizing the DocBook/XML DTD and have full understanding of the KDE Style Guide as well as the community itself. Contributors that fall under the advanced level will also help those contributing at both the Beginner and Intermediate levels. A contributor in this level should be able to answer a majority of the questions asked by the previous 2 levels or should be able to locate an answer easily within the community.
+
  
To see a list of Advanced level tasks, please review <INSERT PAGE NAME & LINK>
+
=== 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 ==
 +
=== 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 ===
 +
* '''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 ===
 +
* '''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 ===
 +
* '''Location:''' trunk/KDE/kdepim
 +
* '''Status:''' Needs a lot of updating and new material
 +
* '''Info:''' Check with Allen Winter (winterz) on IRC
 +
* '''Document writer:''' ''Vikram Dhillon <dhillonv10 AT lavabit DOT com>''

Revision as of 22:13, 25 July 2012

Contents

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 https://mail.kde.org/mailman/listinfo/kde-doc-english 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.

KColorEdit

  • 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.

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:

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

  • 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

  • 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

  • Location: trunk/KDE/kdepim
  • Status: Needs a lot of updating and new material
  • Info: Check with Allen Winter (winterz) on IRC
  • Document writer: Vikram Dhillon <dhillonv10 AT lavabit DOT com>

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal