Comments (5)
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:
from devdocs.
Looks great Andrew.
How does this central list get populated with new courses?
from devdocs.
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.
from devdocs.
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.
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.
from devdocs.
Sounds good Andrew.
We could use the course summary description that is in the course settings probably for this short description.
from devdocs.
Related Issues (20)
- [chore] Automate copy between branches
- [docs] Create documentation for [Moodle 4.2 release]
- [docs] Lack of information about $_GET, $_POST, $_REQUEST, $_COOKIE, and $_SESSION variables
- https://moodledev.io/general/development/tracker/labels should have an anchor for each lable
- https://docs.moodle.org/dev/Experience_API_(xAPI)
- Save useful info about question walkthrough tests from the comment in MDL-77327
- [docs] Update moodle version on QA testing page
- [docs] Update testing maintainer responsabilities
- [repo] Problem with documentation system HOT 1
- [docs] Important info missing from Javascript
- [docs] Error in repeat-elements
- [docs] Would be good to add an 'A better contribution' page explainging why it is best not to use setUp in PHPunit
- [docs] Migrate /dev/Cache_API to /docs/apis/subsystems/muc/index.md
- [docs] Migrate CSS_Coding_Style HOT 4
- [repo] Moodle Sessions Bug Preventing First Admin Creation on Fresh Install HOT 1
- [docs] Create documentation for [Moodle 4.3 release] HOT 1
- Problems with the TinyMCE plugin docs HOT 2
- Notes: Notes.md HOT 1
- [docs] Error in [Writing a new service]
- Asignación de parches en el dispositivo HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from devdocs.