From Mageia wiki
Jump to: navigation, search
Drakconf multiflag.png
Other languages

English ; Português (Portugal) ; Português do Brasil


This page is intended to help the Documentation Team with writing and translating the help for Draktools and MCC. Starting from Mageia 3, this documentation is accessible directly from each tool in the Mageia Control Center. It is also accessible on-line. The next section lists the work done and to do for the elaboration of this documentation.


Roadmap

The first version of this documentation will be included in the Mageia 3 release and published on Mageia website at the same time. The packages will be freeze before the RC release, thus on April 7th,2013. After this version, the documentation could be updated 'at all moment' on the website. The major updating will be for each new version, if the drakxtools are changing.

TODO

Content

Make help files for all the drakxtools that can be started in MCC. The list #List of MCC help files in Mageia of each tool shows what is done and to do. Most of them are written, but they need technical proofreading. As we have difficulties to obtain such technical skill, language proofreading is already started.

How can you help

Matter of contribution Needed skill Resources Referer
take screenshots in your language Never resized the MCC actual documentation http://docteam.mageia.nl/en/MCC/content/index.html
language proofreading if you are English native speaker actual documentation http://docteam.mageia.nl/en/MCC/content/index.html
translate in your language Good writer in your language
Respect the formatting of the original files
Calenco Akien
first level technical proofreading you don't need to know very well the tool, but you can follow the documentation and compare with what you obtain. Most of the documentation was written with Mageia 2, some things have perhaps changed after that. actual documentation http://docteam.mageia.nl/en/MCC/content/index.html
second level technical proofreading you know well the tool, you can say us what is missing or wrong, what can be more detailed, like some options, what is precisely done by the tool... actual documentation http://docteam.mageia.nl/en/MCC/content/index.html
Make a new manual MCC.xml which contains links to all the above files Good knowledge with Docbook marja
Make a footer with our license (done) Good knowledge with Docbook and XSL stylesheets marja

Rules to follow

List of needed help texts

Listed are the commands used to start the tools, the list is not complete. Please respect the alphabetical order if you add another one.

Please don't start on the translation, before the file has at least been technically verified and approved, unless you don't mind doing extra work

Default MCC tools

Command Status Screenshot times successfully used Proofread
(English)
Existing documentation Title in MCC Link
diskdrake (same as drakdisk)
drakdisk will be used as filename)
WRITTEN yes 0 no
diskdrake --dav WRITTEN papoteur yes 0 no Access WebDAV shared drives and directories [1]
diskdrake --fileshare WRITTEN Lebarhon: It's seems it doesn't work. Same behavior whatever the settings are. How to share with Dolphin ?(no share in the menus) yes 0 Yes (Simonnzg). Unsure if the process is correct. Needs technical check. Share your hard disk partitions [2]
diskdrake --nfs
Not yet working
WRITTEN Papoteur yes 0 no Access NFS shared drives and directories [3]
diskdrake --removable WIP by lebarhon. A problem is under investigation. Bug 11558 yes 0 no CD/DVD burner [4]
diskdrake --smb WRITTEN papoteur
Problems with usage
yes 0 no Access Windows(SMB) shared drives and directories [5]
drak3d WRITTEN yes 1 1 small change by Isolde Configure 3D Desktop effects [6]
drakauth WRITTEN papoteur yes 1 Small changes by Isolde Authentication [7]
drakboot WRITTEN Lebarhon yes 1 tp,johnr Set up autologin to automatically log in [8]
drakboot --boot Written but complements needed Lebarhon yes 0 no Set up boot system [9]
drakbug no no 0 no
drakclock WRITTEN Lebarhon yes 1 Small changes by Isolde Manage date and time [10]
drakconf (= mcc) no no 0 no
drakconnect WRITTEN Papoteur yes 0 no Set up a new interface (LAN, ISDN, ADSL,...) [11]
drakconnect --del WRITTEN yes 0 no Remove a connection [12]
drakconsole WRITTEN papoteur yes 1 1 minor change by Isolde Open a console as administrator [13]
drakdisk (same as diskdrake)
drakdisk will be used as filename
WRITTEN yes 1 small changes by Isolde Manage disk partitions [14]
drakedm WRITTEN yes 1 one small change by Isolde Set up display manager [15]
drakfirewall WRITTEN Lebarhon yes 1 Small changes by Isolde Set up your personal firewall [16]
drakfont WRITTEN Marja+Lebarhon yes 1 tp,johnr Manage, add and remove fonts. Import Windows (TM) fonts [17]
drakguard WRITTEN, See Non default tools below yes 0 no Parental Controls [18]
drakgw Done by papoteur and marja yes 1 Small changes by Isolde Share the Internet connection with other local machines [19]
drakhosts WRITTEN papoteur yes. screnshot can includes the second window 1 tp,johnr Hosts definition [20]
drakids no no 0 no Interactive firewall
drakinvictus WIP yes 0 no Advanced setup for network interfaces and firewall [21]
drakkeyboard (see keyboarddrake) -- -- -- --
drakmouse (see mousedrake) -- -- -- --
draknetcenter WRITTEN Marja+Lebarhon Complements needed yes 0 tp,johnr Network Center [22]
draknetprofile WIP yes 0 no Manage different network profiles [23]
draknfs ERROR in cauldron
says installed nfs.utils is missing
Done by papoteur and marja ERROR 0 no Share drives and directories using NFS [24]
drakperm no no 0 no Can't find this screen in MCC
drakproxy WRITTEN papoteur yes 1 tp, johnr Proxy [25]
drakroam no no 0 no Page in the wiki Not directly accessible from MCC
drakrpm-edit-media (links to edit-urpmi-sources.pl) WRITTEN Marja+Lebarhon yes 1 tp, johnr Configure media sources for install and update [26]
drakrpm-update (only a link to MageiaUpdate, please write MageiaUpdate) -- -- -- -- Update your system
draksambashare WRITTEN papoteur yes 1 A few small changes by Isolde Share drives and directories with Windows (SMB) systems [27]
draksec Written Lebarhon yes 0 no Configure authentication for Mageia tools [28]
draksnapshot-config DONE yes for crash
can't upload new one
0 no not in Mga 2 Snapshots [29]
draksound WRITTEN Marja+Lebarhon yes 1 A few changes by Isolde Sound configuration [30]
drakups WIP by Papoteur yes 0 no Set up a UPS for power monitoring [31]
drakvpn Written Papoteur yes 0 no Configure vpn connection to scure network access [32]
drakxservices (already well adjusted to systemd?) WIP - JohnR yes 0 no Manage system services by enabling or disabling them [33]
harddrake2 WRITTEN Erik (Disa) + Papoteur yes 1 A few changes by Isolde Browse and configure hardware [34]
keyboarddrake WRITTEN yes 1 Read by Isolde Set up the keyboard layout [35]
localedrake WRITTEN papoteur yes 1 1 minor correction by Isolde Manage localization for your system [36]
logdrake also known as draklog WRITTEN Lebarhon yes 1 no View and search system logs [37]
MageiaUpdate (aka drakrpm-update) WRITTEN Marja+Lebarhon yes 1 Small changes by Isolde Update your system [38]
mcc (=drakconf) no no 0 no
mgaapplet-add-media-helper LATER (not in MCC) no 0 no command doesn't start a GUI
mgaapplet-config WRITTEN Marja+Lebarhon yes 1 Small changes by Isolde Configure updates frequency [39]
mousedrake WRITTEN with comments Marja+Lebarhon yes 1 no Set up the pointer device (mouse, touchpad) [40]
msecgui WRITTEN Lebarhon yes 0 no Configure system security, permissions and audit [41]
rpmdrake WRITTEN Marja+Lebarhon yes 1 A few changes by Isolde Page in the Wiki [42]
scannerdrake WRITTEN, marja, papoteur yes 0 A few changes by Isolde Set up scanner [43]
system-config-printer yes yes yes yes Printer page in the French wiki [44]
transfugdrake WRITTEN Yurchor yes 0 no Import Windows(TM) Settings and Documents [45]
userdrake WRITTEN Marja+lebarhon yes 1 Minor changes by Isolde Managing Users on system [46]
XFdrake WRITTEN Marja+Lebarhon yes 1 Small changes by Isolde Page in the wiki Set up the graphical server [47]

