Difference between revisions of "Projects/Documentation/KDE"

Jump to: navigation, search
(fix links)
(KOrganizer: fix link to korganizer docbooks)
 
(4 intermediate revisions by 2 users not shown)
Line 16: Line 16:
 
=== Documentation Primer ===
 
=== Documentation Primer ===
  
Here is a [[Documentation_Primer/Manual|comprehensive manual]] about KDE DocBooks creating.
+
Here is a [http://l10n.kde.org/docs/doc-primer comprehensive manual] about KDE DocBooks creating.
  
 
=== Useful Links on Wikis ===
 
=== Useful Links on Wikis ===
  
* [[Projects/Documentation/KDE4_(health_table)|Health Table]]. Please do not hesitate to improve it.
+
* [[Projects/Documentation/KDE_(health_table)|Health Table]]. Please do not hesitate to improve it.
 
* [https://community.kde.org/Schedules Current release schedule and feature plan]
 
* [https://community.kde.org/Schedules Current release schedule and feature plan]
  
Line 28: Line 28:
  
 
=== KMail ===
 
=== KMail ===
* '''Location:''' [https://commits.kde.org/kdepim?path=doc/kmail/ KMail docbook]
+
* '''Location:''' [https://commits.kde.org/kmail?path=doc/kmail/ KMail 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
Line 34: Line 34:
  
 
=== KOrganizer ===
 
=== KOrganizer ===
* '''Location:''' [https://commits.kde.org/kdepim?path=doc/korganizer/ KOrganizer docbook]
+
* '''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:''' kde-doc-english mailing list, [irc://chat.freenode.net/kde-docs #kde-docs]
 
* '''Document writer:''' kde-doc-english mailing list, [irc://chat.freenode.net/kde-docs #kde-docs]

Latest revision as of 10:18, 6 October 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-box-icon.png
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

  • 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

This page was last edited on 6 October 2016, at 10:18. Content is available under Creative Commons License SA 4.0 unless otherwise noted.