moodle / devdocs

Source of the Moodle Developer Resources and Documentation
https://moodledev.io/
Other
40 stars 291 forks source link

[docs] Error in documentation of using grunt in additional plugins #1054

Open PhMemmel opened 3 months ago

PhMemmel commented 3 months ago

What is the URL of the page?

https://moodledev.io/general/development/tools/nodejs#using-grunt-in-additional-plugins

What is the issue with this page?

I tried to follow the docs to make grunt compile scss into CSS in a plugin according to the mentioned page.

Unfortunately, the grunt default task is being overwritten by the example Gruntfile in the docs, so you are not able to for example run grunt amd anymore. When I am trying to not overwrite the default and try to use the mergeConfig package, grunt has issues to run the Moodle basic tasks because of wrong base directories I believe. So I am stuck here.

To put it short: What is described in the docs section does not work and I could not figure out, how to fix. That's why I am opening an issue and not providing a pull request. Maybe anyone with more knowledge/experience with the moodle grunt could fix this doc issue or identify issues the grunt code currently has and provide a fix. Thanks in advance!

Are you able to provide a patch for this?

Unfortunately no due to lack of experience, knowledge and - as always - resources to dig deeper 😀