Moodle documentation: Wiki etiquette

Moodle documentation: Wiki etiquette

by Peter DeBruyn -
Number of replies: 5

I was just reading the language page (http://docs.moodle.org/en/Language) and I thought it was odd that this page refers to the Moodle data directory/folder as "datafolder"  when I have only seen it refered to as "moodledata" elsewhere in forums, documentation and installation.  My next thought was to edit the wiki page and swap the two.  Then I wondered whether someone had good reason to refer to it as datafolder.  I don't pretend to be a Moodle expert or have much experience with wikis, but I would like to help with the MoodleDocs wiki.

My question is what would the proper MoodleDocs wiki etiquette be?  I think some of my choices are:  1) Just make the changes; 2) Don't make the changes and create a comment about the issue on the Talk page; 3) Quit being so nitt picky and leave it alone; 4) post the issue in this forum and... wide eyes

Average of ratings: Useful (1)
In reply to Peter DeBruyn

Re: Wiki etiquette - datafolder offtopic and try to make etiquette ansver

by Ne Nashev -
Hmm... I know two root moodle-folders: folder "moodle" and folder "moodledata" that is real folder name in hard drive when moodle installed. In version 1.5 (i don't know what in 1.6) "lang" folder is in the "moodle" folder, not "moodledata". Are You sure, that word "datafolder" used in this doc is similar to "moodledata" folder?



You need to think about You certainty in You changes. If You certain of it - make it. If not - suggest it in talk-page or in a forum (not use only this document's forum, i think more useful be to ask in special forum similar to wiki-page topic). When you ask in talk-page it will be addressed to next possible this wiki-page editor, and when you ask in forum - it will be addressed to all specialists in this forum, and when you obtain the ansver you will be have certainty and make you changes byself.

Princips is that wiki-page must contain mostly certain information as possible.
Average of ratings: Useful (1)
In reply to Peter DeBruyn

Re: Moodle documentation: Wiki etiquette

by koen roggemans -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Translators
It's a typo Peter - my mistake I believe verlegen

If you find an error in the wiki, just change it. The page is on a lot of people's watch list, so if you would make a mistake, it's easely reverted, no problem.

Thanks for reporting - it's fixed.
Average of ratings: -
In reply to koen roggemans

Re: Moodle documentation: Wiki etiquette

by Art Lader -
If you find an error in the wiki, just change it. The page is on a lot of people's watch list, so if you would make a mistake, it's easely reverted, no problem.

perfect answer

-- Art
Average of ratings: -
In reply to Art Lader

Re: Moodle documentation: Wiki etiquette

by Jose' Coelho -

That work ok for small mistakes, but if you think that the page needs a reformulation, for instance to incorporate the problems and solutions discussed in the forum of the module?

It is suppose to make the reformulation, for anyone that is watching reverse the reformulation? This is not very motivating for improving the documentation, and could explain why the documentation is so small, and the support foruns are so large.

I want to improve the documentation of a module, but I need to understand how this works.

Another point is the documentation of the languages, not english. There must exists only a translation, if I want to contribute to the documentation must make it first in the english version. That is correct?

The user knows if a page in portuguese is older or newer than the corresponding english page? (without visiting the two pages, of course)

Average of ratings: Useful (1)
In reply to Jose' Coelho

Re: Documentation wiki etiquette

by Helen Foster -
Picture of Core developers Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers Picture of Translators
Hi Jose'

If you think a page in Moodle Docs needs reformulating/rewriting, you can either edit the page directly, or add your suggested changes to the corresponding talk page (via the "page comments" tab). Anyone watching the page will receive email notification of page changes. It's unusual for it to be necessary to roll back/revert a page to a previous version.

Regarding documentation in other languages, whilst an English version will always be appreciated, it's not actually required. It's impossible to maintain Moodle Docs in other languages as exact translations of the English Moodle Docs, however the use of inter-language linking enables quick access between corresponding pages in different languages.

For further information, please see the guidelines for contributors and the documentation philosophy.
Average of ratings: -