Question: what is the workflow to put exercises online ?

[christinetasson]

Related user(s):

No response

Related issue(s) or PR(s):

No response

Related project scope(s):

No response

Question?

We have a deployed instance of learn-ocaml and a local instance to test exercises.
How can we put the exercises online ?

Thanks !

What has already been tested:

We have read the tutorial in https://github.com/ocaml-sf/learn-ocaml/tree/master/docs but could not find it.

learn-ocaml --version

No response

git describe --long --always --abbrev=40 --tags

No response

What OS do you use?

GNU/Linux

What browser(s) do you use with learn-ocaml?

No response

Additional context:

No response

[erikmd]

Dear @christinetasson,

We have a deployed instance of learn-ocaml and a local instance to test exercises.

OK. Do you use a Docker-based deployment or an locally-built deployment? Anyway, I recommend you have TLS enabled.

How can we put the exercises online ?

I assume your deployed instance reads the exercises from a /home/user/exercises-repository/folder
(this folder will contain the optional-but-recommended server_config.json, and the exercises subfolder)

Then you just need to:

1. replace the contents of your /home/user/exercises-repository/folder with your latest exercises.
2. relaunch the server, which will rebuild the exercises if need be, and serve them when they are ready.

• For 2., if you use a Docker-based deployment, it suffices to run sudo docker restart learnocaml-container-name
• For 2., if you use a locally-built binary, you just need to kill the learn-ocaml binary (e.g., with a SIGTERM), then restart it.

BTW if it is required, it is always feasible to do 1. and 2. during a labwork: the javascript front-end will detect this and display a dialog to propose students to refresh their browser tab to get the latest grader…

Let me know if you need more hints.

[erikmd]

How can we put the exercises online ?

(…)

Then you just need to:

1. replace the contents of your /home/user/exercises-repository/folder with your latest exercises.
2. relaunch the server, which will rebuild the exercises if need be, and serve them when they are ready.

Just to complement my previous comment, if your exercises-repository folder is a private github or gitlab repository, it is feasible to automate steps 1. and 2. by triggering them in a CI/CD pipeline!