Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to courses on the Moodle Academy #19

Merged
merged 1 commit into from Apr 12, 2022
Merged

Link to courses on the Moodle Academy #19

merged 1 commit into from Apr 12, 2022

Conversation

andrewnicols
Copy link
Member

This is part of a change to introduce standard links to courses on
Moodle Academy.

We create a single canonical list of courses in /academyCourses.js,
a custom Admonition via a JSX component, and a custom page listing all
academy courses relevant to Development.

That component can take properties to describe:

  • the topic being taught
  • a short name for the course
  • possibly further information to include

The list of courses in academyCourses.js has a list of the courses, with
their shortname as an object key, and then relevant metadata, including:

  • The course full name
  • The course link or id
  • A summary to be used in a tooltip
  • A full description to be used in the course list page
  • information as to whether the course has been archived
  • tags
  • icon

The academyCourses page also uses this course information to list all
courses available, with further information and tags.

Fixes #12

@andrewnicols
Copy link
Member Author

Example of the tooltip shown with the summary information for the course:

Screen Shot 2022-04-11 at 10 28 05

This is part of a change to introduce standard links to courses on
Moodle Academy.

We create a single canonical list of courses in `/academyCourses.js`,
a custom Admonition via a JSX component, and a custom page listing all
academy courses relevant to Development.

That component can take properties to describe:

- the topic being taught
- a short name for the course
- possibly further information to include

The list of courses in academyCourses.js has a list of the courses, with
their shortname as an object key, and then relevant metadata, including:

- The course full name
- The course link or id
- A summary to be used in a tooltip
- A full description to be used in the course list page
- information as to whether the course has been archived
- tags
- icon

The academyCourses page also uses this course information to list all
courses available, with further information and tags.

Fixes #12
@andrewnicols andrewnicols changed the title [wip] Link to courses on the Moodle Academy Link to courses on the Moodle Academy Apr 12, 2022
@andrewnicols andrewnicols marked this pull request as ready for review April 12, 2022 08:02
Copy link
Member

@sarjona sarjona left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The patch looks good and the new admonition for AcademyLink is great. Well done, Andrew!

@sarjona sarjona merged commit bf9a2f3 into main Apr 12, 2022
@sarjona sarjona deleted the academyLinks branch April 12, 2022 13:01
@jgramp
Copy link
Contributor

jgramp commented Apr 18, 2022

Two further metadata to include is:
Estimated learning time: 1.5 hours
Level: beginner, intermediate, advanced

github-merge-queue bot pushed a commit that referenced this pull request Nov 13, 2023
MOBILE-4362: Fix linting errors
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] Include links to Moodle Academy
3 participants