Giter Club home page Giter Club logo

Comments (5)

andrewnicols avatar andrewnicols commented on May 29, 2024

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

from devdocs.

jgramp avatar jgramp commented on May 29, 2024

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

from devdocs.

jgramp avatar jgramp commented on May 29, 2024

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.

andrewnicols avatar andrewnicols commented on May 29, 2024

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.

from devdocs.

jgramp avatar jgramp commented on May 29, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.