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.

Sign up for GitHub

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

Jump to bottom

[docs] Include links to Moodle Academy #12

Closed
2 tasks
andrewnicols opened this issue Apr 9, 2022 · 5 comments · Fixed by #19
Closed
2 tasks

[docs] Include links to Moodle Academy #12

andrewnicols opened this issue Apr 9, 2022 · 5 comments · Fixed by #19
Labels
help wanted Extra attention is needed migration Migration of a document from the legacy site question Further information is requested
Projects
Migration from Wikimedia
Milestone
Migration day

Comments

@andrewnicols
Copy link
Member

andrewnicols commented Apr 9, 2022 •
edited

We should work with Jess Gramp (@jgramp) and Rajneel to work out how best to link from the Developer resources to the development courses in the Moodle Academy.

From a User Experience perspective it would be good to have:

  • A navbar element
  • A landing page explaining that courses are available and linking to a landing page on the Academy
@andrewnicols andrewnicols added this to the Migration day milestone Apr 9, 2022
@andrewnicols andrewnicols added help wanted Extra attention is needed question Further information is requested migration Migration of a document from the legacy site labels Apr 9, 2022
andrewnicols added a commit that referenced this issue Apr 11, 2022
@andrewnicols
[wip] Link to courses on the Moodle Academy
4c8e7b8 
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

andrewnicols commented Apr 11, 2022 •
edited

One suggestion from @jgramp is to signpost relevant courses in a consistent way in docs pages, perhaps with relevant iconography.

I'd suggest that we could use a new JSX component with a JSON-defined list of courses so that we can centrally update any course and/or course description.

Having a central list also allows us to create a central course list based on that file.

That could look something like this:
example-academy-link-dark
example-academy-link

@andrewnicols andrewnicols mentioned this issue Apr 11, 2022
Merged
@andrewnicols andrewnicols changed the title Include links to Moodle Academy [docs] Include links to Moodle Academy Apr 11, 2022
andrewnicols added a commit that referenced this issue Apr 12, 2022
@andrewnicols
Link to courses on the Moodle Academy
acaed7f 
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
Migration from Wikimedia automation moved this from To do to Done Apr 12, 2022
@jgramp
Copy link
Contributor

jgramp commented Apr 12, 2022

Looks great Andrew.
How does this central list get populated with new courses?

@jgramp
Copy link
Contributor

jgramp commented Apr 12, 2022

The colours shown in the graphic look good. High contrast :) and I like the icon as it aligns with what we use for courses on academy.

@andrewnicols
Copy link
Member Author

Hi @jgramp,

How does this central list get populated with new courses?

At the moment it's via a data structure here: https://github.com/andrewnicols/dinodevdocs/blob/main/academyCourses.js

We can either keep it in here, or we can fetch that data from Moodle Academy. I've writte a short summary for each course, based upon the longer structure, to use as a popover help text. You can see that in action at https://andrewnicols.github.io/dinodevdocs/docs/apis/access.

Screen Shot 2022-04-13 at 09 55 51

I've tried to add extra metadata too, though we're not using it yet. My thinking was that we'd have a dedicated page (i.e. /study or /academy or maybe /course which would use the same metadata to list the courses too.

@jgramp
Copy link
Contributor

jgramp commented Apr 18, 2022

Sounds good Andrew.
We could use the course summary description that is in the course settings probably for this short description.

dpalou pushed a commit to dpalou/devdocs that referenced this issue Sep 13, 2023
@crazyserver
Merge pull request moodle#12 from dpalou/MOBILE-4323
342b84f 
MOBILE-4323: Specify get_enrol_info is required for some plugin types
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Extra attention is needed migration Migration of a document from the legacy site question Further information is requested
Projects
Migration from Wikimedia
  
Done
Milestone
Migration day
Development

Successfully merging a pull request may close this issue.

Link to courses on the Moodle Academy moodle/devdocs
2 participants
@andrewnicols @jgramp