From 2cfd685def883322cf96fd56cd5f787621a65992 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Mon, 1 Jan 2024 13:30:45 -0600 Subject: [PATCH] docs: fix formatting of sections and admonitions (#2570) --- docs/misc/contributing/development.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/misc/contributing/development.md b/docs/misc/contributing/development.md index b89135a1..8678a4f1 100644 --- a/docs/misc/contributing/development.md +++ b/docs/misc/contributing/development.md @@ -46,24 +46,26 @@ popd Using the baseline image, an interactive container can be started to iteratively run the scripts to be developed. By attaching the current workspace directory, you can use the local editor of your choice to iteratively modify scripts while using the container to run them. -```shell script +```shell docker run -it --rm -v ${PWD}:/scripts -e SCRIPTS=/scripts/ --entrypoint bash mc-dev ``` From within the container you can run individual scripts via the attached `/scripts/` path; however, be sure to set any environment variables expected by the scripts by either `export`ing them manually: -```shell script +```shell export VERSION=1.12.2 /scripts/start-magma ``` ...or pre-pending script execution: -```shell script +```shell VERSION=1.12.2 /scripts/start-magma ``` -> NOTE: You may want to temporarily add an `exit` statement near the end of your script to isolate execution to just the script you're developing. +!!! note + + You may want to temporarily add an `exit` statement near the end of your script to isolate execution to just the script you're developing. ## Using development copy of tools