General developer forum

Assisting with documenting all moodle core table descriptions

 
Picture of Lawrence Ng
Assisting with documenting all moodle core table descriptions
 

As a primary technical backend support for Moodle at our institution, I often ask myself why is there not better documentation for all the core moodle tables made available even at DESC table level with descriptions.

I know that it grows fast but is this something that I can help start to document using the base install tables and making a note of them and what is missing?

How can I help? I’d like to be involved with Moodle.org if possible on a volunteer basis during my spare time.

For example, doing a "DESC table" only shows descriptions for some fields but not all. I would like to see all of them filled up.

Thank you.

Lawrence



 
Average of ratings: -
Tim at Lone Pine Koala Sanctuary
Re: Assisting with documenting all moodle core table descriptions
Core developersDocumentation writersParticularly helpful MoodlersPlugin developers

In your Moodle site, have you been to Site administration -> Development -> XMLDB editor and clicked the [Doc] link?

 
Average of ratings: -
Picture of Lawrence Ng
Re: Assisting with documenting all moodle core table descriptions
 

Hello Tim.

Yes, I saw that but the description fields are missing quite a lot of information even if "obvious" what they are LOL.

How can we help to fill them all out?

Thanks


 
Average of ratings: -
Picture of Marcus Green
Re: Assisting with documenting all moodle core table descriptions
 
Average of ratings: -
Picture of Lawrence Ng
Re: Assisting with documenting all moodle core table descriptions
 

Hello Marcus.

Thank you and yes, I have seen the diagram as well. I was querying more about why the description fields (or all fields) are not all fully documented.

 
Average of ratings: -
Picture of Marcus Green
Re: Assisting with documenting all moodle core table descriptions
Core developersParticularly helpful MoodlersPlugin developersTesters

I suspect it is the same reason code often lacks detailed comments, developers are more focused on developing than on documenting.  I have been working on diagramming the database since 2008 and it is a quite significant task with around 300 tables in a fresh install with no additional plugins. 

I try to  create a new database for each new release (around every six months), and each new version includes more details, mainly PK/FK relationships that show how the tables relate to each other.

 
Average of ratings: -
Tim at Lone Pine Koala Sanctuary
Re: Assisting with documenting all moodle core table descriptions
Core developersDocumentation writersParticularly helpful MoodlersPlugin developers

Since the database documentation is part of the code, any improvements would have to be submitted using the normal Moodle bug-fix procedure. (https://docs.moodle.org/dev/Process)

Any improvements that anyone could make would be greatly appreciated, I am sure.

 
Average of ratings: -