From 9e5091acd0fceb0897f1d3abac15f94ddf50bc06 Mon Sep 17 00:00:00 2001 From: "Steven R. Loomis" Date: Wed, 13 Dec 2023 18:54:58 +0000 Subject: [PATCH] chore(linux): docs: add note about Dev Containers - add note about how to use these docker images as Dev Containers --- docs/build/linux-ubuntu.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/build/linux-ubuntu.md b/docs/build/linux-ubuntu.md index 196b0d35af..dd56ba3124 100644 --- a/docs/build/linux-ubuntu.md +++ b/docs/build/linux-ubuntu.md @@ -267,3 +267,21 @@ cd linux docker pull ubuntu:23.04 # (to make sure you have an up-to-date image) docker build . -t keymanapp/keyman-linux-builder:u23.04-node20 --build-arg OS_VERSION=23.04 --build-arg NODE_MAJOR=20 ```` + +### Using the builder with VSCode [Dev Containers](https://code.visualstudio.com/docs/devcontainers/tutorial) + +1. Save the following as `.devcontainer/devcontainer.json`, updating the `image` to match the Docker image built above. + +```json +// file: .devcontainer/devcontainer.json +{ + "name": "Keyman Ubuntu 23.04", + "image": "keymanapp/keyman-linux-builder:u23.04-node18" +} +// For format details, see https://aka.ms/devcontainer.json. For config options, see the +// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu +``` + +2. in VSCode, use the "Dev Containers: Open Folder In Container…" option and choose the Keyman directory. + +3. You will be given a window which is running VSCode inside this builder image, regardless of your host OS.