Projects/Documentation/KDE: Difference between revisions

From KDE TechBase
(Adding apps needing doco work)
mNo edit summary
(54 intermediate revisions by 10 users not shown)
Line 1: Line 1:
= KDE 4 Documentation Tasks =
= KDE 4 Documentation Tasks =
{| class="wikitable" border="1"
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.
|+ Task list (breakdown into task levels when ready)
 
|-
If you choose to work on any of the following documents, please add your name, IRC name, and email address for communication purposes.
! Application
 
! Status
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.
! Info
 
|-
{{Note|Please use the [[#EBN|English Breakfast Network]] while working on documentation.}}
| KGet
| Update
| KDE 3 -> KDE 4
|-
| Dolphin
| Update
| No update since 2006
|-
| Kalzium
| Update and add new
| Has old parts and non-documented parts
|}


== Beginner ==
== Beginner ==
To be determined.
=== 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.
 
=== 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.
* [[Schedules/KDE4/4.11_Release_Schedule|Current release schedule]]
* [[Schedules/KDE4/4.11_Feature_Plan|Feature plan of the current release]]
 
=== KColorEdit ===
* '''Location:''' [http://websvn.kde.org/trunk/extragear/graphics/doc/kcoloredit/ 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:''' kde-doc-english mailing list, [irc://chat.freenode.net/kde-docs #kde-docs]


== Intermediate ==
== Intermediate ==
To be determined.


== Advanced ==
== Advanced ==
To be determined.
<!--
=== 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>''
-->
 
=== KMail ===
* '''Location:''' [http://quickgit.kde.org/?p=kdepim.git&a=tree&f=doc%2Fkmail 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:''' kde-doc-english mailing list, [irc://chat.freenode.net/kde-docs #kde-docs]
 
=== KOrganizer ===
* '''Location:''' [http://quickgit.kde.org/?p=kdepim.git&a=tree&f=doc%2Fkorganizer 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, [irc://chat.freenode.net/kde-docs #kde-docs]

Revision as of 19:16, 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

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: kde-doc-english mailing list, #kde-docs

Intermediate

Advanced

KMail

KOrganizer

  • Location: 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=79733"