Projects/Documentation/KDE: Difference between revisions

From KDE TechBase
(Make sure the information in the page is at least not horribly outdated)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Warning | The Techbase wiki is going away as soon as its content is ported elsewhere. The information here may be outdated.}}
= KDE 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.
The following task list is broken down by experience as closely as possible. It is recommended that you [https://community.kde.org/Get_Involved/documentation get in touch with the team] and coordinate with the other members so
as not to 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 this page] 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 the mail manager] 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.}}


== Beginner ==
== Beginner ==
=== EBN ===
EBN, or the [http://ebn.kde.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://ebn.kde.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://ebn.kde.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 ===
=== Documentation Primer ===


Line 30: Line 26:
* '''Location:''' [https://commits.kde.org/kmail?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. David Bryant ([email protected]) has undertaken the task of updating this manual 15 August 2020. Targeting completion in two or three months.
* '''Status:''' Needs a lot of updating and new material. David Bryant ([email protected]) has undertaken the task of updating this manual 15 August 2020. Targeting completion in two or three months.
* '''Status Update:''' Rewrite task took a while. Six chapters (through "FAQ") complete as of 6 June, 2021. Still to do: Troubleshooting, Licenses and Credits.
* '''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]
 


=== KOrganizer ===
=== KOrganizer ===
Line 37: Line 34:
* '''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]

Latest revision as of 10:54, 8 November 2023

Warning
The Techbase wiki is going away as soon as its content is ported elsewhere. The information here may be outdated.


KDE Documentation Tasks

The following task list is broken down by experience as closely as possible. It is recommended that you get in touch with the team and coordinate with the other members so as not to 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 the mail manager and say hello. Maybe provide a little bit of information as well as your experience.

Beginner

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. David Bryant ([email protected]) has undertaken the task of updating this manual 15 August 2020. Targeting completion in two or three months.
  • Status Update: Rewrite task took a while. Six chapters (through "FAQ") complete as of 6 June, 2021. Still to do: Troubleshooting, Licenses and Credits.
  • Info: Check with Allen Winter (winterz) on IRC


KOrganizer

  • Location: KOrganizer docbook
  • Status: Needs a lot of updating and new material
  • Info: Check with Allen Winter (winterz) on IRC
Retrieved from "https://techbase.kde.org/index.php?title=Projects/Documentation/KDE&oldid=107156"