General help

The right place for posting documentation?

 
Picture of Mohammad Al-Sammarrai
The right place for posting documentation?
 

Hi,

If I want to post and talk about my own custom bash or PHP scripts that help and facilitate specific aspects of Moodle functionality, like automating backups, upgrade ...etc. where do you think is the right place to do so within the Moodle forums?

Also if I have best practices or innovative use of some activities, is there a place for such "user documentation or best practises"?

Thanks

 
Average of ratings: -
Picture of Howard Miller
Re: The right place for posting documentation?
Core developersDocumentation writersParticularly helpful MoodlersPlugin developers

It's difficult to give a definite answer... However, some random thoughts...

* Scripts should probably go in Github and you can link to that from a forum post (or somewhere else)

* Both the developer and general documentation sites are Wikis and anybody can edit them. Please respect core Moodle information but there are plenty of opportunities for linking to 'See also' style information where you can create your own page. 

* Look through the forums and find the most appropriate ones to simply start discussing things.

 
Average of ratings: Useful (1)
Picture of Mohammad Al-Sammarrai
Re: The right place for posting documentation?
 
Thank you Howard, appreciate your input.



On Feb 12, 2018 4:02 PM, "Howard Miller (via Moodle.org)" <
 
Average of ratings: -
myname
Re: The right place for posting documentation?
 

there is developer forum "For general developer news or issues that don't fit into any of the other forums!"


 
Average of ratings: -
Picture of Mohammad Al-Sammarrai
Re: The right place for posting documentation?
 

Thank you


(Edited by Helen Foster to remove the signature, as they are not allowed in the forums according to the site policy - original submission Tuesday, 13 February 2018, 7:30 AM)

 
Average of ratings: -
Picture of Mohammad Al-Sammarrai
Re: The right place for posting documentation?
 

Hi Howard,

I guess you mean by developer / general documentation wiki sites is: https://en.wikipedia.org/wiki/Moodle

Because the official documentation subsites require official registered users

 
Average of ratings: -
Picture of Helen Foster
Re: The right place for posting documentation?
Core developersDocumentation writersMoodle HQParticularly helpful MoodlersPlugin developersTestersTranslators

Hello,

The developer and general documentation sites that Howard mentioned are the Dev docs and Moodle Docs respectively.

You're welcome to contribute to either by logging in with your moodle.org username and password. If you don't have a username and password because you created a moodle.org account by logging in using your account on Google, Microsoft or Facebook, please email support@moodle.org then we can provide you with a username and password. (Both sites use MediaWiki and don't yet have OAuth 2 authentication.)

Thanks in advance for your contributions!

 
Average of ratings: Useful (1)
Picture of Mohammad Al-Sammarrai
Re: The right place for posting documentation?
 

Thank you, Helen, I'm thankful for your support.

 
Average of ratings: -
Picture of Visvanath Ratnaweera
Re: The right place for posting documentation?
Particularly helpful Moodlers
Another alternative, if your work supplementary to Moodle, not directly in the "tree" of Moodle documentation is to maintain a tech-blog on your topics. You can add links to them in the Moodle documentation, provide the link in related discussions in the community forum, etc.
 
Average of ratings: -
Picture of Mohammad Al-Sammarrai
Re: The right place for posting documentation?
 
Absolutely planning to do so. Appreciate your input.



Thanks
 
Average of ratings: -