[docs] workshop #746
[docs] workshop #746
Conversation
✅ Deploy Preview for moodledevdocs ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
There was a problem hiding this comment.
Hi @crnfpp,
I'm not sure if you're finished with this change, but in any case I have some feedback here.
It will be great to get all of the workshop docs moved over. Are you planning to do so in this PR, or just getting the first few pages in place in this PR?
| tags: [] | ||
| --- | ||
| :::info | ||
| Work in progress | ||
| ::: |
There was a problem hiding this comment.
Rather than using an admonition:
| tags: [] | |
| --- | |
| :::info | |
| Work in progress | |
| ::: | |
| tags: [] | |
| documentationDraft: true | |
| --- |
|
|
||
| <Since versions={["2.0"]} /> |
There was a problem hiding this comment.
| <Since versions={["2.0"]} /> |
There's no point really including any really old since tags. No-one should be using 1.9- and no-one should be developing for it.
We're trying to update our dev docs to be version specific to avoid having to spend a lot of time understanding which items only relate to an ancient version of Moodle.
| ## Overview of Workshop architecture | ||
|
|
||
| Rewriting Workshop from scratch for Moodle 2.0 was a great opportunity to use new APIs and approaches to activity module development. In some areas, Workshop was a pioneering component adopting new frameworks - like `File API`, HTML rendering or subplugins support. |
There was a problem hiding this comment.
Thsi is just fluff. We don't need to know about 2.0, and the changes from 1.9, etc.
We don't need the Overview title. We just need to know that this page describes the implementation, and that it uses subplugins.
| ## Overview of Workshop architecture | |
| Rewriting Workshop from scratch for Moodle 2.0 was a great opportunity to use new APIs and approaches to activity module development. In some areas, Workshop was a pioneering component adopting new frameworks - like `File API`, HTML rendering or subplugins support. | |
| ## Architecture |
| ### Database structure | ||
|
|
||
| [400px](https://docs.moodle.org/Image/workshop_erd.png) | ||
| <br clear="all"/> |
There was a problem hiding this comment.
Should be unnecessary
| <br clear="all"/> |
| [400px](https://docs.moodle.org/Image/workshop_xml.png) | ||
| <br clear="all"/> | ||
|
|
||
| ### Classes |
|
|
||
| ## Debugging and testing | ||
|
|
||
| - [Workshop/fakesubmissions.php](https://docs.moodle.org/dev/Workshop/fakesubmissions.php) |
There was a problem hiding this comment.
This throws a spelling warning. We can fix that by either:
Putting it in backticks:
| - [Workshop/fakesubmissions.php](https://docs.moodle.org/dev/Workshop/fakesubmissions.php) | |
| - [`workshop/fakesubmissions.php`](https://docs.moodle.org/dev/Workshop/fakesubmissions.php) |
OR
Adding to a cspell ignore list:
| - [Workshop/fakesubmissions.php](https://docs.moodle.org/dev/Workshop/fakesubmissions.php) | |
| - [Workshop/fakesubmissions.php](https://docs.moodle.org/dev/Workshop/fakesubmissions.php) | |
| <!-- cspell:ignore fakesubmissions --> |
|
Hi @crnfpp! |
|
Hi!! |
No description provided.