moodle / moodle/devdocs

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

Open
#1,054 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation help wanted needs-triage
Dominant language
TypeScript
Stars
74
Forks
652
Avg merge
2d 50m
Merged PRs (30d)
12

Description

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 😀

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “Using grunt in additional plugins” section at the linked Moodle developer documentation URL and reproduce the example Gruntfile. Check that the documented setup both compiles plugin SCSS and preserves Moodle tasks such as grunt amd; done means the instructions work without incorrect base directories.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, scss
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.