moodle / moodle/devdocs

[docs] Improve academy metadata

Open
#60 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

For links to the Moodle Academy we need to improve, and find a way to maintain the metadata.

@jgramp has suggested that we should also add:

  • Estimated completion time (e.g. 4 hours, 2 days, 1 week)
  • Level (Beginner to Advanced)

I wonder whether we can have this json generated on the Moodle Academy, with the above fields set as Course custom fields. If Academy can define these as custom fields, and then provide us with a PHP endpoint to generate the JSON content, then we can fetch this periodically (i.e. every sunday or on manual request) and commit it to the repository, and then use it during builds.

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

The issue names no files or tests; start by inspecting how Moodle Academy links and metadata are currently represented in the devdocs repository. Clarify whether Academy can expose the requested custom fields through a PHP endpoint, then define how JSON is fetched and committed for scheduled or manual builds; done means the metadata source and maintenance workflow are agreed and implemented.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.