Non default MCC tools

Command Status Screenshot times successfully used Proofread
(English)
Existing documentation Title in MCC Link
drakbug DONE can't upload .png 0 no no entry [48]
drakbug_report DONE No 0 no no entry [49]
drakconf.real Seems not to be independant command No 0 no
drakdvb To be written No 0 no
drakguard Written Lebarhon. To be checked Yes 0 no Parental controls [50]
drakhelp To be written No 0 no
draklive To be written No 0 no
drakpxeconfig To be written No 0 no
drakroam To be written No 0 no
draksnapshot-applet To be written No 0 no
draksnapshot-config DONE can't upload new one 0 no Snapshots [51]
draksnapshot-restore To be written No 0 no
drakupdate_fstab To be written No 0 no
drakwizard To be written, provides wizards for dhcp, dns, apache, time, ssh No 0 no
drakwizard apache2 Done 1st 0 no Configure web server [52]
drakwizard bind To be written, provides wizard dns 1st 0 no Configure DNS [53]
drakwizard dhcp Done, could be completed with "what is modified" 1st 0 no Configure DHCP [54]
drakwizard ntp Written, Lebarhon, provides wizards for time Done 0 no Configure time [55]
drakwizard proftpd Done 1st 0 no Configure FTP [56]
drakwizard squid Done, provides wizard proxy 1st 0 no Configure proxy [57]
drakwizard sshd Done, provides wizard ssh, can be completed with "what is done" 1st 0 no OpenSSH daemon configuration [58]
drakxtools-http To be written No 0 no
drakxtv To be written No 0 no
lsnetdrake almost empty page No 0 no no entry [59]
lspcidrake Written, Lebarhon Done 0 no no entry [60]
packdrake To be written No 0 no


Resources

For Calenco only

You may want to have a look at the: Calenco user's guide
There are also DocBook 5: The Definitive Guide (useful for writing Calenco documents) and
DocBook XSL: The Complete Guide (useful for making Calenco publications).

Writing and/or Translating documentation

See How to write and translate Mageia documentation!

Packaging MCC or Installer help

First, the related Calenco publications must be made: one for every language to be packaged. Look here for instructions how to do that. The output must be committed to svn.mageia.org/soft/. For MCC help, the location will follow.

Notepad.png
Please note!
The html files that are generated from Calenco, must now be committed to git


How to package MCC help
How to package mageia-doc to be completed