Toggle the table of contents

Projects/Documentation/KDE: Difference between revisions

From KDE TechBase

Revision as of 09:52, 15 June 2016

KDE 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:

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

Health Table. Please do not hesitate to improve it.
Current release schedule and feature plan

Intermediate

Advanced

KMail

Location: KMail docbook
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

KOrganizer

Location: KOrganizer docbook
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=97367"

@@ Line 1: / Line 1: @@
-= KDE 4 Documentation Tasks =
+= KDE Documentation Tasks =
 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.
@@ Line 21: / Line 21: @@
 * [[Projects/Documentation/KDE4_(health_table)|Health Table]]. Please do not hesitate to improve it.
-* [[Schedules/KDE4/4.12_Release_Schedule|Current release schedule]]
+* [https://community.kde.org/Schedules Current release schedule and feature plan]
-* [[Schedules/KDE4/4.12_Feature_Plan|Feature plan of the current release]]
 == Intermediate ==
@@ Line 29: / Line 28: @@
 === KMail ===
-* '''Location:''' [http://quickgit.kde.org/?p=kdepim.git&a=tree&f=doc%2Fkmail KDE/kdepim]
+* '''Location:''' [https://commits.kde.org/kdepim?path=doc/kmail/ KMail docbook]
 * '''Status:''' Needs a lot of updating and new material
 * '''Info:''' Check with Allen Winter (winterz) on IRC
@@ Line 35: / Line 34: @@
 === KOrganizer ===
-* '''Location:''' [http://quickgit.kde.org/?p=kdepim.git&a=tree&f=doc%2Fkorganizer KDE/kdepim]
+* '''Location:''' [https://commits.kde.org/kdepim?path=doc/korganizer/ KOrganizer docbook]
 * '''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]