Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
contribute:documentation [2020/08/19 20:56] – added bug reporting section, TOC, and section divs kevinbowencontribute:documentation [2024/05/11 09:16] (current) – [Contributing] add matrix channel gael
Line 1: Line 1:
 +~~NOTOC~~
 ====== Documentation ====== ====== Documentation ======
 +
 +
 +  * **[[#Contributing|Contributing]]**
 +  * **[[#Reporting Bugs|Reporting Bugs]]**
 +  * **[[#Editing the Documentation|Editing the Documentation]]**
 +  * **[[#Screenshots|Screenshots]]**
  
 ===== Introduction ===== ===== Introduction =====
  
-Since Xfce 4.10 there are no application manuals in the packages. Reason for this change is that hardly any documentation was contributed over the years mainly because people had problems with the various formats (docbook and mallard) or with the complexity of the VCS((GIT, the Version Control System used by Xfce)).+Since Xfce 4.10, there are no application manuals in the packages. The reason for this change is that hardly any documentation was contributed over the years mainly because people had problems with the various formats (docbook and mallard) or with the complexity of the VCS((GIT, the Version Control System used by Xfce)).
  
-To make the documentation barrier lower it was decided to start a documentation wiki where contributors, developers and translators can work on good and up-to-date documentation.+In order to lower the documentation barrier, it was decided to start a documentation wiki where contributors, developers and translators can work on good and up-to-date documentation.
  
 From the various dialogs and links in the Xfce applications, we redirect to the sections in this wiki. From the various dialogs and links in the Xfce applications, we redirect to the sections in this wiki.
Line 13: Line 20:
 ===== Contributing ===== ===== Contributing =====
  
-If you want to help extending the application manuals or guides on this wiki, you can request an account on the [[https://mail.xfce.org/mailman/listinfo/xfce4-dev|xfce4-dev]] mailing list. Give yourself an introduction and we will setup an account on the wiki so you can start working!+If you want to help extending the application manuals or guides on this wiki, you can request an account on the [[https://mail.xfce.org/mailman/listinfo/xfce4-dev|xfce4-dev]] mailing list or the [[https://matrix.to/#/#xfce-dev:matrix.org|Matrix channel #xfce-dev]]. Give yourself an introduction and we will setup an account on the wiki so you can start working!
  
 For translators the same applies, however then send an email to the [[https://mail.xfce.org/mailman/listinfo/xfce-i18n|xfce-i18n]] mailing list. Make sure you also include the language you want to translate. Note that this only applies for an account on docs.xfce.org, information about code translation can be found [[contribute:translate:|here]]. For translators the same applies, however then send an email to the [[https://mail.xfce.org/mailman/listinfo/xfce-i18n|xfce-i18n]] mailing list. Make sure you also include the language you want to translate. Note that this only applies for an account on docs.xfce.org, information about code translation can be found [[contribute:translate:|here]].
Line 27: Line 34:
 ---- ----
  
-===== Special Syntax =====+===== Editing the Documentation ===== 
 + 
 +If you are unfamiliar with, or simply need a refresher, take a look at the [[doku>DokuWiki]] [[/wiki/syntax|syntax]] page for guidance.
  
-A number of plugins are installed to make the wiki suitable for writing documentation, at the bottom of the [[/wiki/syntax|syntax]] take those plugins are listed.+If you want to try something out before editing a page, just use the [[playground:playground|playground]] page. Just remember to leave the playground as you found it for others to have a blank slate to experiment with their documentation.
  
 +If you wish to have editing access to either the documentation, or the wiki, please reach out to us either through [[irc://irc.libera.chat/#xfce-dev|#xfce-dev on Libera]] or the [[https://mail.xfce.org/mailman/listinfo/xfce4-dev|Xfce-dev mailing list]]. See the [[:contribute:dev/start#communication_with_the_xfce_development_team|Communication with the Xfce Development]] for additional information.
 ---- ----