xoops forums

Mamba

Moderator
Posted on: 2010/7/19 11:11
Mamba
Mamba (Show more)
Moderator
Posts: 10838
Since: 2004/4/23
#1

Updating Developer Documentation - let's make the Blue Move a reality!!!

Resized Image

I've updated the XOOPS Wiki with some new links to different old documents related to XOOPS Module development:

https://xoops.org/modules/mediawiki/in ... /Module_Development_Guide

Unfortunately, most of them are old and outdated, as many of our modules!

Burning did an awesome job with taking inventory of all available modules.

https://xoops.org/modules/news/article.php?storyid=5484

and I am sure that many XOOPS users will be looking at some of the old modules and would like to update them for XOOPS 2.4.5.

That's why we've started the "Blue Move" initiative to update the older modules to take advantage of new XOOPS features.

Unfortunately, there is NO GUIDE on how to make such a transition/refactoring:

* What should be replaced by what and why?

* What are the current Best Practices in XOOPS development and how should they be implemented?


Could we all pitch in and build on the Burning's work and create:

1) Updated "Module Development Guide"

2) "Blue Move" Guidelines - how to refactor old XOOPS modules


Within one day there were close to 1000 readers of the news about https://xoops.org/modules/news/article.php?storyid=5484" rel="noopener external" title="">Burning's Resource Book. If we provide these Blue Move guidelines, we could generate a momentum in the XOOPS Modules area.

Who could help with this?

Also, if you have links to any other useful documentation on Module development, please add them to this Wiki page:

https://xoops.org/modules/mediawiki/in ... /Module_Development_Guide

And finally - if you would like to help with the Blue Move itself, please join this thread
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

Peekay

XOOPS is my life!
Posted on: 2010/7/19 13:14
Peekay
Peekay (Show more)
XOOPS is my life!
Posts: 2335
Since: 2004/11/20
#2

Re: Updating Developer Documentation - let's make the Blue Move a reality!!!

Excellent initiative Mamba.

Like most people, I accept that I need to do some research if I want to build or modify modules for Xoops, but at present there is very little information to find.

Anything that will help people spot code that is insecure, inefficient or deprecated (and their replacement methods) would dramatically increase the chances of The Blue Move succeeding.

If every dev just added a few snippets of their knowledge to the WIKI now, it can become the basis of a more structured developer's guide at a later date.
A thread is for life. Not just for Christmas.

Mamba

Moderator
Posted on: 2010/7/19 15:44
Mamba
Mamba (Show more)
Moderator
Posts: 10838
Since: 2004/4/23
#3

Re: Updating Developer Documentation - let's make the Blue Move a reality!!!

Yes, I am curious who will be 2nd and 3rd person joining the party and creating a Blue Movement

Just watch the video there...
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

redheadedrod

Home away from home
Posted on: 2010/8/7 13:54
redheadedrod
redheadedrod (Show more)
Home away from home
Posts: 1296
Since: 2008/2/26
#4

Re: Updating Developer Documentation - let's make the Blue Move a reality!!!

So has anyone created a personal checklist or anything that they could further document that has "move to blue"?

Thanks!

Hoping to help out but need to see whats in store.

Rodney

Peekay

XOOPS is my life!
Posted on: 2010/8/7 16:54
Peekay
Peekay (Show more)
XOOPS is my life!
Posts: 2335
Since: 2004/11/20
#5

Re: Updating Developer Documentation - let's make the Blue Move a reality!!!

I'm updating an old module now (only way to find out really) and making lots of notes. Made a start with deprecated methods in this thread but, that's only the text sanitiser.

It's just an idea, but if anyone who has a tip to offer could post here and make the the first words of their thread title "Blue Move Tip", then it will be easier to consolidate the info at a later date.

Here is the sort of thing I mean
A thread is for life. Not just for Christmas.