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

Update Data Model to Allow Recording Resources from the Community #2041

Closed
yurug opened this issue Feb 9, 2024 · 13 comments · Fixed by #2184
Closed

Update Data Model to Allow Recording Resources from the Community #2041

yurug opened this issue Feb 9, 2024 · 13 comments · Fixed by #2184
Labels
documentation enhancement New feature or request

Comments

@yurug
Copy link
Contributor

yurug commented Feb 9, 2024

Thank you for the glorious work on ocaml.org!

The learning resources are great already but may I suggest adding as extra material the online exercises available there:

https://ocaml-sf.org/learn-ocaml-public/#activity=exercises

?

These exercises are probably interesting for beginners and intermediate OCaml developers.

@cuihtlauac cuihtlauac added enhancement New feature or request documentation labels Feb 9, 2024
@The-Amoghavarsha
Copy link
Contributor

@cuihtlauac got any idea where we can add this? (If that's the case)

@yurug
Copy link
Contributor Author

yurug commented Feb 11, 2024

A simple solution would be to add the link cited above in a box similar to the "Recommended book" one, advertising extra material for online practice.

Another - more ambitious - possibility would be to add exercise boxes pointing to appropriate exercises (all but "Advanced Functional Programming by François Pottier" can be considered beginner level I suppose and François' exercises can be very good for advanced learners). We can provide a list of URLs and short descriptions for each in the format of your choice.

@cuihtlauac
Copy link
Collaborator

cuihtlauac commented Feb 12, 2024

A simple solution would be to add the link cited above in a box similar to the "Recommended book" one, advertising extra material for online practice.

Yes, that's one option. However, book data is stored as Yaml+Markdown in the data/books folder and Learn OCaml probably doesn't fit in the template. Changing the syntax or filing with dummy values doesn't seem great.

It probably makes more sense to treat it as a one of kind thing, like the reference manual.

Another - more ambitious - possibility would be to add exercise boxes pointing to appropriate exercises (all but "Advanced Functional Programming by François Pottier" can be considered beginner level I suppose and François' exercises can be very good for advanced learners). We can provide a list of URLs and short descriptions for each in the format of your choice.

It would be great to be able to go both ways. Run the nitety-nine lisp derived exercises in Learn OCaml and list the exercises from Learn OCaml in https://ocaml.org/exercises, as the others, possibly with labels like we do for RWO and CS3110 tutorials.

@yurug
Copy link
Contributor Author

yurug commented Feb 12, 2024

It would be great to be able to go both ways. Run the nitety-nine lisp derived exercises in Learn OCaml and list the exercises from Learn OCaml in https://ocaml.org/exercises, as the others, possibly with labels like we do for RWO and CS3110 tutorials.

That's even more ambitious than what I proposed :-)

@yurug
Copy link
Contributor Author

yurug commented Feb 16, 2024

Yes, that's one option. However, book data is stored as Yaml+Markdown in the data/books folder and Learn OCaml probably doesn't fit in the template. Changing the syntax or filing with dummy values doesn't seem great.

It probably makes more sense to treat it as a one of kind thing, like the reference manual.

Should we start from here to get something simple working soon? Can you guide me in the process?

@cuihtlauac
Copy link
Collaborator

cuihtlauac commented Feb 19, 2024

Sure!

One possible way to go is to define another category of served data. This would allow defining a tile-base UI (like this one https://ocaml.org/jobs). We'd have one tile per learn resource. Learn-OCaml would be one. There's also this:

I suspect there's even more.

This implies creating a new kind of served data. Folowing-up with the jobs example, this file: data/jobs entails the jobs page.

That's the overall logic. @Clairevanden will think of the design.

Regarding the Yaml data we probably need fields for:

  • Title
  • Short description
  • Long description
  • Image
  • Online Url
  • Source Url
  • License

This whole thing would allow displaying the tiles either in the exercises, in the community or anywhere else.

What do you think of this plan?

@amarachigoodness74
Copy link
Contributor

@sabine Can I try working on this?
@SaySayo @cuihtlauac @tmattio

@SaySayo
Copy link
Contributor

SaySayo commented Mar 8, 2024

@Dev-JoyA will you like to attempt this?

@SaySayo
Copy link
Contributor

SaySayo commented Mar 8, 2024

@amarachigoodness74 I have responded to your comment on another issue.

@0xrotense
Copy link
Contributor

Hello @SaySayo , Im an outreachy applicant.

Please, can I work on this?

@SaySayo
Copy link
Contributor

SaySayo commented Mar 11, 2024

@0xrotense you can go ahead

@0xrotense
Copy link
Contributor

Alright thanks

@sabine sabine changed the title Reference to the Learn-OCaml platform Update Data Model to Allow Recording Resources from the Community Apr 9, 2024
@sabine
Copy link
Collaborator

sabine commented Apr 9, 2024

The original request, referencing to the Learn OCaml platform, has been resolved by #2140, however, the data hardcoded into the template could still be moved into a dedicated data model in ood-gen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

7 participants