dev-academy-programme / computer-setup

Instructions for setting up VS Code like the EDA computers

Dev Academy Computer Setup

• Windows 10 Setup
• MacOS Setup
• Ubuntu Setup
• Accessibility of code in VS Code or the terminal

computer-setup's Issues

Iterm2

Is Iterm2 part of our default setup? Or should it be?
It doesn't seem to be included in the macOS instructions but is always what we get students to use (along with oh-my-zsh)

zsh is now the default shell for Mac

The instructions ask for the user to install zsh, but since Catalina, ZSH has already been preinstalled and set as the default shell for macOS.

Interest in adopting `mkdocs-material`?

Summary

Would you be keen for a PR upgrading the docs? (they'd stay in markdown)

I know you're all quite busy and this may sound like the opposite of KISS, but it should actually make maintenance easier 😎

If not all good 👍

Details

Presently there is three main documents/guides (Win, macOS, Linux) that share common content, but they have been diverging with inconsistent updates that haven't been persisting to the other two, would you be open to a refactor?

I help maintain a project that provides extensive documentation. It's just markdown underneath, but has some extra benefits to the reader (and maintainers).

When actual content needs to be platform specific, that can be grouped under content tabs, or better stand out via admonitions. Navigation would be easier too :)

I can setup Github Actions to automate building the docs. It would look similar to this one (without the versioning support).

Github Pages (or an alternative if you prefer such as Netlify / Vercel) will be deployed to for viewing. If you do use services such as Netlify or Vercel, I also implemented the PR previews if you like (seems a bit excessive for this repo though).

Add formatOnSave for typescript and typescriptReact to computer-setup

[Ubuntu] Unclear which file is missing when "Failed to read your VS Code settings file" encountered

After getting to the end of setup, I noticed "Failed to read your VS Code settings file" popped up.

As far as I can tell, I have executed everything right, however I'm not entirely ruling out having just screwed something up 😛

I think it would be handy if there was some kind of check akin to the type nvm earlier that the user performs right after creating and modifying the settings.json file via VSCode to make sure everything looks right.

Also any help greatly appreciated as I'm still not too sure what I did wrong. I will probably just pull up the code for the checklist package if I can't figure it out in the next few minutes 🔍

Cheers! :)

Instructions for ARM Macs

Still trying this out, looks good but I'll report on any issues

Problem: Macs with the new apple sillicon processors often have bugs when running node. Newer versions of node sometimes fix these, but the curriculum uses v14, the LTS version of node. Problems between students running v14 and v15 include differences in the package lock file creating huge diffs between commits.

arch will print the current architecture - if the result is arm64 these instructions will need to be used

arch x86_64 zsh will launch a shell that runs with the rosetta translation layer, allowing x64 binaries to automatically be translated at launch to arm64.

then run nvm install --lts in that same shell. Because it's running in a Rosetta shell, it will install the x64 binary of the LTS version of node. After that close that shell, and run your programs as normal.

Because the version of node and nvm installed now are running in a rosetta context, dependancies installed will also be those x64 versions.

If any updates are to be installed with nvm, using the shell started with arch x86_64 zsh will be necessary to get the x64 versions