Development talk:DB layer 2.0 migration docs: Difference between revisions
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
The developer reading this article MUST read XMLDB Documentation (at least Introduction + third first Developing section pages) otherwise he's going to ask plenty of questions :) It could be very good that the first line of this article be: "In order to understand this article you need to know how work the database abstraction layer in Moodle (previous to 2.0)". | * The developer reading this article MUST read XMLDB Documentation (at least Introduction + third first Developing section pages) otherwise he's going to ask plenty of questions :) It could be very good that the first line of this article be: "In order to understand this article you need to know how work the database abstraction layer in Moodle (previous to 2.0)". | ||
API link is broken (=> http://php.moodle.org/ "Server not found") | * API link is broken (=> http://php.moodle.org/ "Server not found") | ||
We know that some changes need to be done on 2.0. But on what? | * We know that some changes need to be done on 2.0. But on what? | ||
All these examples concerns the glossary module. It would be good to indicate it first. When I read it first, I didn't really know what was going to be explained in XMLDB changes. In fact all this paragraph is about "Updating your upgrade.php file for Moodle 2.0". Conclusion: we really need a clear first sentence for the all "XMLDB changes" paragraph. So we know what we are going to read. Once I knew what is about, all was very clear. | All these examples concerns the glossary module. It would be good to indicate it first. When I read it first, I didn't really know what was going to be explained in XMLDB changes. In fact all this paragraph is about "Updating your upgrade.php file for Moodle 2.0". Conclusion: we really need a clear first sentence for the all "XMLDB changes" paragraph. So we know what we are going to read. Once I knew what is about, all was very clear. | ||
If we don't make any change on DDL code we shouldn't make it as a section/paragraph. The DDL paragraph should be a note. If you remove this paragrap don't forget to update: "Changes below are grouped into 3 main blocks" => "Changes below are grouped into 2 main blocks" | * If we don't make any change on DDL code we shouldn't make it as a section/paragraph. The DDL paragraph should be a note. If you remove this paragrap don't forget to update: "Changes below are grouped into 3 main blocks" => "Changes below are grouped into 2 main blocks" | ||
DML section: | * DML section: | ||
this is about to change all DML code, in all Moodle file? I think it miss an introduction line as well. | this is about to change all DML code, in all Moodle file? I think it miss an introduction line as well. | ||
Maybe you should use more the word: YOU should do that, YOU do this, YOU ... | * Maybe you should use more the word: YOU should do that, YOU do this, YOU ... | ||
Note: I wrote this comment on first read. | Note: I wrote this comment on first read. |
Revision as of 03:30, 23 May 2008
- The developer reading this article MUST read XMLDB Documentation (at least Introduction + third first Developing section pages) otherwise he's going to ask plenty of questions :) It could be very good that the first line of this article be: "In order to understand this article you need to know how work the database abstraction layer in Moodle (previous to 2.0)".
- API link is broken (=> http://php.moodle.org/ "Server not found")
- We know that some changes need to be done on 2.0. But on what?
All these examples concerns the glossary module. It would be good to indicate it first. When I read it first, I didn't really know what was going to be explained in XMLDB changes. In fact all this paragraph is about "Updating your upgrade.php file for Moodle 2.0". Conclusion: we really need a clear first sentence for the all "XMLDB changes" paragraph. So we know what we are going to read. Once I knew what is about, all was very clear.
- If we don't make any change on DDL code we shouldn't make it as a section/paragraph. The DDL paragraph should be a note. If you remove this paragrap don't forget to update: "Changes below are grouped into 3 main blocks" => "Changes below are grouped into 2 main blocks"
- DML section:
this is about to change all DML code, in all Moodle file? I think it miss an introduction line as well.
- Maybe you should use more the word: YOU should do that, YOU do this, YOU ...
Note: I wrote this comment on first read.
Note 2: I'm new as dev in Moodle, and I've just discover all the power of Moodle XMLDB reading. All the current XMLDB looks awesome, I don't even talk about the coming 2.0 :)
Jerome mouneyrac 22:22, 22 May 2008 (CDT)