Skip to content
This repository has been archived by the owner on Sep 15, 2021. It is now read-only.

Import academic data #24

Closed
patricoferris opened this issue Jun 1, 2021 · 5 comments
Closed

Import academic data #24

patricoferris opened this issue Jun 1, 2021 · 5 comments

Comments

@patricoferris
Copy link
Contributor

This issue is for adding data about OCaml's use for teaching in academic purposes primarily at universities.

A suggested type would be:

(* Academic_institution.ml (or some name like that...) *)

type location = { long: float; lat: float } (* In case we want to put it on a map ? *)

type t = {
  name: string;               (* name of the institution *) 
  description: string;        (* short description of the institution *)
  link: string;               (* Some link to the course or inst. *) 
  location : location option  (* optional location of inst. *)
}

The data we need to import can be found here https://github.com/ocaml/ocaml.org/blob/master/site/learn/teaching-ocaml.md

@tmattio
Copy link
Contributor

tmattio commented Jun 1, 2021

@patricoferris I'll take this one if that's ok with you

@patricoferris
Copy link
Contributor Author

Ah sorry @tmattio, I forgot to tag @shreyaswikriti (from Outreachy 😄 ) who will be working on this. Completely my bad, apologies.

@tmattio
Copy link
Contributor

tmattio commented Jun 1, 2021

No worries, there's plenty of others to choose from 😄

I started working on this and ended up with the following types:

type location = { long : float; lat : float }

type course = {
  name : string;
  accronym : string option;
  online_resource : string option;
}

type t = {
  name : string;
  description : string;
  url : string;
  location : location option;
  courses : course list;
}

Which gives the following structure:

institutions:
  - name: ""
    description: ""
    url: ""
    location: 
      long: 0.0
      lag: 0.0
    courses: 
      - name: ""
        accronym: ""
        online_resource: ""

Hope that's useful!

@tmattio
Copy link
Contributor

tmattio commented Jun 1, 2021

From the design of the page, we'll also need to store the logo of the institution, so more like:

type location = { long : float; lat : float }

type course = {
  name : string;
  accronym : string option;
  online_resource : string option;
}

type t = {
  name : string;
  description : string;
  url : string;
  logo: string option;
  location : location option;
  courses : course list;
}

@tmattio
Copy link
Contributor

tmattio commented Jun 10, 2021

Closed in #37

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants