OCaml Onboarding #1737
OCaml Onboarding #1737
Conversation
|
We should add the survey link in the onboarding. Maybe also in the status bar / command panel in a separate PR ? |
| } | ||
| } |
There was a problem hiding this comment.
This diff should not exist.
|
It may be better to write the alt text more properly, or to leave it blank at all. We can come up with some ideas about that for accessibility. |
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
Co-authored-by: Sora Morimoto <[email protected]>
|
Is there a way to automatically check the various steps at the end of command execution ? |
Indeed. I think the best way is to check if opam is installed and just move to the next step or exit the onboarding with a toast explaining opam is already installed |
Yes, this is now available. |
package.json
Outdated
| { | ||
| "id": "init-opam", | ||
| "title": "Initialize opam", | ||
| "description": "After installing opam, we initialise it so as to prepare your system to use it for managing OCaml packages and compilers.\n\n[Initialize opam](command:ocaml.init-opam)", |
There was a problem hiding this comment.
The current opam init requires user interaction. We might want to fix that. If it's auto we should describe exactly what it does to the user. Else we should prepare the user to make the correct choices.
There was a problem hiding this comment.
I added in the image, an explanation for each of the choices and also in the alt
package.json
Outdated
| { | ||
| "id": "activate-opam-switch-mac", | ||
| "title": "Activate the opam switch", | ||
| "description": "An opam switch is an isolated OCaml environment (like a Python virtual environment) where you can install different OCaml versions and packages. To activate a switch, run eval $(opam env) in your terminal.\n\n[Activate opam switch](command:ocaml.activate-opam-switch)", |
There was a problem hiding this comment.
We should activate the switch automatically at the end of the init. Her we should explain to the user that they can choose a different switch either via the vscode command or in a terminal.
There was a problem hiding this comment.
I changed it to ask the user to select a sandbox. For a first time user, this ill probably just be Global
|
Hi @PizieDust , this looks awesome! It could significantly improve the experience of people setting up OCaml. Would it be easy to drop a quick screencast of the walkthrough here? I'll review the code next week! |
| Extension_instance.sandbox instance |> Terminal_sandbox.create | ||
| in | ||
| let _ = Terminal_sandbox.show ~preserveFocus:true terminal in | ||
| Terminal_sandbox.send terminal "winget install Git.Git OCaml.opam" |
| Extension_instance.sandbox instance |> Terminal_sandbox.create | ||
| in | ||
| let _ = Terminal_sandbox.show ~preserveFocus:true terminal in | ||
| Terminal_sandbox.send terminal "utop" |
There was a problem hiding this comment.
| Terminal_sandbox.send terminal "utop" | |
| Terminal_sandbox.send terminal "opam exec -- utop" |
This PR introduces a new way to onboard users into the OCaml ecosystem.
It uses a short interactive tutorial to guide the user through the various steps of setting up OCaml.
cc @voodoos